0c77a9fe8b
This patch allows the user to choose which authentication plugin to use with the CLI. The arguments needed by the auth plugins are automatically added to the argument parser. Some examples with the currently available authentication plugins:: OS_USERNAME=admin OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v2.0 \ OS_PASSWORD=admin openstack user list OS_USERNAME=admin OS_PROJECT_DOMAIN_NAME=default OS_USER_DOMAIN_NAME=default \ OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v3 OS_PASSWORD=admin \ OS_IDENTITY_API_VERSION=3 OS_AUTH_PLUGIN=v3password openstack project list OS_TOKEN=1234 OS_URL=http://service_url:35357/v2.0 \ OS_IDENTITY_API_VERSION=2.0 openstack user list The --os-auth-plugin option can be omitted; if so the CLI will attempt to guess which plugin to use from the other options. Change-Id: I330c20ddb8d96b3a4287c68b57c36c4a0f869669 Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
OpenStack Client
OpenStack Client (aka python-openstackclient) is a
command-line client for the OpenStack APIs. It is primarily a wrapper to
the stock python-*client modules that implement the actual REST API
client actions.
This is an implementation of the design goals shown in OpenStack Client Wiki. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. The master repository is on GitHub.
OpenStack Client has a plugin mechanism to add support for API extensions.
Note
OpenStackClient is considered to be beta release quality as of the 0.3 release; no assurances are made at this point for ongoing compatibility in command forms or output. We do not, however, expect any major changes at this point.
Getting Started
OpenStack Client can be installed from PyPI using pip:
pip install python-openstackclientDevelopers can use the install virtualenv script to create the virtualenv:
python tools/install_venv.py
source .venv/bin/activate
python setup.py developUnit tests are now run using tox. The run_test.sh script
provides compatibility but is generally considered deprecated.
The client can be called interactively by simply typing:
openstackThere are a few variants on getting help. A list of global options
and supported commands is shown with --help:
openstack --helpThere is also a help command that can be used to get
help text for a specific command:
openstack help
openstack help server createConfiguration
The CLI is configured via environment variables and command-line options as listed in https://wiki.openstack.org/wiki/OpenStackClient/Authentication.
The 'password flow' variation is most commonly used:
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<user-name>
export OS_PASSWORD=<password> # (optional)The corresponding command-line options look very similar:
--os-auth-url <url>
--os-project-name <project-name>
--os-username <user-name>
[--os-password <password>]If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.
The token flow variation for authentication uses an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:
export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>The corresponding command-line options look very similar:
--os-token <token>
--os-url <url-to-openstack-service>Additional command-line options and their associated environment variables are listed here:
--debug # turns on some debugging of the API conversation
--verbose | -v # Increase verbosity of output. Can be repeated.
--quiet | -q # suppress output except warnings and errors
--help | -h # show a help message and exitBuilding Documentation
This documentation is written by contributors, for contributors.
The source is maintained in the doc/source folder using
reStructuredText
and built by Sphinx
Building Manually:
cd doc
make htmlResults are in the build/html directory.