diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/availability_zone.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/domain.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/ec2-credentials.rst | 98 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 105 | ||||
| -rw-r--r-- | doc/source/command-objects/region.rst | 68 | ||||
| -rw-r--r-- | doc/source/command-objects/server-image.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/usage.rst | 50 |
7 files changed, 328 insertions, 31 deletions
diff --git a/doc/source/command-objects/availability_zone.rst b/doc/source/command-objects/availability_zone.rst new file mode 100644 index 00000000..37435230 --- /dev/null +++ b/doc/source/command-objects/availability_zone.rst @@ -0,0 +1,20 @@ +================= +availability zone +================= + +Compute v2 + +availability zone list +---------------------- + +List availability zones and their status + +.. program availability zone list +.. code:: bash + + os availability zone list + [--long] + +.. option:: --long + + List additional fields in output diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 057296ac..66697ac3 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -36,7 +36,7 @@ Create new domain If the domain already exists, return the existing domain data and do not fail. -.. option:: <domain-name> +.. describe:: <domain-name> New domain name @@ -51,7 +51,7 @@ Delete domain os domain delete <domain> -.. option:: <domain> +.. describe:: <domain> Domain to delete (name or ID) @@ -95,7 +95,7 @@ Set domain properties Disable domain -.. option:: <domain> +.. describe:: <domain> Domain to modify (name or ID) @@ -110,6 +110,6 @@ Show domain details os domain show <domain> -.. option:: <domain> +.. describe:: <domain> Domain to display (name or ID) diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst new file mode 100644 index 00000000..a5b67549 --- /dev/null +++ b/doc/source/command-objects/ec2-credentials.rst @@ -0,0 +1,98 @@ +=============== +ec2 credentials +=============== + +Identity v2 + +ec2 credentials create +---------------------- + +Create EC2 credentials + +.. program:: ec2 credentials create +.. code-block:: bash + + os ec2 credentials create + [--project <project>] + [--user <user>] + +.. option:: --project <project> + + Specify an alternate project (default: current authenticated project) + +.. option:: --user <user> + + Specify an alternate user (default: current authenticated user) + +The :option:`--project` and :option:`--user` options are typically only +useful for admin users, but may be allowed for other users depending on +the policy of the cloud and the roles granted to the user. + +ec2 credentials delete +---------------------- + +Delete EC2 credentials + +.. program:: ec2 credentials delete +.. code-block:: bash + + os ec2 credentials delete + [--user <user>] + <access-key> + +.. option:: --user <user> + + Specify a user + +.. _ec2_credentials_delete-access-key: +.. describe:: access-key + + Credentials access key + +The :option:`--user` option is typically only useful for admin users, but +may be allowed for other users depending on the policy of the cloud and +the roles granted to the user. + +ec2 credentials list +-------------------- + +List EC2 credentials + +.. program:: ec2 credentials list +.. code-block:: bash + + os ec2 credentials list + [--user <user>] + +.. option:: --user <user> + + Filter list by <user> + +The :option:`--user` option is typically only useful for admin users, but +may be allowed for other users depending on the policy of the cloud and +the roles granted to the user. + +ec2 credentials show +-------------------- + +Display EC2 credentials details + +.. program:: ec2 credentials show +.. code-block:: bash + + os ec2 credentials show + [--user <user>] + <access-key> + +.. option:: --user <user> + + Specify a user + +.. _ec2_credentials_show-access-key: +.. describe:: access-key + + Credentials access key + +The :option:`--user` option is typically only useful for admin users, but +may be allowed for other users depending on the policy of the cloud and +the roles granted to the user. diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst new file mode 100644 index 00000000..4c98e858 --- /dev/null +++ b/doc/source/command-objects/flavor.rst @@ -0,0 +1,105 @@ +====== +flavor +====== + +flavor create +------------- + +Create new flavor + +.. program:: flavor create +.. code:: bash + + os flavor create + [--id <id>] + [--ram <size-mb>] + [--disk <size-gb>] + [--ephemeral-disk <size-gb>] + [--swap <size-mb>] + [--vcpus <num-cpu>] + [--rxtx-factor <factor>] + [--public | --private] + <flavor-name> + +.. option:: --id <id> + + Unique flavor ID; 'auto' creates a UUID (default: auto) + +.. option:: --ram <size-mb> + + Memory size in MB (default 256M) + +.. option:: --disk <size-gb> + + Disk size in GB (default 0G) + +.. option:: --ephemeral-disk <size-gb> + + Ephemeral disk size in GB (default 0G) + +.. option:: --swap <size-gb> + + Swap space size in GB (default 0G) + +.. option:: --vcpus <num-cpu> + + Number of vcpus (default 1) + +.. option:: --rxtx-factor <factor> + + RX/TX factor (default 1) + +.. option:: --public + + Flavor is available to other projects (default) + +.. option:: --private + + Flavor is not available to other projects + +.. _flavor_create-flavor-name: +.. describe:: <flavor-name> + + New flavor name + +flavor delete +------------- + +Delete a flavor + +.. program:: flavor delete +.. code:: bash + + os flavor delete + <flavor> + +.. _flavor_delete-flavor: +.. describe:: <flavor> + + Flavor to delete (name or ID) + +flavor list +----------- + +List flavors + +.. program:: flavor list +.. code:: bash + + os flavor list + +flavor show +----------- + +Display flavor details + +.. program:: flavor show +.. code:: bash + + os flavor show + <flavor> + +.. _flavor_show-flavor: +.. describe:: <flavor> + + Flavor to display (name or ID) diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index 788ed6fa..d1aedb31 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -9,24 +9,30 @@ region create Create new region +.. program:: region create .. code:: bash os region create [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] + [--description <description>] + [--url <url>] <region-id> -:option:`--parent-region` <region-id> - Parent region +.. option:: --parent-region <region-id> + + Parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region-id>` +.. _region_create-region-id: +.. describe:: <region-id> + New region ID region delete @@ -34,61 +40,75 @@ region delete Delete region +.. program:: region delete .. code:: bash os region delete - <region> + <region-id> + +.. _region_delete-region-id: +.. describe:: <region-id> -:option:`<region>` - Region to delete + Region ID to delete region list ----------- List regions +.. program:: region list .. code:: bash os region list [--parent-region <region-id>] -:option:`--parent-region` <region-id> - Filter by a specific parent region +.. option:: --parent-region <region-id> + + Filter by parent region ID region set ---------- Set region properties +.. program:: region set .. code:: bash os region set [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] - <region> + [--description <description>] + [--url <url>] + <region-id> -:option:`--parent-region` <region-id> - New parent region +.. option:: --parent-region <region-id> + + New parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region>` +.. _region_set-region-id: +.. describe:: <region-id> + Region ID to modify region show ----------- -Show region +Display region details +.. program:: region show .. code:: bash os region show - <region> + <region-id> -:option:`<region>` - Region ID to modify +.. _region_show-region-id: +.. describe:: <region-id> + + Region ID to display diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index 681f6e4f..4577b25b 100644 --- a/doc/source/command-objects/server-image.rst +++ b/doc/source/command-objects/server-image.rst @@ -10,6 +10,7 @@ server image create Create a new disk image from a running server +.. program:: server image create .. code:: bash os server image create @@ -17,11 +18,14 @@ Create a new disk image from a running server [--wait] <server> -:option:`--name` <image-name> +.. option:: --name <image-name> + Name of new image (default is server name) -:option:`--wait` +.. option:: --wait + Wait for image create to complete -:option:`<server>` +.. describe:: <server> + Server (name or ID) diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst new file mode 100644 index 00000000..551176c7 --- /dev/null +++ b/doc/source/command-objects/usage.rst @@ -0,0 +1,50 @@ +===== +usage +===== + +Compute v2 + +usage list +---------- + +List resource usage per project + +.. program:: usage list +.. code:: bash + + os usage list + --start <start> + --end <end> + +.. option:: --start <start> + + Usage range start date, ex 2012-01-20 (default: 4 weeks ago). + +.. option:: --end <end> + + Usage range end date, ex 2012-01-20 (default: tomorrow) + +usage show +---------- + +Show resource usage for a single project. + +.. program:: usage show +.. code:: bash + + os usage show + --project <project> + --start <start> + --end <end> + +.. option:: --project <project> + + Name or ID of project to show usage for. + +.. option:: --start <start> + + Usage range start date, ex 2012-01-20 (default: 4 weeks ago). + +.. option:: --end <end> + + Usage range end date, ex 2012-01-20 (default: tomorrow) |