Client for OpenStack services
Go to file
Clark Boylan 4673c89154 Update the docker image to python3.11
OpenDev is trying to get consumers of these images to update to newer
iterations so that old images can be dropped from the build list. OSC
is successfully running voting python3.11 unittest jobs at this point.
This should make it safe to update the Docker container image for OSC
to python3.11 without risk of regressions.

Making this update should bring some (small) performance updates as
py311 is generally quicker than py310. As mentioned before it will also
allow OpenDev to reduce the set of images that are being built.

Change-Id: I01e3c9e27f92205979ea6562b23f0f7f3b431728
2023-10-31 18:44:00 +00:00
doc Remove project purge image commands 2023-08-28 13:52:23 +01:00
examples Blacken everything else 2023-05-10 10:51:30 +01:00
openstackclient Merge "Fix "server create"command with --boot-from-volume" 2023-10-11 15:59:24 +00:00
releasenotes Merge "volume: Deprecate '--detailed' options" 2023-09-19 13:11:32 +00:00
.coveragerc Excluding test code from coverage reports 2023-01-04 11:00:47 +00:00
.git-ignore-blame-revs Ignore black changes 2023-05-10 10:51:30 +01:00
.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
.pre-commit-config.yaml pre-commit: Enable black 2023-05-10 10:51:30 +01:00
.stestr.conf Updates for stestr 2017-09-15 06:32:58 +00:00
.zuul.yaml Update the docker image to python3.11 2023-10-31 18:44:00 +00:00
CONTRIBUTING.rst [community goal] Update contributor documentation 2021-08-30 17:13:12 +00:00
Dockerfile Update the docker image to python3.11 2023-10-31 18:44:00 +00:00
HACKING.rst hacking: Remove references to encoding 2021-04-01 14:16:22 +00:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Moving IRC network reference to OFTC 2021-07-07 19:43:00 -05:00
bindep.txt Fix gate due to switch to focal 2020-09-11 10:25:56 +02:00
requirements.txt Remove use of oslo.utils 2023-09-11 11:02:55 +01:00
setup.cfg Remove project purge image commands 2023-08-28 13:52:23 +01:00
setup.py Blacken everything else 2023-05-10 10:51:30 +01:00
test-requirements.txt Remove invalid note from requirements files 2022-08-24 11:03:52 +01:00
tox.ini tox: Bump min_version to 4.3.0 2023-08-25 11:35:16 +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:

  • For a local user, your configuration will look like the one below:

    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>]
  • For a federated user, your configuration will look the so:

    export OS_PROJECT_NAME=<project-name>
    export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
    export OS_AUTH_URL=<url-to-openstack-identity>
    export OS_IDENTITY_API_VERSION=3
    export OS_AUTH_PLUGIN=openid
    export OS_AUTH_TYPE=v3oidcpassword
    export OS_USERNAME=<username-in-idp>
    export OS_PASSWORD=<password-in-idp>
    export OS_IDENTITY_PROVIDER=<the-desired-idp-in-keystone>
    export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>
    export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>
    export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>
    export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>
    export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>
    export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>

    The corresponding command-line options look very similar:

    --os-project-name <project-name>
    --os-project-domain-name <project-domain-name>
    --os-auth-url <url-to-openstack-identity>
    --os-identity-api-version 3
    --os-auth-plugin openid
    --os-auth-type v3oidcpassword
    --os-username <username-in-idp>
    --os-password <password-in-idp>
    --os-identity-provider <the-desired-idp-in-keystone>
    --os-client-id <the-client-id-configured-in-the-idp>
    --os-client-secret <the-client-secred-configured-in-the-idp>
    --os-openid-scope <the-scopes-of-desired-attributes-to-claim-from-idp>
    --os-protocol <the-protocol-used-in-the-apache2-oidc-proxy>
    --os-access-token-type <the-access-token-type-used-by-your-idp>
    --os-discovery-endpoint <the-well-known-endpoint-of-the-idp>

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.