OpenStack External Test Platform

!! THIS REPOSITORY IS VERY MUCH A WORK IN PROGRESS !!

PLEASE USE AT YOUR OWN RISK AND PROVIDE FEEDBACK IF YOU CAN!

This repository contains documentation and modules in a variety of configuration management systems that demonstrates setting up a real-world external testing platform that links with the upstream OpenStack CI platform.

It installs Jenkins, Jenkins Job Builder (JJB), the Gerrit Jenkins plugin, Nodepool, HTTP Proxy settings, and a set of scripts that make running a variety of OpenStack integration tests easy.

Currently only Puppet modules are complete and tested.

Pre-requisites

The following are pre-requisite steps before you install anything:

1. Read the official documentation: http://ci.openstack.org/third_party.html

2. Get a Gerrit account for your testing system registered

3. Ensure base packages installed on your target hosts/VMs

4. Set up your data repository

Below are detailed instructions for each step.

Registering an Upstream Gerrit Account

You will need to register a Gerrit account with the upstream OpenStack CI platform. You can read the instructions for doing that

Ensure Basic Packages on Hosts/VMs

We will be installing a Jenkins master server and infrastructure on one host or virtual machine and one or more Jenkins slave servers on hosts or VMs.

On each of these target nodes, you will want the base image to have the wget, openssl, ssl-cert and ca-certificates packages installed before running anything in this repository.

Set Up Your Data Repository

You will want to create a Git repository containing configuration data files -- such as the Gerrit username and private SSH key file for your testing account -- that are used in setting up the test platform.

The easiest way to get your data repository set up is to make a copy of the example repository I set up here:

http://github.com/rasselin/os-ext-testing-data

and put it somewhere private. There are a few things you will need to do in this data repository:

1. Copy the private SSH key that you submitted when you registered with the upstream OpenStack Infrastructure team into somewhere in this repo.

2. If you do not want to use the SSH key pair in the os-ext-testing-data example data repository and want to create your own SSH key pair, do this step.

   Create an SSH key pair that you will use for Jenkins. This SSH key pair will live in the /var/lib/jenkins/.ssh/ directory on the master Jenkins host, and it will be added to the /home/jenkins/.ssh/authorized_keys file of all slave hosts::

   ssh-keygen -t rsa -b 1024 -N '' -f jenkins_key

   Once you do the above, copy the jenkins_key and jenkins_key.pub files into your data repository.

3. Copy the vars.sh.sample to vars.sh and open up vars.sh in an editor.

4. Change the value of the $UPSTREAM_GERRIT_USER shell variable to the Gerrit username you registered with the upstream OpenStack Infrastructure team as detailed in these instructions

5. Change the value of the $UPSTREAM_GERRIT_SSH_KEY_PATH shell variable to the relative path of the private SSH key file you copied into the repository in step #2.

   For example, let's say you put your private SSH key file named mygerritkey into a directory called ssh within the repository, you would set the $UPSTREAM_GERRIT_SSH_KEY_PATH value to ssh/mygerritkey

6. If for some reason, in step #2 above, you either used a different output filename than jenkins_key or put the key pair into some subdirectory of your data repository, then change the value of the $JENKINS_SSH_KEY_PATH variable in vars.sh to an appropriate value.

7. Copy etc/nodepool/nodepool.yaml.erb.sample to etc/nodepool/nodepool.yaml.erb. Adjust as needed according to docs: http://ci.openstack.org/nodepool/configuration.html.

8. Update etc/zuul/layout.yaml according to docs: http://ci.openstack.org/zuul/zuul.html#layout-yaml

Usage

Setting up the Jenkins Master

Installation

On the machine you will use as your Jenkins master, run the following:

wget https://raw.github.com/rasselin/os-ext-testing/master/puppet/install_master.sh
bash install_master.sh

