openstack
/
python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
4,773 Commits 10 Branches 46 Tags 69 MiB
Python 100%
Go to file
Sean McGinnis 725e004d32
Use unittest.mock instead of third party mock 
Now that we no longer support py27, we can use the standard library
unittest.mock module instead of the third party mock lib.

Change-Id: Ibd39328c27b68190e2edbf1f52fcea52db3ae791
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
 		2020-04-03 17:11:40 -05:00
doc Cleanup Python 2.7 support 2020-03-30 20:00:41 +02:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Use unittest.mock instead of third party mock 2020-04-03 17:11:40 -05:00
releasenotes Merge "Add command: router add/remove route --route" 2020-04-01 11:03:51 +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 OpenDev Migration Patch 2019-04-19 19:45:05 +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
.zuul.yaml Be explicit about python version in image 2020-03-26 08:48:20 -05:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
Dockerfile Be explicit about python version in image 2020-03-26 08:48:20 -05:00
HACKING.rst Replace six.iteritems() with .items() 2020-01-09 18:41:29 +09:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -05:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
bindep.txt Add libc6-dev to bindep 2020-03-26 08:46:13 -05:00
lower-constraints.txt Use unittest.mock instead of third party mock 2020-04-03 17:11:40 -05:00
requirements.txt Add command: router add/remove route --route 2020-03-30 16:19:05 +02:00
setup.cfg Merge "Add command: router add/remove route --route" 2020-04-01 11:03:51 +00:00
setup.py Cleanup Python 2.7 support 2020-03-30 20:00:41 +02:00
test-requirements.txt Use unittest.mock instead of third party mock 2020-04-03 17:11:40 -05:00
tox.ini Stop configuring install_command in tox and stop use pip. 2020-03-16 08:00:44 +01:00

README.rst

Team and repository tags

image

OpenStackClient

Latest Version

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

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.