x
/
python-rsdclient
Code Issues Proposed changes
Python client for Rack Scale Design
73 Commits 7 Branches 8 Tags 2 MiB
Python 99.6%
reStructuredText 0.4%
Go to file
Eric Fried d1a515eac0 Import argparse directly 
We were importing _argparse (private) from cliff to get at
argparse.HelpFormatter, which was present there only because it was
being transitively imported directly from argparse itself. Commit
584352dcd008d58c433136539b22a6ae9d6c45cc got rid of this transitive
import, which means that rsdclient would have broken on the next cliff
release.

This commit just imports argparse directly instead.

And because that was the only reference to cliff in the project, this
commit also removes it from the requirements.

For more information, see http://lists.openstack.org/pipermail/openstack-discuss/2020-January/011852.html

Change-Id: I7f99d80a3be38acc45af83e54b32ebc2f5b40859
 		2020-01-14 11:37:05 -06: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 Import argparse directly 2020-01-14 11:37:05 -06:00
.coveragerc Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
.gitignore Ignore vscode related files in .gitignore 2019-09-11 11:51:19 -07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:51:08 +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 Update the URL in HACKING.rst 2018-09-25 00:36:27 +08:00
LICENSE Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
README.rst Remove invalid url 2018-11-13 08:33:13 +08:00
babel.cfg Initial Cookiecutter Commit. 2017-08-02 14:44:01 -07:00
requirements.txt Import argparse directly 2020-01-14 11:37:05 -06:00
setup.cfg Add generic Patch and Post command 2019-09-11 13:23:41 -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 Add python 3.6 unit test job 2018-11-09 03:01:10 +00: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"