History

Drew Thorstensen 08577f420d Add more information on local.conf files This change set adds some additional background information on the local.conf files. This was feedback from the field that this will help developers as they on board for the project. Change-Id: I0e69bb01e497bfd29817559021cdafeaf0248cad		2016-02-02 20:43:02 -05:00
..
README.rst	Add more information on local.conf files	2016-02-02 20:43:02 -05:00
local.conf.aio	pypowervm log level to INFO in local.conf samples	2016-01-21 08:00:54 -06:00
local.conf.compute	pypowervm log level to INFO in local.conf samples	2016-01-21 08:00:54 -06:00
local.conf.control	Disable ceilometer-acompute in control node example	2015-12-02 15:11:54 -06:00
override-defaults	Add base devstack plugins support	2015-10-29 21:43:01 -04:00
plugin.sh	Disable installing pypowervm by default	2015-12-19 16:21:00 -06:00
powervm-functions.sh	Do not error if NovaLink not installed	2016-01-21 12:42:04 -06:00
settings	Disable installing pypowervm by default	2015-12-19 16:21:00 -06:00

README.rst

Installing with DevStack

What is DevStack?

DevStack is a script to quickly create an OpenStack development environment.

Find out more here.

What are DevStack plugins?

DevStack plugins act as project-specific extensions of DevStack. They allow external projects to execute code directly in the DevStack run, supporting configuration and installation changes as part of the normal local.conf and stack.sh execution. For NovaLink, we have DevStack plugins for each of our three projects - nova-powervm, networking-powervm, and ceilometer-powervm. These plugins, with the appropriate local.conf settings for your environment, will allow you to simply clone down DevStack, configure, run stack.sh, and end up with a working OpenStack/Novalink PowerVM environment with no other scripting required.

More details can be found here.

How to use the NovaLink DevStack plugins:

Download DevStack:

$ git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack

Set up your local.conf file to pull in our projects:
1. If you have an existing DevStack local.conf, modify it to pull in this project by adding:
```
[[local|localrc]]
enable_plugin nova-powervm http://git.openstack.org/openstack/nova-powervm
```
and following the instructions for networking-powervm and ceilometer-powervm as needed for your environment.
1. If you're setting up DevStack for the first time, example files are available in the nova-powervm project to provide reference on using this driver with the corresponding networking-powervm and ceilometer-powervm drivers. Following these example files will enable the appropriate drivers and services for each node type. Example config files for all-in-one, compute, and control nodes can be found here.
  
  The nova-powervm project provides three different sample local.conf files as a starting point for devstack.
  - local.conf.aio
    
    Runs on the NovaLink VM of the PowerVM system
    
    Provides a full 'all in one' devstack VM
  - local.conf.control
    
    Can run on any devstack capable machine (POWER or x86)
    
    Provides the controller node for devstack. Typically paired with the local.conf.compute
  - local.conf.compute
    
    Runs on the NovaLink VM of the PowerVM system
    
    Provides the compute node for a devstack. Typically paired with the local.conf.control
See our devrefs and plugin references for the configuration options for each driver, then configure the installation in local.conf as needed for your environment.
For nova-powervm, changing the DISK_DRIVER settings for your environment will be required. The default configuration for other settings will be sufficient for most installs. :
```
[[local|localrc]]
...
DISK_DRIVER =
VOL_GRP_NAME =
CLUSTER_NAME =

[[post-config|$NOVA_CONF]]
[powervm]
...
```
A few notes:
- By default this will pull in the latest/trunk versions of all the projects. If you want to run a stable version instead, you can either check out that stable branch in the DevStack repo (git checkout stable/liberty) which is the preferred method, or you can do it on a project by project basis in the local.conf file as needed.
- If you need any special services enabled for your environment, you can also specify those in your local.conf file. In our example files we demonstrate enabling and disabling services (n-cpu, q-agt, etc) required for our drivers.
Run stack.sh from DevStack:
```
$ cd /opt/stack/devstack
$ FORCE=yes ./stack.sh
```
FORCE=yes is needed on Ubuntu 15.10 since only Ubuntu LTS releases are officially supported by DevStack. If you're running a control only node on a different, supported OS version you can skip using FORCE=yes.
At this point DevStack will run through stack.sh, and barring any DevStack issues, you should end up with a standard link to your Horizon portal at the end of the stack run. Congratulations!