Testing documentation

Add documentation for testing swift, ceph, heat.

Create a script and instructions on a script that launches a controller
and a specified number of compute nodes.

Signed-off-by: Amy Fong <amy.fong@windriver.com>

5 files changed, 594 insertions, 0 deletions

diff --git a/meta-openstack/Documentation/testsystem/README b/meta-openstack/Documentation/testsystem/README
new file mode 100644
index 0000000..ddbc51d
--- /dev/null
+++ b/meta-openstack/Documentation/testsystem/README
@@ -0,0 +1,116 @@
+OpenStack: Minimally Viable Test System
+
+Usage:
+        <script> [config file] [start|stop|restart]
+
+This test harness creates a virtual network and the specified virtual
+domains enabling the user to create a test system for openstack.
+
+Arguments:
+        config file: this configuration file specifies the test system
+                to create, see below for details
+        start|stop|restart:
+                start - starts specifies test system
+                stop - stops specifies test system
+                restart - reboots specifies test system
+
+Note: On some systems, there may be issues with restart, to workaround, use start with
+      auto_destroy enabled.
+
+Virtual Network
+---------------
+
+This test harness creates a virtual network (ops_default) using the
+network specified in the configuration file.
+e.g.
+[main]
+network: 192.168.122.1
+
+The script tries to create the virtual network using virbr0, but if this is
+in use, then it will retry at virbr1, virbr2, .... etc until it finds one or
+it gives up after a number of attempts.
+
+
+Virtual Domains
+---------------
+
+The script then creates a controller using the specified kernel and disk image
+e.g.
+[controller]
+kernel: /root/images/bzImage
+disk: /root/images/controller.ext3
+
+The script then creates compute nodes by using a section header starting with
+the string "compute" along with kernel(s)/disk image(s).
+
+e.g.
+[compute0]
+kernel: /root/images/bzImage
+disk: /root/images/compute1.ext3
+
+[compute1]
+kernel: /root/images/bzImage
+disk: /root/images/compute2.ext3
+
+
+IP address assignments
+----------------------
+There is an auto_assign_ip variable under the section main.
+ie
+[main]
+auto_assign_ip: False
+
+This value, if True, causes the kernel to be pass ip=dhcp in the kernel's
+boot parameters.
+
+If the value is False, the each controller and compute section will be
+required to have a value defined for ip.
+
+ie.
+[compute0]
+kernel: /root/images/bzImage
+disk: /root/images/compute1.ext3
+ip: 192.168.122.10
+
+
+Other
+-----
+
+The configuration file also specifies the emulator to be used
+for the domains:
+e.g.
+[main]
+emulator: /usr/bin/qemu-system-x86_64
+
+The configuration file also specifies an auto_destroy option
+e.g.
+[main]
+auto_destroy: True
+
+If auto_destroy is enabled (True), if the required controller/compute nodes
+are running, then the script will automatically destroy the running domains.
+Otherwise, if disabled (False), then the script will display a message that the
+domain is active and exit. (auto_destroy is only used when starting systems)
+
+
+Example configuration file
+--------------------------
+[main]
+network: 192.168.122.1
+emulator: /usr/bin/qemu-system-x86_64
+auto_destroy: True
+auto_assign_ip: True
+
+[controller]
+kernel: /root/images/bzImage
+disk: /root/images/controller.ext3
+
+[compute0]
+kernel: /root/images/bzImage
+disk: /root/images/compute1.ext3
+
+[compute1]
+kernel: /root/images/bzImage
+disk: /root/images/compute2.ext3
+-------------------------------------------------
+
diff --git a/meta-openstack/Documentation/testsystem/README.multi-compute b/meta-openstack/Documentation/testsystem/README.multi-compute
new file mode 100644
index 0000000..f7e6b4e
--- /dev/null
+++ b/meta-openstack/Documentation/testsystem/README.multi-compute
@@ -0,0 +1,150 @@
+0. configure configuration files with auto_destroy enabled and auto_assign_ip disabled and specify the
+   IP addresses of the controller and the compute node as configured during the build
+
+e.g. if the DHCP is supported
+
+[main]
+network: 192.168.7.1
+emulator: /usr/bin/qemu-system-x86_64
+auto_destroy: True
+auto_assign_ip: True
+
+[controller]
+kernel: $HOME/images/bzImage
+disk: $HOME/images/controller.ext3
+
+[computeA]
+kernel: $HOME/images/bzImage
+disk: $HOME/images/compute.ext3
+
+[computeB]
+kernel: $HOME/images/bzImage
+disk: $HOME/images/computeB.ext3
+
+Start instances:
+<launch.py> <config file> start
+
+e.g. if the IP address are specified in build time IP
+
+For the controller:
+
+The build time IP in layers/meta-cloud-services -
+layers//meta-cloud-services/meta-openstack-controller-deploy/classes/hosts.bbclass
+layers//meta-cloud-services/meta-openstack-compute-deploy/classes/hosts.bbclass
+CONTROLLER_IP ?= "128.224.149.121"
+
+Use the controller's ip in the test system's configuration file:
+
+[controller]
+ip: 128.224.149.121
+
+For each compute, use the controller's IP in the bitbake build's build time IP and
+use the compute node's ip accordingly
+
+computeA
+The build time IP in layers/meta-cloud-services -
+layers//meta-cloud-services/meta-openstack-controller-deploy/classes/hosts.bbclass
+layers//meta-cloud-services/meta-openstack-compute-deploy/classes/hosts.bbclass
+CONTROLLER_IP ?= "128.224.149.121"
+COMPUTE_IP ?= "128.224.149.122"
+
+computeB
+The build time IP in layers/meta-cloud-services -
+layers//meta-cloud-services/meta-openstack-controller-deploy/classes/hosts.bbclass
+layers//meta-cloud-services/meta-openstack-compute-deploy/classes/hosts.bbclass
+CONTROLLER_IP ?= "128.224.149.121"
+COMPUTE_IP ?= "128.224.149.123"
+
+And in the test system's configuration file:
+
+[controller]
+ip: 128.224.149.121
+
+[computeA]
+ip: 128.224.149.122
+
+[computeB]
+ip: 128.224.149.123
+
+Start instances:
+<launch.py> <config file> start
+
+
+1./etc/hosts - adjust for hostnames
+
+On controller/compute nodes, configure your DNS or /etc/hosts and ensure
+it is consistent across all hosts. Make sure that the three hosts can
+perform name resolution with each other. As a test, use the ping command
+to ping each host from one another.
+
+$ ping HostA
+$ ping HostB
+$ ping HostC
+
+e.g.  /etc/hosts
+127.0.0.1       localhost.localdomain           localhost
+
+192.168.7.2 controller
+192.168.7.4 computeA
+192.168.7.6 computeB
+
+2. Configure NFS host on controller
+
+/etc/nova/instances needs to be a shared directory for migration to work.
+
+Configure the controller to export this as an NFS export.
+
+cat >> /etc/exports << 'EOF'
+/etc/nova/instances *(rw,no_subtree_check,insecure,no_root_squash)
+EOF
+exportfs -a
+
+On compute nodes:
+mount controller:/etc/nova/instances /etc/nova/instances/
+
+
+3. Make sure the controller can see the compute nodes
+
+nova service-list
+
+root@controller:/etc/nova/instances# nova service-list
++------------------+------------+----------+---------+-------+----------------------------+-----------------+
+| Binary           | Host       | Zone     | Status  | State | Updated_at                 | Disabled Reason |
++------------------+------------+----------+---------+-------+----------------------------+-----------------+
+| nova-compute     | computeA   | nova     | enabled | up    | 2014-05-16T17:14:24.617143 | -               |
+| nova-compute     | computeB   | nova     | enabled | up    | 2014-05-16T17:14:25.228089 | -               |
+| nova-conductor   | controller | internal | enabled | up    | 2014-05-16T17:14:26.932751 | -               |
+| nova-scheduler   | controller | internal | enabled | up    | 2014-05-16T17:14:26.984656 | -               |
+| nova-consoleauth | controller | internal | enabled | up    | 2014-05-16T17:14:27.007947 | -               |
+| nova-cert        | controller | internal | enabled | up    | 2014-05-16T17:14:27.030701 | -               |
+| nova-network     | controller | internal | enabled | up    | 2014-05-16T17:14:27.031366 | -               |
++------------------+------------+----------+---------+-------+----------------------------+-----------------+
+
+root@controller:~# nova hypervisor-list
++----+---------------------+
+| ID | Hypervisor hostname |
++----+---------------------+
+| 1  | computeA            |
+| 2  | computeB            |
++----+---------------------+
+
+Login to horizon, and select hypervisors, both nodes will be seen
+
+
+4. Bootup a guest from the controller:
+
+On controller:
+glance image-create --name myFirstImage --is-public true --container-format bare --disk-format qcow2 --file images/cirros-0.3.0-x86_64-disk.img
+neutron  net-create mynetwork
+nova boot --image myFirstImage --flavor 1 myinstance
+
+5. Do migration from horizon
+
+From horizon, goto instances, myinstance should be running
+wait til myinstance is in running state
+
+In Actions, select: Migrate Instance
+Select: Confirm migrate/resize when promted
+
+myinstance is now running from the other compute node (computeB in this case)
+
diff --git a/meta-openstack/Documentation/testsystem/README.tests b/meta-openstack/Documentation/testsystem/README.tests
new file mode 100644
index 0000000..924f883
--- /dev/null
+++ b/meta-openstack/Documentation/testsystem/README.tests
@@ -0,0 +1,9 @@
+This test system enables the user to run different tests on the system.
+
+Multiple compute node testing can be performed as per: README.multi-compute
+
+Other tests described in Documentation.ND:
+ie.
+Ceph testing: Documentation.ND/README.ceph-openstack
+Swift/cinder: Documentation.ND/README.swift
+
diff --git a/meta-openstack/Documentation/testsystem/launch.py b/meta-openstack/Documentation/testsystem/launch.py
new file mode 100755
index 0000000..e177773
--- /dev/null
+++ b/meta-openstack/Documentation/testsystem/launch.py
@@ -0,0 +1,304 @@
+#!/usr/bin/env python
+
+import sys
+import grp
+import pwd
+import os
+import libvirt
+import ConfigParser
+import subprocess
+import shutil
+import distutils.spawn
+import platform
+
+# this does a very basic test to see if the required packages
+# are installed, extend list as required
+def checkPackages():
+        sys_ok = True
+        check_apps = [ "virsh", "qemu-system-x86_64", "libvirtd" ]
+        for app in check_apps:
+                if distutils.spawn.find_executable(app) == None:
+                        print( "Missing: " + app)
+                        sys_ok = False
+        if not sys_ok:
+                print("The required libvirt/qemu packages are missing...")
+                distro = platform.dist()[0]
+                if distro == "debian" or distro == "Ubuntu":
+                        print( "This appears to be a Debian/Ubuntu distribution\nPlease install " +
+                                "packages like libvirt-bin, qemu-system-x86,..." )
+                elif distro == "redhat" or distro == "fedora":
+                        print( "This appears to be a Redhat/Fedora distribution\nPlease install " +
+                                "packages like libvirt-client, libvirt-daemon, qemu-system-x86, ..." )
+                exit(1)
+        return
+
+def networkInterfaces():
+        ifaces = []
+        for line in open('/proc/net/dev', 'r'):
+                if_info = line.split(":", 1)
+                if len(if_info) > 1:
+                        ifaces.append( if_info[0].strip() )
+        return ifaces
+
+def destroyNetwork(conn, network_name):
+        networks = conn.listNetworks() + conn.listDefinedNetworks()
+        if network_name in networks:
+                try:
+                        nw = conn.networkLookupByName(network_name)
+                        if nw.isActive():
+                                nw.destroy()
+                        nw.undefine()
+                except:
+                        print( "Failed to destroy network: %s" % network_name )
+                        exit( 1 )
+
+def restartDomain(conn, domain_name):
+        try:
+                domain = conn.lookupByName(domain_name)
+        except:
+                print( "restartDomain: Warning domain " + domain_name + " doesn't exist." )
+                return
+        if domain.isActive():
+                domain.reboot()
+
+def destroyDomain(conn, auto_destroy, domain_name):
+        try:
+                domain = conn.lookupByName(domain_name)
+        except:
+                return
+        if domain.isActive():
+                if auto_destroy:
+                        print( "Auto destroy enabled, destroying old instance of domain %s" % domain_name )
+                        domain.destroy()
+                else:
+                        print( "Domain %s is active, abort..." % domain_name )
+                        print( "To stop:  virsh -c %s destroy %s " % ( uri , domain_name ) )
+                        exit(0)
+        domain.undefine()
+
+def startDomain(conn, auto_destroy, domain_name, xml_desc):
+        print( "Starting %s...\n%s" % ( domain_name, xml_desc ) )
+        destroyDomain(conn, auto_destroy, domain_name)
+        try:
+                conn.defineXML(xml_desc)
+                domain = conn.lookupByName(domain_name)
+                domain.create()
+                print( "Starting domain %s..." % domain_name )
+                print( "To connect to the console:  virsh -c %s console %s" % ( uri, domain_name ) )
+                print( "To stop:  virsh -c %s destroy %s" % ( uri, domain_name ) )
+        except Exception as e:
+                print( e )
+                exit(1)
+
+def make_nw_spec(network_name, bridge_nw_interface, network, auto_assign_ip):
+        spec = '<network>'
+        spec += '<name>' + network_name + '</name>'
+        spec += '<bridge name="' + bridge_nw_interface + '"/>'
+        spec += '<forward/>'
+        spec += '<ip address="' + network + '" netmask="255.255.255.0">'
+        if auto_assign_ip:
+                nw_parts = network.split('.')
+                nw_parts[-1] = "2"
+                start_dhcp = '.'.join(nw_parts)
+                nw_parts[-1] = "254"
+                end_dhcp = '.'.join(nw_parts)
+                spec += '<dhcp>'
+                spec += '<range start="' + start_dhcp + '" end="' + end_dhcp + '"/>'
+                spec += '</dhcp>'
+        spec += '</ip>'
+        spec += '</network>'
+        return spec
+
+def make_spec(name, network, kernel, disk, bridge_nw_interface, emulator, auto_assign_ip, ip):
+        if not os.path.exists(kernel):
+                print( "Kernel image %s does not exist!" % kernel )
+                exit(1)
+        if not os.path.exists(disk):
+                print( "Disk %s does not exist!" % disk )
+                exit(1)
+        if auto_assign_ip:
+                ip_spec = 'dhcp'
+        else:
+                ip_spec = ip + '::' + network + ':255.255.255.0:' + name + ':eth0:off'
+        spec = '<domain type=\'kvm\'>'
+        spec += '   <name>' + name + '</name>'
+        spec += '   <memory>4096000</memory>'
+        spec += '   <currentMemory>4096000</currentMemory>'
+        spec += '   <vcpu cpuset=\'1\'>1</vcpu>'
+        spec += '   <cpu>'
+        spec += '     <model>kvm64</model>'
+        spec += '   </cpu>'
+        spec += '   <os>'
+        spec += '     <type arch=\'x86_64\' machine=\'pc\'>hvm</type>'
+        spec += '     <kernel>' + kernel + '</kernel>'
+        spec += '     <boot dev=\'hd\'/>'
+        spec += '     <cmdline>root=/dev/vda rw console=ttyS0 ip=' + ip_spec + '</cmdline>'
+        spec += '   </os>'
+        spec += '   <features>'
+        spec += '     <acpi/>'
+        spec += '     <apic/>'
+        spec += '     <pae/>'
+        spec += '   </features>'
+        spec += '   <clock offset=\'utc\'/>'
+        spec += '   <on_poweroff>destroy</on_poweroff>'
+        # spec += '   <on_reboot>destroy</on_reboot>'
+        spec += '   <on_crash>destroy</on_crash>'
+        spec += '   <devices>'
+        spec += '     <emulator>' + emulator + '</emulator>'
+        spec += '     <disk type=\'file\' device=\'disk\'>'
+        spec += '       <source file=\'' + disk + '\'/>'
+        spec += '       <target dev=\'vda\' bus=\'virtio\'/>'
+        spec += '     </disk>'
+        spec += '     <interface type=\'bridge\'>'
+        spec += '       <source bridge=\'' + bridge_nw_interface + '\'/>'
+        spec += '       <model type=\'virtio\' />'
+        spec += '     </interface>'
+        spec += '     <serial type=\'pty\'>'
+        spec += '      <target port=\'0\'/>'
+        spec += '      <alias name=\'serial0\'/>'
+        spec += '     </serial>'
+        spec += '    <console type=\'pty\'>'
+        spec += '      <target type=\'serial\' port=\'0\'/>'
+        spec += '      <alias name=\'serial0\'/>'
+        spec += '    </console>'
+        spec += '   </devices>'
+        spec += '</domain>'
+        return spec
+
+def getConfig(config, section, key):
+        try:
+                return os.path.expandvars(config.get(section, key))
+        except:
+                print( "Configuration file error! Missing item (section: %s, key: %s)" % ( section, key ) )
+                exit(1)
+
+# does the user have access to libvirt?
+eligible_groups = [ "libvirt", "libvirtd" ]
+eligible_user = False
+euid = os.geteuid()
+if euid == 0:
+        eligible_user = True
+else:
+        username = pwd.getpwuid(euid)[0]
+        groups = [g.gr_name for g in grp.getgrall() if username in g.gr_mem]
+        for v in eligible_groups:
+                if v in groups:
+                        eligible_user = True
+
+checkPackages()
+
+if not eligible_user:
+        sys.stderr.write("You need to be the 'root' user or in group [" + '|'.join(eligible_groups) + "] to run this script.\n")
+        exit(1)
+
+if len(sys.argv) != 3:
+        sys.stderr.write("Usage: "+sys.argv[0]+" [config file] [start|stop|restart]\n")
+        sys.exit(1)
+
+if not os.path.exists(sys.argv[1]):
+        sys.stderr.write("Error: config file \"" + sys.argv[1] + "\" was not found!\n")
+        sys.exit(1)
+
+command = sys.argv[2]
+command_options = ["start", "stop", "restart"]
+if not command in command_options:
+        sys.stderr.write("Usage: "+sys.argv[0]+" [config file] [start|stop|restart]\n")
+        sys.exit(1)
+
+Config = ConfigParser.ConfigParser()
+Config.read(sys.argv[1])
+
+network_addr = getConfig(Config, "main", "network")
+getConfig(Config, "main", "auto_destroy")
+auto_destroy = Config.getboolean("main", "auto_destroy")
+getConfig(Config, "main", "auto_assign_ip")
+auto_assign_ip = Config.getboolean("main", "auto_assign_ip")
+network_name = 'ops_default'
+uri = 'qemu:///system'
+
+# Connect to libvirt
+conn = libvirt.open(uri)
+if conn is None:
+        print( "Failed to open connection to the hypervisor" )
+        exit(1)
+
+if command == "start":
+        destroyNetwork(conn, network_name)
+
+        # Change the default bridge device from virbr0 to virbr%d.
+        # This will make libvirt try virbr0, virbr1, etc. until it finds a free one.
+        cnt = 0
+        ifaces = networkInterfaces()
+        found_virbr = False
+        while found_virbr == False:
+                if cnt > 254:
+                        print( "Giving up on looking for a free virbr network interface!" )
+                        exit(1)
+                bridge_nw_interface = 'virbr' + str(cnt)
+                if bridge_nw_interface not in ifaces:
+                        print( "bridge_nw_interface: %s" % bridge_nw_interface )
+                        network_spec = make_nw_spec(network_name, bridge_nw_interface, network_addr, auto_assign_ip)
+                        try:
+                                conn.networkDefineXML(network_spec)
+                                nw = conn.networkLookupByName(network_name)
+                                nw.create()
+                                found_virbr = True
+                        except:
+                                print( "Network Name: %s" % network_name )
+                                destroyNetwork( conn, network_name )
+                                print( "Error creating network interface" )
+                cnt += 1
+else:
+        # verify network exists
+        try:
+                nw = conn.networkLookupByName(network_name)
+        except:
+                print( "Error! Virtual network " + network_name + " is not defined!" )
+                exit(1)
+        if not nw.isActive():
+                print( "Error! Virtual network " + network_name + " is not running!" )
+                exit(1)
+
+emulator = getConfig(Config, "main", "emulator")
+if not os.path.exists(emulator):
+        print( "Emulator %s does not exist!" % emulator )
+        exit(1)
+
+controller_name = 'controller'
+if command == "start":
+        # Define the controller xml
+        controller_kernel = getConfig(Config, "controller", "kernel")
+        controller_disk = getConfig(Config, "controller", "disk")
+
+        controller_ip = None
+        if not auto_assign_ip:
+                controller_ip = getConfig(Config, "controller", "ip")
+        controller_spec = make_spec(controller_name, network_addr, controller_kernel,
+                                controller_disk, bridge_nw_interface, emulator,
+                                auto_assign_ip, controller_ip)
+
+        # Now that network is setup let's actually run the virtual images
+        startDomain(conn, auto_destroy, controller_name, controller_spec)
+elif command == "stop":
+        destroyDomain(conn, True, controller_name)
+elif command == "restart":
+        restartDomain(conn, controller_name)
+
+for i in Config.sections():
+        if i.startswith("compute"):
+                if command == "start":
+                        # Define the compute xml
+                        kernel = getConfig(Config, i, "kernel")
+                        disk = getConfig(Config, i, "disk")
+                        compute_ip = None
+                        if not auto_assign_ip:
+                                compute_ip = getConfig(Config, i, "ip")
+                        spec = make_spec(i, network_addr, kernel, disk, bridge_nw_interface,
+                                        emulator, auto_assign_ip, compute_ip)
+                        startDomain(conn, auto_destroy, i, spec)
+                elif command == "stop":
+                        destroyDomain(conn, True, i)
+                elif command == "restart":
+                        restartDomain(conn, i)
+
+conn.close()
diff --git a/meta-openstack/Documentation/testsystem/sample.cfg b/meta-openstack/Documentation/testsystem/sample.cfg
new file mode 100644
index 0000000..60154cf
--- /dev/null
+++ b/meta-openstack/Documentation/testsystem/sample.cfg
@@ -0,0 +1,15 @@
+[main]
+network: 192.168.122.1
+emulator: /usr/bin/qemu-system-x86_64
+auto_destroy: True
+auto_assign_ip: False
+
+[controller]
+kernel: /root/images/bzImage
+disk: /root/images/controller.ext3
+ip: 192.168.122.2
+
+[compute0]
+kernel: /root/images/bzImage
+disk: /root/images/compute.ext3
+ip: 192.168.122.3