Client for OpenStack services

Go to file

lin-hua-cheng f807f0a66e Fix wrong mock method call There is no assert_called() method in mock, replace it with assert_called_with() method. The old method used to work with mock 1.0.1 because it was a noop in magicmock. Needs https://review.openstack.org/#/c/200583 to pass the requirements check. https://review.openstack.org/#/c/193935/ changed the OS_* vars we source by forcing v2password as the auth method. change our identity v3 test setup by setting v3password Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com> Closes-Bug: 1473454 Depends-on: I0cfab6d13e5d9e744cb302c86a2c21269923e75d Change-Id: Id22765c7e044797e03d19ad1b103fadec2726aa2		2015-07-11 18:57:20 -04:00
doc	Merge "Add --os-endpoint-type cli optional argument"	2015-07-03 02:48:47 +00:00
examples	Fix examples with cacert	2015-07-01 05:11:45 -06:00
functional	Fix wrong mock method call	2015-07-11 18:57:20 -04:00
openstackclient	Fix wrong mock method call	2015-07-11 18:57:20 -04:00
python-openstackclient/locale	Imported Translations from Transifex	2015-07-09 06:11:22 +00:00
.coveragerc	Update .coveragerc	2013-02-06 16:47:06 +02:00
.gitignore	Ignore cover directory from git	2015-06-01 17:46:02 +10: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
HACKING.rst	Fix PEP8 E302 errors	2014-07-22 17:51:15 -06:00
LICENSE	First commit	2012-04-18 13:16:39 -05:00
MANIFEST.in	Add translation markers for user v2 actions	2014-10-09 14:47:19 -04:00
README.rst	Include links to developer workflow documentation	2015-06-08 11:43:24 -04:00
babel.cfg	Add translation markers for user v2 actions	2014-10-09 14:47:19 -04:00
post_test_hook.sh	Functional tests run in many environments	2015-04-25 08:42:06 -06:00
requirements.txt	Updated from global requirements	2015-06-24 00:21:41 +00:00
setup.cfg	Merge "Add support for volume API v2 QoS commands"	2015-06-30 20:43:15 +00:00
setup.py	Updated from global requirements	2015-06-22 08:28:06 +00:00
test-requirements.txt	Fix wrong mock method call	2015-07-11 18:57:20 -04:00
tox.ini	Use ostestr for test runs	2015-05-29 11:31:15 -04: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>