The script will install Puppet, create an SSH key for the Jenkins master, create self-signed certificates for Apache, and then will ask you for the URL of the Git repository you are using as your data repository (see Prerequisites #3 above). Enter the URL of your data repository and hit Enter.

Puppet will proceed to set up the Jenkins master.

Manual setup of Jenkins scp 1.9 plugin

Version 1.8 is publicly available, but does not have all features (e.g. copy console log file, copy files after failure, etc.). Follow these steps to manually build and install the scp 1.9 plugin:

• git clone https://github.com/jenkinsci/scp-plugin
• cd scp-plugin; mvn package
• Jenkins Manage Plugins; Advanced; Upload Plugin (target/scp.hpi from the maven build)

Source: http://lists.openstack.org/pipermail/openstack-infra/2013-December/000568.html

Restart Jenkins to get the plugins fully installed

sudo service jenkins restart

Load Jenkins Up with Your Jobs

Run the following at the command line:

sudo jenkins-jobs --flush-cache update /etc/jenkins_jobs/config

Configuration

Start zuul

sudo service zuul start
sudo service zuul-merger start

Configuration

After Puppet installs Jenkins and Zuul and Nodepool, you will need to do a couple manual configuration steps in the Jenkins UI.

1. Go to the Jenkins web UI. By default, this will be http://$IP_OF_MASTER:8080

2. Click the Manage Jenkins link on the left

3. Click the Configure System link

4. Scroll down until you see "Gearman Plugin Config". Check the "Enable Gearman" checkbox.

5. Click the "Test Connection" button and verify Jenkins connects to Gearman.

6. Scroll to "ZMQ Event Publisher" and select "Enable on all Jobs". Double-check the port matches the URL configured for "zmq-publishers" in $DATA_REPO/etc/nodepool/nodepool.yaml.erb

7. Scroll down to the bottom of the page and click Save

8. At the command line, do this::

   sudo service zuul restart

Setting up Nodepool Jenkins Slaves

1. Re-run the install_master.sh script for your changes to take effect.

2. TODO(Ramy) Make sure the jenkins key is setup in the 'cloud' provider with name "jenkins". Also, make it configurable.

3. Start nodepool:

   sudo su - nodepool
   source /etc/default/nodepool
   nodepoold -d $DAEMON_ARGS
   

   TODO(Ramy) why does sudo service nodepool not work?

Setting up Static Jenkins Slaves

On each machine you will use as a Jenkins slave, run:

wget https://raw.github.com/jaypipes/os-ext-testing/master/puppet/install_slave.sh
bash install_slave.sh

The script will install Puppet, install a Jenkins slave, and install the Jenkins master's public SSH key in the authorized_keys of the Jenkins slave.

Once the script completes successfully, you need to add the slave node to Jenkins master. To do so manually, follow these steps:

1. Go to the Jenkins web UI. By default, this will be http://$IP_OF_MASTER:8080

2. Click the Credentials link on the left

3. Click the Global credentials link

4. Click the Add credentials link on the left

5. Select SSH username with private key from the dropdown labeled "Kind"

6. Enter "jenkins" in the Username textbox

7. Select the "From a file on Jenkins master" radio button and enter /var/lib/jenkins/.ssh/id_rsa in the File textbox

8. Click the OK button

9. Click the "Jenkins" link in the upper left to go back to home page

10. Click the Manage Jenkins link on the left

11. Click the Manage Nodes link

12. Click the "New Node" link on the left

13. Enter devstack_slave1 in the Node name textbox

14. Select the Dumb Slave radio button

15. Click the OK button

16. Enter 2 in the Executors textbox

17. Enter /home/jenkins/workspaces in the Remote root directory textbox

18. Enter devstack_slave in the Labels textbox

19. Enter the IP Address of your slave host or VM in the Host textbox

20. Select jenkins from the Credentials dropdown

21. Click the Save button

22. Click the Log link on the left. The log should show the master connecting to the slave, and at the end of the log should be: "Slave successfully connected and online"

Setting up Log Server

The Log server is a simple VM with an Apache web server installed that provides http access to all the log files uploaded by the jenkins jobs. It is a separate script because the jenkins-zuul-nodepool 'master' server may/can not be publicly accessible for security reasons. In addition, separating out the log server as its own server relaxes the disk space requirements needed by the jenkins master.

It's configuration uses the openstack-infra scripts, which provide the friendly log filtering features, hightlighting, the line references, etc.

For simplicity, it is recommended to use the same jenkins key for authentication.

wget https://raw.githubusercontent.com/rasselin/os-ext-testing/master/puppet/install_log_server.sh
#MANUALLY Update the LOG_SERVER_DOMAIN & JENKINS_SSH_PUBLIC_KEY_CONTENTS variables
bash install_log_server.sh

Bug:

err: /Stage[main]/Logging::Master/Exec[install_os-loganalyze]: Failed to call refresh: python setup.py install returned 1 instead of one of [0] at /home/stack/os-ext-testing/puppet/modules/logging/manifests/master.pp:89

Workaround:

cd /opt/os-loganalyze
sudo python setup.py install

When completed, the jenkins user will be able to upload files to /srv/static/logs, which Apache will serve via http.