diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2014-11-17 16:42:30 -0600 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2014-11-19 14:47:53 -0600 |
| commit | 254910d3ce34c954551a0827aa8727d6367f48f3 (patch) | |
| tree | 4e88edc9f7c7fc63bd6e68725da797c5f3f64e55 /doc/source/commands.rst | |
| parent | ae00019c646fc4a2c74bbf2d024e31aaccaa545b (diff) | |
| download | python-openstackclient-254910d3ce34c954551a0827aa8727d6367f48f3.tar.gz | |
Begin copying wiki command list here
* Sort by command objects
* Drop the comparison to the project CLIs
* Minor updates to command help to match docs
Initially include the cross-API commands to establish the structure and format.
Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b
Diffstat (limited to 'doc/source/commands.rst')
| -rw-r--r-- | doc/source/commands.rst | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 8857f3d5..37c62e8e 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -1,8 +1,4 @@ -======== -Commands -======== - - +================= Command Structure ================= @@ -83,7 +79,7 @@ referring to both Compute and Volume quotas. * ``credential``: Identity - specific to identity providers * ``domain``: Identity - a grouping of projects * ``endpoint``: Identity - the base URL used to contact a specific service -* ``extension``: Compute, Identity, Volume - additional APIs available +* ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions * ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc * ``group``: Identity - a grouping of users * ``host``: Compute - the physical computer running a hypervisor @@ -93,13 +89,13 @@ referring to both Compute and Volume quotas. * ``ip fixed``: Compute, Network - an internal IP address assigned to a server * ``ip floating``: Compute, Network - a public IP address that can be mapped to a server * ``keypair``: Compute - an SSH public key -* ``limits``: Compute, Volume - resource usage limits +* ``limits``: (**Compute**, **Volume**) resource usage limits * ``module``: internal - installed Python modules in the OSC process * ``network``: Network - a virtual network for connecting servers and other resources * ``object``: Object Store - a single file in the Object Store * ``policy``: Identity - determines authorization * ``project``: Identity - the owner of a group of resources -* ``quota``: Compute, Volume - limit on resource usage +* ``quota``: (**Compute**, **Volume**) resource usage restrictions * ``request token``: Identity - temporary OAuth-based token * ``role``: Identity - a policy object used to determine authorization * ``security group``: Compute, Network - groups of network access rules @@ -149,7 +145,7 @@ Those actions with an opposite action are noted in parens if applicable. Implementation -============== +-------------- The command structure is designed to support seamless addition of plugin command modules via ``setuptools`` entry points. The plugin commands must |