Single Machine Development Environment
Developing cluster software is complicated if you must actually run a whole cluster on a set of physical machines. This begs for a development environment that is self contained and can be run without any setup. This page documents a way to set up an entire Ciao cluster inside a single machine. This cluster-in-an-machine mode is ideal for developers that desire the ability to build Ciao from sources, make changes and perform quick end to end functional integration testing without requiring multiple machines/VM's or creating a custom networking environment or maintaining a bevy of physical machines and a physical network.
In this case Ciao is configured in a special all in one development mode where cluster nodes have dual roles (i.e launcher can be a Network Node and a Compute Node at the same time)
1. Controller
2. Scheduler
3. Compute+Network Node Agent (i.e. CN + NN Launcher)
4. Workloads (Containers and VMs)
5. WebUI
6. Mock Openstack Services
7. Machine Local DHCP Server
...
The one machine acts as the ciao compute node, network node, ciao-controller, ciao-scheduler and also hosts the ciao-webui as well as other openstack and dhcp services.
When the system is functioning the overall setup manifests as follows:
As you can see below the Cluster runs on a isolated virtual network resident on the host. Hence the cluster is invisible outside the host and completely self contained.
_____________________________________________________________________________________
| |
| |
| |
| [Tenant VMs] [CNCI VMs] |
| | | | || |
| Tenant Bridges ---------- || |
| | || |
| | || |
| [scheduler] [controller] [keystone] [CN+NN Launcher] | || |
| || || || || | || |
| || || || || | || |
| || || || || | || |
| || || || || | || |
| || || || || | || |
| || || || || [DHCP/DNS | || |
| || || || || Server] | || |
| || || || || || | || |
| -------------------------------------------------------------------------- |
| Host Local Network Bridge + macvlan (ciao_eth, ciaovlan) |
| |
| |
| ____________________________________________________________________________________|
Development Machine
The following instructions can be performed on a bare metal system or in a VM.
If you use a VM please ensure that the VM has host CPU pass through enabled.
<cpu mode='host-passthrough'/>
This ensures that VT-x and other properties required by Ciao are available to Ciao
if you desire to provide external network connectivity to the workloads then the host needs to act as gateway to the internet. The host needs to enable ipv4 forwarding and ensure all traffic exiting the cluster via the host is NATed.
This assumes the host has a single network interface. For multi homed systems, the setup is more complicated and needs appropriate routing setup which is outside the scope of this document. If you have a custom firewall configuration, you will need set things up appropriately.
Very simplistically this can be done by
iptables -t nat -A POSTROUTING -o $device -j MASQUERADE #$device is the network interface on the host
echo 1 > /proc/sys/net/ipv4/ip_forward
Install the latest release of go for your distribution Installing Go.
NOTE: Go version 1.7 or later is required for Ciao. Ciao will not work with older version of Go. Hence it is best you download and install the latest version of Go if you distro is not on Go 1.7.
Install latest docker for your distribution based on the instructions from Docker Installing Docker.
Install the following packages which are required:
1. qemu-system-x86_64 and qemu-img, to launch the VMs and create qcow images
2. gcc, required to build some of the ciao dependencies
3. dnsmasq, required to setup a test DHCP server
On clearlinux all of these dependencies can be satisfied by installing the following bundles:
swupd bundle-add cloud-control go-basic os-core-dev kvm-host os-installer
Setup passwordless sudo for the user who will be running the script below.
Download and build the ciao sources:
cd $GOPATH/src
go get -v -u -tags debug github.com/01org/ciao/...
You should see no errors.
You can now quickly verify that all aspects of Ciao including VM launch, container launch, and networking. TO do this simply run the following:
cd $GOPATH/src/github.com/01org/ciao/testutil/singlevm
#Cleanup any previous setup
./cleanup.sh
#Set up the test enviornment
./setup.sh
#Perform a full cluster test
./verify.sh
The verify.sh script will:
- Create multiple Instances of Tenant VMs and Containers
- Test network connectivity between containers
- Test for ssh reach ability into VMs
- Delete all the VM's and Container that were created
If the script reports success, it indicates to the developer that any changes made have not broken any functionality across all the Ciao components.
Meeting the goal originally outlined at the top of the page, build/setup/running your cluster all-in-one all transpires quickly and easily from the single script. The time needed for ./setup.sh and ./verify.sh to build ciao from source, configure it components into a virtual cluster, then launch and teardown containers and VMs is on the order of one minute total elapsed time.
At the end, the setup.sh script leaves behind a virtual cluster which the user can then continue to use. Ie: the virtual cluster can also be used to perform additional manual tests in addition to those automated in the script.
The ciao project includes a set of acceptance tests that must pass before each release is made. The tests perform various tasks such as listing workloads, creating and deleting instances, etc. These tests can be run inside the Single Machine VM.
cd $GOPATH/src/github.com/01org/ciao/_relase/bat
#Only needed the first time you run the tests
pip install -r requirements.txt
#Run the tests. They can take a couple of minutes to run
python release_test.py
#Check the generated report.tap file to verify everything passed
cat report.tap
For more information on the BAT tests please see the README.
To cleanup and tear down the cluster:
cd $GOPATH/src/github.com/01org/ciao/testutil/singlevm
#Cleanup any previous setup
./cleanup.sh
- Does not work on Fedora due to default firewall rules. Please see the issue for details on workaround https://github.com/01org/ciao/issues/526