openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
4,840 Commits 6 Branches 60 Tags 72 MiB
Python 100%
12f1e56ebf
Go to file
Stephen Finucane 12f1e56ebf Add 'openstack server create --use-config-drive' 
Despite what the help text for this options says, the nova API only
accepts boolean values for this value and has done so since at least the
introduction of the 2.1 microversioned API. While it would be nice to
convert '--config-drive' to a boolean flag, we'd need to be able to
retain temporary support for people passing arguments. 'nargs=?' [1]
looks promising but it has an annoying tendency to swallow a positional
argument following it [2]. Since that is not an option, we have to live
with a new config option, '--use-config-drive' and a '--no-config-drive'
counterpart.

[1] https://docs.python.org/3/library/argparse.html#nargs
[2] https://bugs.python.org/issue9338

Change-Id: If9cce0ad4094cc9cef1c9136b80c3b0f35a82c7a
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Story: #2005468
Task: #30547
2020-07-22 10:59:07 +01:00
doc Merge "image: autogenerate docs" 2020-06-09 02:10:31 +00:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Add 'openstack server create --use-config-drive' 2020-07-22 10:59:07 +01:00
releasenotes Add 'openstack server create --use-config-drive' 2020-07-22 10:59:07 +01: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 Remove enabling of glance v1 API 2020-07-03 10:06:12 -05:00
bindep.txt Add libc6-dev to bindep 2020-03-26 08:46:13 -05:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
Dockerfile Add a command to trigger entrypoint cache creation 2020-07-06 14:53:50 -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 Merge "Expose flag for forcing use of import for images" 2020-07-08 17:01:22 +00:00
README.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -05:00
requirements.txt Merge "Expose flag for forcing use of import for images" 2020-07-08 17:01:22 +00:00
setup.cfg Merge "Make volume backup record commands available in v3" 2020-07-07 10:58:15 +00:00
setup.py Cleanup Python 2.7 support 2020-03-30 20:00:41 +02:00
test-requirements.txt switch to stevedore for entry points 2020-07-06 08:44:31 -04:00
tox.ini Remove os-client-config references 2020-06-08 16:20:28 -05: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.