Client for OpenStack services

Go to file

Richard Theis 57dac0bc3a Refactor network endpoint enablement checking Move the network endpoint enablement checking from the 'server create' command to the common client manager. This allows future network commands to use either nova or neutron networking based on the cloud environment. This patch set also includes related unit test enhancements to the common client manager to trigger authentication on the tests. Change-Id: Ia37e81d4fb05a1e2fceb3e5d367bda769ab8e64b Related-Bug: #1519511 Related-to: blueprint neutron-client		2016-01-04 13:49:49 -06:00
doc	Docstring should say 'default' if option is default	2015-12-31 09:36:26 +05:30
examples	Switch to ksa Session	2015-12-02 01:55:14 +00:00
functional	Functional tests for security group rule	2015-12-23 15:15:06 -06:00
openstackclient	Refactor network endpoint enablement checking	2016-01-04 13:49:49 -06:00
python-openstackclient/locale	Imported Translations from Zanata	2015-11-04 06:04:23 +00:00
releasenotes	Merge "when fetching object store properties use lower()"	2015-12-15 23:47:56 +00:00
.coveragerc	Change ignore-errors to ignore_errors	2015-09-21 14:54:21 +00:00
.gitignore	Add reno for release notes management	2015-12-02 14:32:07 -06: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
.testr.conf	Use format options for functional tests	2015-05-17 12:33:39 +00:00
babel.cfg	Add translation markers for user v2 actions	2014-10-09 14:47:19 -04:00
HACKING.rst	Remove non-existing hacking deviations from doc	2015-08-09 13:22:48 -07:00
LICENSE	Remove LICENSE APPENDIX	2015-11-18 13:25:56 +09:00
post_test_hook.sh	unwedge the gate	2015-10-08 03:09:43 -04:00
README.rst	Add shields.io version/downloads links/badges into README.rst	2015-09-25 00:01:49 -04:00
requirements.txt	Updated from global requirements	2015-12-15 19:00:09 +00:00
setup.cfg	Router: Add "router show" command using SDK	2015-12-17 09:19:40 +08:00
setup.py	Updated from global requirements	2015-09-18 16:42:31 +00:00
test-requirements.txt	Updated from global requirements	2015-12-21 23:45:24 +00:00
tox.ini	Deprecated tox -downloadcache option removed	2015-12-11 23:30:31 +01:00

README.rst

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Volume 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
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

Configuration

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

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<username>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--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>