Client for OpenStack services

Go to file

Lance Bragstad aefddf3a90 Update role document to include system parameter With the recent addition of system scope support in osc, we should add system docs to the role documentation. bp system-scope Change-Id: Id77511c52ff0c36ea845e0f0fbbe3ec14818ee58		2018-06-07 15:58:40 +00:00
doc	Update role document to include system parameter	2018-06-07 15:58:40 +00:00
examples	osc-lib: api.auth	2016-06-30 08:57:59 -05:00
openstackclient	Add system role functionality	2018-06-04 20:09:14 +00:00
playbooks/osc-devstack	Make osc-functional-devstack-tips actually use tips	2018-02-05 17:00:08 -06:00
releasenotes	Add system role functionality	2018-06-04 20:09:14 +00:00
tools	Avoid tox_install.sh for constraints support	2017-12-01 10:26:50 -06:00
.coveragerc	Updated coverage configuration file	2016-10-24 17:53:33 +05:30
.gitignore	Updates for stestr	2017-09-15 06:32:58 +00:00
.gitreview	Add openstack-common and test infrastructure.	2012-04-28 22:27:34 +00:00
.mailmap	Clean up test environment and remove unused imports.	2013-01-22 11:44:18 -06:00
.stestr.conf	Updates for stestr	2017-09-15 06:32:58 +00:00
.testr.conf	move unit tests to new "unit" test module	2016-09-08 15:19:50 -07:00
.zuul.yaml	add lower-constraints job	2018-03-25 11:27:13 -04:00
CONTRIBUTING.rst	Added CONTRIBUTING.rst file	2016-05-16 17:42:48 +05:30
HACKING.rst	Update the documentation link for doc migration	2017-07-24 11:33:07 +08:00
LICENSE	Remove LICENSE APPENDIX	2015-11-18 13:25:56 +09:00
README.rst	Trivial: Update pypi url to new url	2018-04-20 17:23:30 +07:00
babel.cfg	Add translation markers for user v2 actions	2014-10-09 14:47:19 -04:00
lower-constraints.txt	Add system role functionality	2018-06-04 20:09:14 +00:00
requirements.txt	Add system role functionality	2018-06-04 20:09:14 +00:00
setup.cfg	Add support to list image members	2018-03-21 08:56:08 -04:00
setup.py	Updated from global requirements	2017-03-03 22:59:10 +00:00
test-requirements.txt	Updated from global requirements	2018-03-28 10:36:59 +00:00
tox.ini	add lower-constraints job	2018-03-25 11:27:13 -04:00

README.rst

Team and repository tags

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Block Storage APIs together in a single shell with a uniform command structure.

The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack.

PyPi - package installation
Online Documentation
Launchpad project - release management
Blueprints - feature specifications
Bugs - issue tracking
Source
Developer - getting started as a developer
Contributing - contributing code
Testing - testing code
IRC: #openstack-sdks on Freenode (irc.freenode.net)
License: Apache 2.0

Getting Started

OpenStack Client can be installed from PyPI using pip:

pip install python-openstackclient

There are a few variants on getting help. A list of global options and supported commands is shown with --help:

openstack --help

There is also a help command that can be used to get help text for a specific command:

openstack help
openstack help server create

If you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:

python setup.py develop

or:

pip install -e .

Configuration

The CLI is configured via environment variables and command-line options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_USERNAME=<username>
export OS_USER_DOMAIN_NAME=<user-domain-name>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-identity-api-version 3
--os-project-name <project-name>
--os-project-domain-name <project-domain-name>
--os-username <username>
--os-user-domain-name <user-domain-name>
[--os-password <password>]

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.

Authentication may also be performed using 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>