Python client for Rack Scale Design
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lin Yang 5e05430720 Update rsd-lib dependency to 1.2.0 1 month ago
doc/source Add User Guide to documentation. 1 year ago
releasenotes Initial Cookiecutter Commit. 2 years ago
rsdclient Add generic Patch and Post command 1 month ago
.coveragerc Initial Cookiecutter Commit. 2 years ago
.gitignore Ignore vscode related files in .gitignore 1 month ago
.gitreview OpenDev Migration Patch 6 months ago
.mailmap Initial Cookiecutter Commit. 2 years ago
.testr.conf Initial Cookiecutter Commit. 2 years ago
CONTRIBUTING.rst Update CLI usage doc 2 years ago
HACKING.rst Update the URL in HACKING.rst 1 year ago
LICENSE Initial Cookiecutter Commit. 2 years ago
README.rst Remove invalid url 11 months ago
babel.cfg Initial Cookiecutter Commit. 2 years ago
requirements.txt Update rsd-lib dependency to 1.2.0 1 month ago
setup.cfg Add generic Patch and Post command 1 month ago
setup.py Initial Cookiecutter Commit. 2 years ago
test-requirements.txt Cleanup test-requirements 2 years ago
tox.ini Add python 3.6 unit test job 11 months ago

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"