CF OpenStack Validator

Is your OpenStack installation ready to run BOSH and install Cloud Foundry? Run this validator to find out.

• Roadmap: Pivotal Tracker (click on Add/View Stories)
• List of executed tests

Prerequisites

OpenStack

• Keystone v3
• Create an OpenStack project/tenant
• Create a network
  • Connect the network with a router to your external network
• Allocate a floating IP
• Allow ssh access in the default security group
• Create a key pair by executing

$ ssh-keygen -t rsa -b 4096 -N "" -f cf-validator.rsa_id

• Upload the generated public key to OpenStack as cf-validator

Environment

The validator runs on Mac and Linux. Please ensure that the following list is installed on the Linux system where the validator is executed:

• make
• gcc
• zlib1g-dev
• libssl-dev
• ssh

To run on Mac the Xcode command line tools have to be installed.

For SUSE and SUSE OpenStack Cloud there is a packaged version of the cf-validator. Please download the packages cf-openstack-validator and bosh-openstack-cpi-release from the respective BuildService repository in Cloud:Tools. Install the packages to your SUSE system, and follow /usr/share/doc/packages/cf-openstack-validator/README.SUSE.md for its usage.

Usage

• git clone https://github.com/cloudfoundry-incubator/cf-openstack-validator.git
• cd cf-openstack-validator
• Copy the generated private key into the cf-openstack-validator folder.
• Copy validator.template.yml to validator.yml and replace occurrences of <replace-me> with appropriate values (see prerequisites)

$ cp validator.template.yml validator.yml

• Download OpenStack CPI from OpenStack CPI bosh.io
• Download a stemcell from OpenStack stemcells bosh.io
• Start validation

$ ./validate bosh-openstack-cpi-release-<xxx>.tgz bosh-stemcell-<xxx>-openstack-kvm-ubuntu-trusty-go_agent.tgz validator.yml [<working-dir>]

Custom Validations

Note: This feature is available in versions >=1.2

In case you have custom validations that you need to run against OpenStack you can always extend the validator.

A custom validation is an RSpec file (*_spec.rb). You can find an example here

There are two ways to include your custom validations:

1. Add it to ./extensions
2. Specify the paths to the directories containing your RSpec files in the validator.yml

   ...
   extensions:
     paths: []
   ...

If your custom validation needs any configuration you can pass add it to the validator.yml.

extensions:
  config:
    key: value

The complete hash at config can be retrieved from your test by calling extensions_config.

Note that the configuration will be globally available to all running custom validations.

Troubleshooting

the validator doesn't run on your OpenStack? See additional OpenStack related configuration options for possible solutions.

Environment variables

• FAIL_FAST: In general, all tests are executed even if some of them fail. In order to stop after the first test failure, specify FAIL_FAST=true.
• VERBOSE_FORMATTER: If you are interested in more output for the failing tests, you can set VERBOSE_FORMATTER=true.
• BOSH_OPENSTACK_VALIDATOR_SKIP_CLEANUP: Set this variable to true to skip cleanup of OpenStack resources. This can be useful for debugging failing tests.
• TAG: Use this variable to run examples that match a specified tag. (If you are working with fit, fcontext and fdescribe, use TAG=focus)