commit	181f65676166b03de617c4bd41478fc9b803d83a	[log] [tgz]
author	Zack Williams <zdw@artisancomputer.com>	Wed May 25 17:10:11 2016 -0700
committer	Zack Williams <zdw@artisancomputer.com>	Wed May 25 17:10:11 2016 -0700
tree	281bfb45d88ac08cd0dafdfc4fd8f1cf491d4984
parent	455cec4802c419bbb37a90feac8846658f14efbc [diff]

tree: 281bfb45d88ac08cd0dafdfc4fd8f1cf491d4984

README.md

openstack-cluster-setup

This repository contains Ansible playbooks for installing and configuring an OpenStack Kilo cluster for use with XOS. This is how we build clusters for OpenCloud, and is the method of installing a CORD development POD as well.

All of the OpenStack controller services are installed in VMs on a single "head node" and connected by an isolated private network. Juju is used to install and configure the OpenStack services.

Prerequisites (OpenCloud and CORD)

Set up control machine: The install playbooks in this repository can either run on a separate control machine (e.g., a laptop) or on the cluster head node. Either way:
- Install a recent version of Ansible (Ansible 1.9.x on Mac OS X or Ubuntu should work).
- Be able to login to all of the cluster servers from the control machine using SSH.
Set up servers: One server in the cluster will be the "head" node, running the OpenStack services. The rest will be "compute" nodes.
Install Ubuntu 14.04 LTS on all servers.
The user account used to login from the control machine must have sudo access.
Each server should have a single active NIC (preferably eth0) with connectivity to the Internet.

How to install a CORD POD

The CORD POD install procedure uses the "head node" of the cluster as the control machine for the install. As mentioned above, install Ansible on the head node and check out this repository.

The playbooks assume that a bridge called mgmtbr on the head node is connected to the management network. Note that also there must be a DHCP server on the management network that:

hands out IP addresses to VMs connected to mgmtbr
resolves VM names to IP addresses
is configured as a resolver on the head and compute nodes

If you need to set up dnsmasq to do this, take a look at this example configuration. Then follow these steps:

Run the bootstrap.sh script to install Ansible and set up keys for login via localhost
Edit cord-hosts with the DNS names of your compute nodes, and update the ansible_ssh_user variable appropriately. Before proceeding, these commands needs to work on the head node:

$ ansible -i cord-hosts head -m ping
$ ansible -i cord-hosts compute -m ping

Run the following command:

ansible-playbook -i cord-hosts cord-setup.yml

Be patient! Some tasks in the above playbook can take a while to complete. For example, the "Add virtual machines to Juju's control" task will take about 10 minutes (or more, if you have a slow Internet connection).
After the playbook finishes, wait for the OpenStack services to come up. You can check on their progress using juju status --format=tabular. It should take about 30 minutes to install and configure all the OpenStack services.
Once the services are up, you can use the admin-openrc.sh credentials in the home directory to interact with OpenStack. You can SSH to any VM using ssh ubuntu@<vm-name>

This will bring up various OpenStack services, including Neutron with the VTN plugin. It will also create two VMs called xos and onos-cord and prep them. Configuring and running XOS and ONOS in these VMs is beyond the scope of this README.

NOTE: The install process only brings up a single nova-compute node. To bring up more nodes as compute nodes, perform these steps on the head node:

$ juju add-machine ssh:<user>@<compute-host>
$ juju add-unit nova-compute --to <juju-machine-id>

Refer to the Juju documentation for more information.

Caveats

The goal is to configure HA for the OpenStack services, but this is not yet implemented.

How to install a single-node CORD test environment on CloudLab

Setting up a single-node CORD environment is simple.

Start a CloudLab experiment using profile OnePC-Ubuntu14.04.4 and login to the node
wget https://raw.githubusercontent.com/open-cloud/openstack-cluster-setup/master/scripts/single-node-pod.sh
bash single-node-pod.sh [-t] [-e]
- With no options, the script installs the OpenStack services and a simulated fabric. It creates VMs for XOS and ONOS but does not start these services.
- Adding the -t option will start XOS, bring up a vSG, install a test client, and run a simple E2E test.
- Adding the -e option will add the ExampleService to XOS (and test it if -t is also specified).

As mentioned above, be patient! With a fast Internet connection, the entire process will take at least one hour to complete.

The install will bring up various OpenStack services, including Neutron with the VTN plugin. It will also create two VMs called xos and onos-cord and prep them. It creates a single nova-compute node running inside a VM.

It should be possible to use this method on any server running Ubuntu 14.04, as long as it has sufficient CPU cores and disk space. A server with at least 12 cores and 48GB RAM is recommended.

How to install an OpenCloud cluster

Once the prerequisites are satisfied, here are the basic steps for installing a new OpenCloud cluster named 'foo':

Create foo-setup.yml and foo-compute.yml files using cloudlab-setup.yml and cloudlab-compute.yml as templates. Create a foo-hosts file with the DNS names of your nodes based on cloudlab-hosts.
If you are not installing on CloudLab, edit foo-hosts and add cloudlab=False under [all:vars].
If you are installing a cluster for inclusion in the public OpenCloud, change mgmt_net_prefix in foo-setup.yml to be unique across all OpenCloud clusters.
To set up Juju, use it to install the OpenStack services on the head node, and prep the compute nodes, run on the head node:

$ ansible-playbook -i foo-hosts foo-setup.yaml

Log into the head node. For each compute node, put it under control of Juju, e.g.:

$ juju add-machine ssh:ubuntu@compute-node

To install the nova-compute service on the compute nodes that were added to Juju, run on the control machine:

$ ansible-playbook -i foo-hosts foo-compute.yaml

Caveats

The installation configures port forwarding so that the OpenStack services can be accessed from outside the private network. Some OpenCloud-specific firewalling is also introduced, which will likely require modification for other setups. See: files/etc/libvirt/hooks/qemu.
By default the compute nodes are controlled and updated automatically using ansible-pull from this repo. You may want to change this.
All of the service interfaces are configured to use SSL because that's what OpenCloud uses in production. To turn this off, look for the relevant Juju commands in cloudlab-setup.yaml.