Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/openstack/python-openstackclient

Client for OpenStack services. Mirror of code maintained at opendev.org.
https://github.com/openstack/python-openstackclient

client-tools

Last synced: 3 months ago
JSON representation

Client for OpenStack services. Mirror of code maintained at opendev.org.

Lists

README 

        
========================

Team and repository tags

========================



.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg

    :target: https://governance.openstack.org/tc/reference/tags/index.html



.. Change things from this point on



===============

OpenStackClient

===============



.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg

    :target: https://pypi.org/project/python-openstackclient/

    :alt: 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.



* `PyPi`_ - package installation

* `Online Documentation`_

* `Launchpad 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 OFTC (irc.oftc.net)

* License: Apache 2.0



.. _PyPi: https://pypi.org/project/python-openstackclient

.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/

.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient

.. _`Launchpad project`: https://bugs.launchpad.net/python-openstackclient

.. _Source: https://opendev.org/openstack/python-openstackclient

.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html

.. _Contributing: https://docs.openstack.org/infra/manual/developers.html

.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing

.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient



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=

    export OS_IDENTITY_API_VERSION=3

    export OS_PROJECT_NAME=

    export OS_PROJECT_DOMAIN_NAME=

    export OS_USERNAME=

    export OS_USER_DOMAIN_NAME=

    export OS_PASSWORD=  # (optional)



  The corresponding command-line options look very similar::



    --os-auth-url 

    --os-identity-api-version 3

    --os-project-name 

    --os-project-domain-name 

    --os-username 

    --os-user-domain-name 

    [--os-password ]



- For a federated user, your configuration will look the so::



    export OS_PROJECT_NAME=

    export OS_PROJECT_DOMAIN_NAME=

    export OS_AUTH_URL=

    export OS_IDENTITY_API_VERSION=3

    export OS_AUTH_PLUGIN=openid

    export OS_AUTH_TYPE=v3oidcpassword

    export OS_USERNAME=

    export OS_PASSWORD=

    export OS_IDENTITY_PROVIDER=

    export OS_CLIENT_ID=

    export OS_CLIENT_SECRET=

    export OS_OPENID_SCOPE=

    export OS_PROTOCOL=

    export OS_ACCESS_TOKEN_TYPE=

    export OS_DISCOVERY_ENDPOINT=



  The corresponding command-line options look very similar::



    --os-project-name 

    --os-project-domain-name 

    --os-auth-url 

    --os-identity-api-version 3

    --os-auth-plugin openid

    --os-auth-type v3oidcpassword

    --os-username 

    --os-password 

    --os-identity-provider 

    --os-client-id 

    --os-client-secret 

    --os-openid-scope 

    --os-protocol 

    --os-access-token-type 

    --os-discovery-endpoint 



If a password is not provided above (in plaintext), you will be interactively

prompted to provide one securely.