add license and readme
[obnox/vagrant/vagrant-samba-fs.git] / README.md
1 # Samba/CTDB-Cluster without a clustered FS
2
3 This repository contains a Vagrantfile that describes the
4 setup of a simple Samba file server in a fedora-LXC host.
5
6 This is useful for testing/development of Samba.
7
8 In short:
9
10 * setup controlled by vagrant
11 * LXC-Containers as basis
12 * node OS: Fedora 23
13
14 ## Configuration
15
16 This Vagrantfile is parametrized: The options for configuring
17 the number of nodes and the nodes' network interfaces and addresses
18 are stored in the config file 'vagrant.yml' when running any
19 vagrant command (except for vagrant help). The whole setup can
20 then conveniently be reconfigured modifying that file.
21
22 ## Prerequisites
23
24 * Linux host, attached to the network (tested on Fedora 23, should work on other hosts as well)
25 * lxc installed
26 * vagrant installed
27 * vagrant-lxc plugin installed
28 * possibly preparation of bridge interfaces on the host (the example uses libvirt's `virbr` interfaces)
29
30 ## Running
31
32 After adjusting the configuration, `vagrant up` will bring up the full
33 cluster with ctdb running on all nodes. `vagrant ssh` will ssh
34 into the samba server.
35
36 ## TODO
37
38 - do provisioning with [ansible](https://github.com/ansible/ansible)
39 - add mechanism to join existing AD domain (e.g. samba-AD)
40
41 ## Author
42
43 Michael Adam (obnox at samba dot org)