Files
python-solumclient/doc/source/cli/index.rst
Nguyen Hai 8e0148d269 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I3ffb5c54f5526a59b01da51e85c73170e4c973f4
2018-03-21 01:46:23 +09:00

31 lines
1.0 KiB
ReStructuredText

===========================
Command-line Tool Reference
===========================
In order to use the CLI, you must provide your OpenStack username,
password, tenant, and auth endpoint. Use the corresponding
configuration options (``--os-username``, ``--os-password``,
``--os-tenant-id``, and ``--os-auth-url``) or set them in environment
variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command line tool will attempt to reauthenticate using your
provided credentials for every request. You can override this behavior
by manually supplying an auth token using ``--os-solum-url`` and
``--os-auth-token``. You can alternatively set these environment
variables::
export OS_SOLUM_URL=http://solum.example.org:9777/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Once you've configured your authentication parameters, you can run
``solum help`` to see a complete listing of available commands.
.. toctree::
solum