openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
4,744 Commits 6 Branches 60 Tags 72 MiB
Python 100%
cdac869412
Go to file
Monty Taylor cdac869412 Honor endpoint override from config for volume 
I'm guessing we should do this for everyone, but we have volume on
the brain right now. Rackspace is in the weird situation where
they do support v2 but only have v1 in the catalog (wut) So we
need to override the block-storage enpdoint by config. To do that,
we need to actually honor the config setting over here in OSC.

NOTE: We need to systemically overhaul how we're injesting config
over here - because there's too much variation. But we can leave
that for another day.

Story: 2007459
Task: 39137
Change-Id: Ifddf1ddd5abaa768ab18049c09d18bc269f3a4f5
2020-03-24 07:29:35 -05:00
doc Merge "Now we can add description for role creation in OSC" 2020-03-20 18:59:44 +00:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Honor endpoint override from config for volume 2020-03-24 07:29:35 -05:00
releasenotes Merge "Now we can add description for role creation in OSC" 2020-03-20 18:59:44 +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 Update image building jobs 2020-03-19 16:18:27 -05:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
bindep.txt Add bindep file 2020-03-04 15:36:18 -06:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
Dockerfile Build utility image for using osc 2020-03-14 17:15:46 -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
lower-constraints.txt Stop configuring install_command in tox and stop use pip. 2020-03-16 08:00:44 +01:00
README.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -05:00
requirements.txt Stop configuring install_command in tox and stop use pip. 2020-03-16 08:00:44 +01:00
setup.cfg Complete "Drop python2 support" goal 2020-02-05 05:58:51 +00:00
setup.py Updated from global requirements 2017-03-03 22:59:10 +00:00
test-requirements.txt Merge "Raise flake8-import-order version to latest" 2020-01-13 18:24:20 +00: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.