8c47b67e83
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 |
3 years ago | |
|---|---|---|
| doc | 3 years ago | |
| examples | 3 years ago | |
| openstackclient | 3 years ago | |
| releasenotes | 3 years ago | |
| tools | 6 years ago | |
| .coveragerc | 7 years ago | |
| .gitignore | 6 years ago | |
| .gitreview | 4 years ago | |
| .mailmap | 11 years ago | |
| .stestr.conf | 6 years ago | |
| .zuul.yaml | 3 years ago | |
| CONTRIBUTING.rst | 4 years ago | |
| Dockerfile | 3 years ago | |
| HACKING.rst | 3 years ago | |
| LICENSE | 8 years ago | |
| README.rst | 4 years ago | |
| babel.cfg | 9 years ago | |
| bindep.txt | 3 years ago | |
| lower-constraints.txt | 3 years ago | |
| requirements.txt | 3 years ago | |
| setup.cfg | 3 years ago | |
| setup.py | 6 years ago | |
| test-requirements.txt | 3 years ago | |
| tox.ini | 3 years ago | |
README.rst
Team and repository tags
OpenStackClient
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.
- PyPi - package installation
- Online Documentation
- Storyboard project - bugs and feature requests
- Blueprints - feature specifications (historical only)
- Source
- Developer - getting started as a developer
- Contributing - contributing code
- Testing - testing code
- IRC: #openstack-sdks on Freenode (irc.freenode.net)
- License: Apache 2.0
Getting Started
OpenStack Client can be installed from PyPI using pip:
pip install python-openstackclientThere are a few variants on getting help. A list of global options and supported commands is shown with --help:
openstack --helpThere is also a help command that can be used to get help text for a specific command:
openstack help
openstack help server createIf you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:
python setup.py developor:
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.