Merge "Command object docs: aggregate, console *, keypair"

5 files changed, 283 insertions, 4 deletions

diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst
new file mode 100644
index 00000000..474d811f
--- /dev/null
+++ b/doc/source/command-objects/aggregate.rst
@@ -0,0 +1,150 @@
+=========
+aggregate
+=========
+
+Server aggregates provide a mechanism to group servers according to certain
+criteria.
+
+aggregate add host
+------------------
+
+Add host to aggregate
+
+.. program aggregate add host
+.. code:: bash
+
+    os aggregate add host
+        <aggregate>
+        <host>
+
+.. _aggregate_add_host-aggregate:
+.. describe:: <aggregate>
+
+    Aggregate (name or ID)
+
+.. describe:: <host>
+
+    Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>`
+
+aggregate create
+----------------
+
+Create a new aggregate
+
+.. program aggregate create
+.. code:: bash
+
+    os aggregate create
+        [--zone <availability-zone>]
+        [--property <key=value>]
+        <name>
+
+.. option:: --zone <availability-zone>
+
+    Availability zone name
+
+.. option:: --property <key=value>
+
+    Property to add to this aggregate (repeat option to set multiple properties)
+
+.. describe:: <name>
+
+    New aggregate name
+
+aggregate delete
+----------------
+
+Delete an existing aggregate
+
+.. program aggregate delete
+.. code:: bash
+
+    os aggregate delete
+        <aggregate>
+
+.. describe:: <aggregate>
+
+    Aggregate to delete (name or ID)
+
+aggregate list
+--------------
+
+List all aggregates
+
+.. program aggregate list
+.. code:: bash
+
+    os aggregate list
+        [--long]
+
+.. option:: --long
+
+    List additional fields in output
+
+aggregate remove host
+---------------------
+
+Remove host from aggregate
+
+.. program aggregate remove host
+.. code:: bash
+
+    os aggregate remove host
+        <aggregate>
+        <host>
+
+.. _aggregate_remove_host-aggregate:
+.. describe:: <aggregate>
+
+    Aggregate (name or ID)
+
+.. option:: <host>
+
+    Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`
+
+aggregate set
+-------------
+
+Set aggregate properties
+
+.. program aggregate set
+.. code:: bash
+
+    os aggregate set
+        [--name <new-name>]
+        [--zone <availability-zone>]
+        [--property <key=value>]
+        <aggregate>
+
+.. option:: --name <name>
+
+    Set aggregate name
+
+.. option:: --zone <availability-zone>
+
+    Set availability zone name
+
+.. option:: --property <key=value>
+
+    Property to set on :ref:`\<aggregate\> <aggregate_set-aggregate>`
+    (repeat option to set multiple properties)
+
+.. _aggregate_set-aggregate:
+.. describe:: <aggregate>
+
+    Aggregate to modify (name or ID)
+
+aggregate show
+--------------
+
+Show a specific aggregate
+
+.. program aggregate show
+.. code:: bash
+
+    os aggregate show
+        <aggregate>
+
+.. describe:: <aggregate>
+
+    Aggregate to show (name or ID)
diff --git a/doc/source/command-objects/console-log.rst b/doc/source/command-objects/console-log.rst
new file mode 100644
index 00000000..8e56a073
--- /dev/null
+++ b/doc/source/command-objects/console-log.rst
@@ -0,0 +1,25 @@
+===========
+console log
+===========
+
+Server console text dump
+
+console log show
+----------------
+
+Show server's console output
+
+.. program:: console log show
+.. code:: bash
+
+    os console log show
+        [--lines <num-lines>]
+        <server>
+
+.. option:: --lines <num-lines>
+
+    Number of lines to display from the end of the log (default=all)
+
+.. describe:: <server>
+
+    Server to show log console log (name or ID)
diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst
new file mode 100644
index 00000000..45a0a527
--- /dev/null
+++ b/doc/source/command-objects/console-url.rst
@@ -0,0 +1,33 @@
+===========
+console url
+===========
+
+Server remote console URL
+
+console url show
+----------------
+
+Show server's remote console URL
+
+.. program:: console url show
+.. code:: bash
+
+    os console url show
+        [--novnc | --xvpvnc | --spice]
+        <server>
+
+.. option:: --novnc
+
+    Show noVNC console URL (default)
+
+.. option:: --xvpvnc
+
+    Show xpvnc console URL
+
+.. option:: --spice
+
+    Show SPICE console URL
+
+.. describe:: <server>
+
+    Server to show URL (name or ID)
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
new file mode 100644
index 00000000..9ba0ee8f
--- /dev/null
+++ b/doc/source/command-objects/keypair.rst
@@ -0,0 +1,71 @@
+=======
+keypair
+=======
+
+The badly named keypair is really the public key of an OpenSSH key pair to be
+used for access to created servers.
+
+keypair create
+--------------
+
+Create new public key
+
+.. program keypair create
+.. code:: bash
+
+    os keypair create
+        [--public-key <file>]
+        <name>
+
+.. option:: --public-key <file>
+
+    Filename for public key to add
+
+.. describe:: <name>
+
+    New public key name
+
+keypair delete
+--------------
+
+Delete a public key
+
+.. program keypair delete
+.. code:: bash
+
+    os keypair delete
+        <key>
+
+.. describe:: <key>
+
+    Public key to delete
+
+keypair list
+------------
+
+List public key fingerprints
+
+.. program keypair list
+.. code:: bash
+
+    os keypair list
+
+keypair show
+------------
+
+Show public key details
+
+.. program keypair show
+.. code:: bash
+
+    os keypair show
+        [--public-key]
+        <key>
+
+.. option:: --public-key
+
+    Show only bare public key
+
+.. describe:: <key>
+
+    Public key to show
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 37c62e8e..506fbfc2 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -70,10 +70,10 @@ the API resources will be merged, as in the ``quota`` object that has options
 referring to both Compute and Volume quotas.
 
 * ``access token``: Identity - long-lived OAuth-based token
-* ``aggregate``: Compute - a grouping of servers
+* ``aggregate``: (**Compute**) a grouping of servers
 * ``backup``: Volume - a volume copy
-* ``console log``: Compute - a text dump of a server's console
-* ``console url``: Compute - a URL to a server's remote console
+* ``console log``: (**Compute**) server console text dump
+* ``console url``: (**Compute**) server remote console URL
 * ``consumer``: Identity - OAuth-based delegatee
 * ``container``: Object Store - a grouping of objects
 * ``credential``: Identity - specific to identity providers
@@ -88,7 +88,7 @@ referring to both Compute and Volume quotas.
 * ``image``: Image - a disk image
 * ``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
+* ``keypair``: (**Compute**) an SSH public key
 * ``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