blob: 7675d6c379470b6151a298a86f066295bf259091 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
===============
OpenStackClient
===============
OpenStackClient (aka OSC) is a command-line client for OpenStack that
brings the command set for Compute, Identity, Image, Object Storage and
Block Storage APIs together in a single shell with a uniform command
structure.
Using OpenStackClient
---------------------
.. toctree::
:maxdepth: 2
cli/index
configuration/index
Getting Started
---------------
* Try :ref:`some commands <command-list>`
* Read the source `on OpenStack's Git server`_
* Install OpenStackClient from `PyPi`_ or a `tarball`_
Release Notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <https://docs.openstack.org/releasenotes/python-openstackclient/>
Contributor Documentation
-------------------------
.. toctree::
:maxdepth: 2
contributor/index
Project Goals
-------------
* Use the OpenStack Python API libraries, extending or replacing them as required
* Use a consistent naming and structure for commands and arguments
* Provide consistent output formats with optional machine parseable formats
* Use a single-binary approach that also contains an embedded shell that can execute
multiple commands on a single authentication (see libvirt's virsh for an example)
* Independence from the OpenStack project names; only API names are referenced (to
the extent possible)
Contributing
============
OpenStackClient utilizes all of the usual OpenStack processes and requirements for
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
may be submitted to the :code:`python-openstackclient` `Storyboard project`_.
Code may be submitted to the :code:`openstack/python-openstackclient` project
using `Gerrit`_. Developers may also be found in the `IRC channel`_
``#openstack-sdks``.
.. _`on OpenStack's Git server`: https://opendev.org/openstack/python-openstackclient/
.. _`Storyboard project`: https://storyboard.openstack.org/#!/project/openstack/python-openstackclient
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _Bug reports: https://storyboard.openstack.org/#!/project/975
.. _PyPi: https://pypi.org/project/python-openstackclient
.. _tarball: http://tarballs.openstack.org/python-openstackclient
.. _IRC channel: https://wiki.openstack.org/wiki/IRC
Indices and Tables
==================
* :ref:`genindex`
* :ref:`search`
|
