Client for OpenStack services
Go to file
Monty Taylor 8c47b67e83 Build utility image for using osc
python-openstackclient currently has a non-zero number of dependencies,
so for admins who would like to run it on laptops or similar it can
get tricky. In opendev, for instance, admins have it installed into
a venv on a jump host, but it's really wonky to keep up with.

Use the opendev/python-builder opendev/python-base pair to make a
minimal image that contains an install of python-openstackclient
and publish it to the osclient org on dockerhub. There is an overall
policy against having binary artifacts such as this appear to be
official deliverables of the OpenStack project, which this is not.
It's also only publishing images based on master, so no warranties
should be implied. But if this makes life easier for a user somewhere,
cool.

Change-Id: I9a8bfc27c127e92b6856cb6a3e45b32c818db16c
2020-03-14 17:15:46 -05:00
doc Merge "Complete "Drop python2 support" goal" 2020-02-05 17:21:38 +00:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Use 'KeyValueAppendAction' from osc-lib 2020-02-03 15:25:40 +00:00
releasenotes Complete "Drop python2 support" goal 2020-02-05 05:58: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 Build utility image for using osc 2020-03-14 17:15:46 -05:00
CONTRIBUTING.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -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
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 bindep file 2020-03-04 15:36:18 -06:00
lower-constraints.txt Add support for app cred access rules 2020-01-17 11:14:51 -08:00
requirements.txt Add support for app cred access rules 2020-01-17 11:14:51 -08: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 Bump tox minversion 2020-01-07 09:22:30 -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.