Python client for Rack Scale Design

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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		3 years ago
doc/source	Add User Guide to documentation.	6 years ago
releasenotes	Initial Cookiecutter Commit.	6 years ago
rsdclient	Import argparse directly	3 years ago
.coveragerc	Initial Cookiecutter Commit.	6 years ago
.gitignore	Ignore vscode related files in .gitignore	4 years ago
.gitreview	OpenDev Migration Patch	4 years ago
.mailmap	Initial Cookiecutter Commit.	6 years ago
.testr.conf	Initial Cookiecutter Commit.	6 years ago
CONTRIBUTING.rst	Update CLI usage doc	6 years ago
HACKING.rst	Update the URL in HACKING.rst	5 years ago
LICENSE	Initial Cookiecutter Commit.	6 years ago
README.rst	Remove invalid url	5 years ago
babel.cfg	Initial Cookiecutter Commit.	6 years ago
requirements.txt	Import argparse directly	3 years ago
setup.cfg	Add generic Patch and Post command	4 years ago
setup.py	Initial Cookiecutter Commit.	6 years ago
test-requirements.txt	Cleanup test-requirements	6 years ago
tox.ini	Add python 3.6 unit test job	5 years 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.

Free software: Apache license
Source: http://git.openstack.org/cgit/openstack/python-rsdclient
Bugs: https://launchpad.net/python-rsdclient

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"