x
/
python-rsdclient
Code Issues Proposed changes
Python client for Rack Scale Design
27 Commits 7 Branches 8 Tags 2 MiB
Python 99.6%
reStructuredText 0.4%
Go to file
Lin Yang f02d3fc713 Add comment for each OSC subcommand 
OSC will automatically use subcommands comments to generate usage
doc. So added one line comments for each one as other client project
does.

Change-Id: I5799f3fb989af7855634c3c1fc994e24b1add533
 		2017-11-28 08:56:54 -08:00
doc/source Add User Guide to documentation. 2017-11-27 20:35:51 -08:00
releasenotes Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
rsdclient Add comment for each OSC subcommand 2017-11-28 08:56:54 -08:00
tools Fix pip install package failure 2017-11-27 20:23:36 -08:00
.coveragerc Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
.gitignore Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
.gitreview Added .gitreview 2017-08-02 08:33:58 +00:00
.mailmap Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
.testr.conf Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
CONTRIBUTING.rst Update CLI usage doc 2017-09-29 16:44:53 -07:00
HACKING.rst Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
LICENSE Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
README.rst Update CLI usage doc 2017-09-29 16:44:53 -07:00
babel.cfg Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
requirements.txt Support more arguments for node compose command 2017-08-24 17:42:05 -07:00
setup.cfg Add new command to show fabric details 2017-09-19 17:22:11 -07:00
setup.py Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
test-requirements.txt Cleanup test-requirements 2017-09-21 23:25:36 +08:00
tox.ini Fix pip install package failure 2017-11-27 20:23:36 -08:00

README.rst

python-rsdclient

OpenStack client plugin for Rack Scale Design

This is a client for the RSD Pod Manager API, which is based on OpenStack client framework. It provides a Python API (rsdclient/v1 module) and a RSD specific plugin for OpenStack client (rsdclient/osc).

Development takes place via the usual OpenStack processes as outlined in the developer guide. The master repository is on git.openstack.org.

Contents:

Installation

To use openstack rsd CLI, the python-openstackclient and python-rsdclient should be installed:

# pip install python-openstackclient
# pip install python-rsdclient

To use the CLI, it requires two parts of configuration, OpenStack and RSD login info.

At first, you have to provide your OpenStack username, password, project, and auth endpoint. You can use configuration options --os-username, --os-password, --os-project-id (or --os-project-name), and --os-auth-url, or set the corresponding environment variables:

$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_PROJECT_NAME=project                         # or OS_PROJECT_ID
$ export OS_PROJECT_DOMAIN_ID=default
$ export OS_USER_DOMAIN_ID=default
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://auth.example.com:5000/identity

Then, you have to provide your RSD username, password, SSL certificate with admin privilege, and pod manager URL. You can use configuration options --rsd-username, --rsd-password, --rsd-verify, and --rsd-url, or set the corresponding environment variables:

$ export RSD_USERNAME=admin
$ export RSD_PASSWORD=password
$ export RSD_VERIFY=False     # or RSD_VERIFY=<path to SSL certificate>
$ export RSD_URL=https://localhost:8443/

OpenStackClient RSD Plugin

To get a list of available (sub)commands and options, run:

$ openstack help rsd

To get usage and options of a command, run:

$ openstack help rsd <sub-command>

An example of composing a node only with name:

$ openstack rsd node compose --name "testing node"