Installation

If you are installing senlinclient from an OpenStack distribution, follow the guide provided by the vendor.

If you prefer installing senlinclient from source repo, you can do it by first get senlinclient code from OpenStack git repository.

$ cd /opt/stack
$ git clone https://opendev.org/openstack/python-senlinclient.git

Then execute the following command

$ cd python-senlinclient
$ sudo python setup.py install

SenlinClient Tests

Unit Tests

Senlinclient contains a suite of unit tests, in the senlinclient/tests/unit directory.

Any proposed code change will be automatically rejected by the OpenStack Jenkins server if the change causes unit test failures.

Running the tests

There are a number of ways to run unit tests currently, and there's a combination of frameworks used depending on what commands you use. The preferred method is to use tox, which calls stestr via the tox.ini file. To run all tests simply run:

tox

This will create a virtual environment, load all the packages from test-requirements.txt and run all unit tests as well as run flake8 and hacking checks against the code.

Note that you can inspect the tox.ini file to get more details on the available options and what the test run does by default.

Running a subset of tests using tox

One common activity is to just run a single test, you can do this with tox simply by specifying to just run py27 or py35 tests against a single test:

tox -epy27 senlinclient.tests.unit.v1.test_node.TestNodeList.test_node_list_defaults

Or all tests in the test_node.py file:

tox -epy27 senlinclient.tests.unit.v1.test_node

For more information on these options and how to run tests, please see the stestr documentation.

Senlin CLI man page

SYNOPSIS

The Senlin clustering service doesn't provide its own command line tool since Queens release. Users are supposed to use openstack cluster commands instead. The python-senlinclient project is an implementation of the OpenStackClient (OSC) plugin that interacts with the Senlin clustering service.

openstack [options] <command> [command-options]

openstack help cluster

DESCRIPTION

The openstack cluster command line utility interacts with OpenStack Cluster Service (Senlin).

In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use configuration options --os-username, --os-password, --os-project-name, --os-identity-api-version, -os-user-domain-name, --os-project-domain-name and --os-auth-url or set corresponding environment variables:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_PROJECT_NAME=myproject
export OS_IDENTITY_API_VERSION=3
export OS_AUTH_URL=http://auth.example.com:5000/v3
export OS_USER_DOMAIN_NAME=Default
export OS_PROJECT_DOMAIN_NAME=Default

OPTIONS

To get a list of available commands and options run:

openstack help cluster

To get usage and options of a command:

openstack help cluster <command>

EXAMPLES

Get help for profile create command:

openstack help cluster profile create

List all the profiles:

openstack cluster profile list

Create new profile:

openstack cluster profile create --spec-file cirros_basic.yaml PF001

Show a specific profile details:

openstack cluster profile show PF001

Create a node:

openstack cluster node create --profile PF001 NODE001

For more information, please see the senlin documentation. https://docs.openstack.org/senlin/latest/tutorial/basics.html