Clustering service for managing homogeneous objects in OpenStack
Go to file
Haiwei Xu 4950e3e011 Fix two README.rst errors
Add missing password option to setup-service script,
and fix the connection link.

Change-Id: Ia2596a83ca8ded90985c40e9266eca8716773dd8
2015-05-25 18:07:30 +09:00
bin Replace 'tenant' by 'project' 2015-04-03 01:36:47 -04:00
devstack Fix admin requirement in trust middleware 2015-05-08 03:53:50 -04:00
doc Add webhook documentation 2015-05-17 23:33:00 -04:00
etc/senlin Remove api-flavor configuration option 2015-04-26 00:00:01 -04:00
examples Sample scaling policies 2015-05-11 03:01:40 -04:00
senlin Merge "Replace sdk user_reference module with profile" 2015-05-25 08:33:37 +00:00
tools Fix admin requirement in trust middleware 2015-05-08 03:53:50 -04:00
.coveragerc Tuning tox configuration 2015-04-13 05:46:26 -04:00
.gitignore Tuning tox configuration 2015-04-13 05:46:26 -04:00
.gitreview Fixed typo in .gitreview file 2015-03-18 16:42:20 +08:00
.testr.conf Initial copy of project files from Heat 2014-12-10 15:47:34 +08:00
CONTRIBUTING.rst Added some docs about hacking and testing 2015-03-25 11:32:09 +08:00
FEATURES.rst feature request: customizable batch size 2015-05-13 09:04:26 -04:00
HACKING.rst Added some docs about hacking and testing 2015-03-25 11:32:09 +08:00
LICENSE Initialial commit 2014-12-10 15:32:50 +08:00
MANIFEST.in Removed useless entries 2015-03-11 20:04:08 +08:00
README.rst Fix two README.rst errors 2015-05-25 18:07:30 +09:00
TODO.rst API support for CLUSTER_RESIZE operation 2015-05-13 04:53:31 -04:00
babel.cfg Initial copy of project files from Heat 2014-12-10 15:47:34 +08:00
install.sh Fix setup scripts in tools folder 2015-04-09 00:35:18 +08:00
openstack-common.conf Updated oslo dependency to reality 2015-04-13 03:19:07 -04:00
pylintrc Initial copy of project files from Heat 2014-12-10 15:47:34 +08:00
requirements.txt Sync pbr version requirement 2015-05-07 21:02:42 -04:00
run_tests.sh Initial version of test script 2014-12-10 16:18:44 +08:00
setup.cfg Add ScalingInPolicy and ScalingOutPolicy 2015-05-04 22:45:15 -04:00
setup.py Initial version 2014-12-17 15:22:51 +08:00
test-requirements.txt Bump requirement versions 2015-03-21 18:31:10 +08:00
tox.ini Tuning tox configuration 2015-04-13 05:46:26 -04:00
uninstall.sh Initial version borrowed from Heat 2014-12-10 17:17:35 +08:00

README.rst

senlin

Senlin is a clustering service for OpenStack cloud. It creates and operates clusters of homogenous objects exposed by other OpenStack services. The goal is to make orchestration of collections of similar objects easier.

Senlin provides ReSTful APIs to users so that they can associate various policies to a cluster. Sample policies include placement policy, load balancing policy, failover policy, scaling policy, ... and so on.

IRC Channel: #senlin

Install via Devstack

This is the recommended way to install Senlin service. Please refer to devstack/README.rst for detailed instructions.

Note that Senlin client is also installed when following the instructions it the above mentioned document.

Manual Installation

Install Senlin Server

  1. Get Senlin source code from OpenStack git repository
$ cd /opt/stack
$ git clone http://git.openstack.org/stackforge/senlin.git
  1. Install Senlin with required packages
$ cd /opt/stack/senlin
$ sudo pip install -e .
  1. Register Senlin clustering service with keystone.

    This can be done using the setup-service script under tools folder.

$ cd /opt/stack/senlin/tools
$ ./setup-service <HOST IP> <SERVICE_PASSWORD>
  1. Generate configuration file for the Senlin service
$ cd /opt/stack/senlin
$ tools/gen-config
$ sudo mkdir /etc/senlin
$ cp etc/senlin/api-paste.ini /etc/senlin
$ cp etc/senlin/policy.json /etc/senlin
$ cp etc/senlin/senlin.conf.sample

Edit file /etc/senlin/senlin.conf according to your system settings. The most common options to be customized include:

[database]
connection = mysql://senlin:<DB PASSWORD>@127.0.0.1/senlin?charset=utf8

[keystone_authtoken]
auth_uri = http://<HOST>:5000/v3
auth_version = 3
cafile = /opt/stack/data/ca-bundle.pem
identity_uri = http://<HOST>:35357
admin_user = senlin
admin_password = <SENLIN PASSWORD>
admin_tenant_name = service

[oslo_messaging_rabbit]
rabbit_host = <HOST>
rabbit_password = <RABBIT PASSWORD>
  1. Create Senlin Database

Create Senlin database using the senlin-db-recreate script under the tools subdirectory. Before calling the script, you need edit it to customize the password you will use for the senlin user.

$ cd /opt/stack/senlin/tools
$ ./senlin-db-recreate
  1. Start senlin engine and api service.

You may need two consoles for the services each.

$ senlin-engine --config-file /etc/senlin/senlin.conf
$ senlin-api --config-file /etc/senlin/senlin.conf

Install Senlin Client

  1. Get Senlin client code from OpenStack git repository.
$ cd /opt/stack
$ git clone http://git.openstack.org/stackforge/python-senlinclient.git
  1. Install senlin client.
$ cd python-senlinclient
$ python setup.py install

You are ready to begin your journey (aka. adventure) with Senlin, now.