openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
1,384 Commits 6 Branches 60 Tags 72 MiB
Python 100%
817ab3ec0e
Go to file
Steve Martinelli 817ab3ec0e set image api to 1 for functional tests 
devstack now defaults to image api v2, but osc does not support
v2 image create. set the functional tests to use v1 for now
to unwedge the gate.

Closes-Bug: #1496337
Change-Id: Ia02ed761446b8de52c932a424b9c423691ebcceb
2015-09-16 19:33:34 +00:00
doc Merge "Add filtering by user for 'openstack server list'" 2015-09-10 20:19:43 +00:00
examples Fix examples with cacert 2015-07-01 05:11:45 -06:00
functional set image api to 1 for functional tests 2015-09-16 19:33:34 +00:00
openstackclient Merge "Use a common decorator to log 'take_action' activation" 2015-09-11 02:43:54 +00:00
python-openstackclient/locale Imported Translations from Transifex 2015-09-11 06:10:25 +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
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 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
post_test_hook.sh Functional tests run in many environments 2015-04-25 08:42:06 -06:00
README.rst Include links to developer workflow documentation 2015-06-08 11:43:24 -04:00
requirements.txt Updated from global requirements 2015-09-12 01:15:28 +00:00
setup.cfg Alphabetize setup.cfg 2015-08-06 22:01:55 -07:00
setup.py Updated from global requirements 2015-07-15 01:37:44 +00:00
test-requirements.txt Updated from global requirements 2015-08-04 00:49:08 +00:00
tox.ini Remove requirements.txt from tox.ini 2015-07-17 11:21:02 -06: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.

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>