Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Improve documentation based on QA feedback #313

Merged
merged 2 commits into from
Dec 8, 2015
Merged

Improve documentation based on QA feedback #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0ccbaa
Improve documentation based on QA feedback
igable Dec 7, 2015
1f6501e
Fix weird caps in dcm-create-server help
igable Dec 8, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions bin/dcm-create-server
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ import sys
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument(
'--productid', '-p', help="Provider's product ID such as m1.large", required=True)
parser.add_argument('--machineimage', '-m', help='Machine image ID', required=True)
parser.add_argument('--datacenter', '-d', help='Data Center ID', required=True)
parser.add_argument('--description', '-D', help='Description', required=True)
parser.add_argument('--name', '-n', help='Server Name', required=True)
parser.add_argument('--budgetid', '-b', help='Budget ID')
parser.add_argument('--keypair', '-k', help='Keypair Name')
'--productid', '-p', help="provider's product ID such as m1.large", required=True)
parser.add_argument('--machineimage', '-m', help='machine image ID', required=True)
parser.add_argument('--datacenter', '-d', help='data center ID', required=True)
parser.add_argument('--description', '-D', help='description of the server', required=True)
parser.add_argument('--name', '-n', help='name of the server', required=True)
parser.add_argument('--budgetid', '-b', help='budget ID')
parser.add_argument('--keypair', '-k', help='keypair name')
parser.add_argument('--vlan', '-v', help='VLAN, deprecated since DCM k.50 use --network')
parser.add_argument('--network', '-e', help='Network ID')
parser.add_argument('--subnet', '-s', help='Subnet ID')
parser.add_argument('--network', '-e', help='network ID')
parser.add_argument('--subnet', '-s', help='subnet ID')
parser.add_argument('--userdata', '-u',
help='User data that will be added to the metadata '
'inside of the VM. If the value starts with'
Expand Down
2 changes: 1 addition & 1 deletion docs/cli_tools/cli_tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ DCM command line API tools.
dcm-create-billing-code
dcm-create-cm
dcm-create-group
dcm-create-machine-image
dcm-create-network
dcm-create-role
dcm-create-server
Expand Down Expand Up @@ -44,7 +45,6 @@ DCM command line API tools.
dcm-list-servers
dcm-list-server-terminate
dcm-list-snapshots
dcm-list-storage-objects
dcm-list-users
dcm-list-volumes
dcm-pause-server
Expand Down
27 changes: 27 additions & 0 deletions docs/cli_tools/dcm-create-machine-image.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. raw:: latex

\newpage

.. _dcm_create_machine_image:

dcm-create-machine-image
-------------------------------

Creates a machine image from a server.


Syntax
~~~~~~

.. program-output:: dcm-create-machine-image -h

Examples
~~~~~~~~

.. code-block:: bash

dcm-create-machine-image --server 34251 --name production-webserver --group 200 --budget 215 -- description "Production webserver image"




79 changes: 0 additions & 79 deletions docs/cli_tools/dcm-create-server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,85 +19,6 @@ Syntax

.. program-output:: dcm-create-server -h

Options
~~~~~~~

+--------------------+--------------------------------------------------------+
| Option | Description |
+====================+========================================================+
| -p, --productid | Provider's product ID |
| | |
| | Type: String |
| | |
| | Default: None |
| | |
| | Required: Yes |
| | |
| | Example: 'm1.small' |
+--------------------+--------------------------------------------------------+
| -m, --machineimage | Machine image ID |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: Yes |
| | |
+--------------------+--------------------------------------------------------+
| -d, --datacenter | Data center ID |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: Yes |
| | |
+--------------------+--------------------------------------------------------+
| -D, --description | Description of the server |
| | |
| | Type: String |
| | |
| | Default: None |
| | |
| | Required: Yes |
| | |
+--------------------+--------------------------------------------------------+
| -n, --name | Name of the server |
| | |
| | Type: String |
| | |
| | Default: None |
| | |
| | Required: Yes |
| | |
+--------------------+--------------------------------------------------------+
| -b, --budgetid | Budget ID |
| | |
| | Type: Integer |
| | |
| | Default: Default budget code |
| | |
| | Required: No |
| | |
+--------------------+--------------------------------------------------------+
| -k, --keypair | Keypair Name |
| | |
| | Type: String |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
+--------------------+--------------------------------------------------------+
| -v, --vlan | VLAN ID |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
+--------------------+--------------------------------------------------------+

Output
~~~~~~
Expand Down
76 changes: 11 additions & 65 deletions docs/cli_tools/dcm-list-jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,6 @@ Syntax
.. program-output:: dcm-list-jobs -h


Options
~~~~~~~

+--------------------+------------------------------------------------------------+
| Option | Description |
+====================+============================================================+
| -v, --verbose | Print out verbose information while listing jobs |
+--------------------+------------------------------------------------------------+

Common Options
~~~~~~~~~~~~~~

Deprecated Options
^^^^^^^^^^^^^^^^^^

None

Output
~~~~~~

The output from this command is a list of DCM jobs when no argument is passed,
or if a job ID is passed, the return message from the job is provided.

Examples
~~~~~~~~

Expand All @@ -58,14 +35,12 @@ Output

.. code-block:: bash

+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+
| Job ID | Description | Status | Start Date | End Date | Message |
+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+
| 901 | Terminate 1005 | COMPLETE | 2014-05-22T19:37:41.926+0000 | 2014-05-22T19:38:36.424+0000 | None |
| 902 | Add Firewall Rule 0.0.0.0/0 | COMPLETE | 2014-05-22T19:38:20.903+0000 | 2014-05-22T19:38:36.422+0000 | ID: 800 Time: 15 seconds |
| 900 | Terminate 1006 | RUNNING | 2014-05-22T19:37:35.843+0000 | None | None |
| 903 | Launch Server Test | RUNNING | 2014-05-22T19:38:41.982+0000 | None | None |
+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+
+--------+----------------------------------+----------+------------------------------+------------------------------+---------------------------------+
| ID | Type | Customer | Name | Endpoint | Status |
+--------+----------------------------------+----------+------------------------------+------------------------------+---------------------------------+
| 810977 | Create Volume igable-deleteme-11 | RUNNING | 2015-12-07T19:18:55.136+0000 | 2015-12-07T19:20:56.542+0000 | Checking provider volume status |
| 810976 | Create Volume igable-deleteme-10 | COMPLETE | 2015-12-07T19:17:13.338+0000 | 2015-12-07T19:18:59.810+0000 | 127703 |
+--------+----------------------------------+----------+------------------------------+------------------------------+---------------------------------+

Example 2
^^^^^^^^^
Expand All @@ -77,40 +52,11 @@ Example 2
Output
%%%%%%

.. code-block:: json

ID: 800 Time: 15 seconds

Example 3
^^^^^^^^^

.. code-block:: bash

dcm-list-jobs

Output
%%%%%%

.. code-block:: bash

+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+
| Job ID | Description | Status | Start Date | End Date | Message |
+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+
| 903 | Launch Server Test | COMPLETE | 2014-05-22T19:38:41.982+0000 | 2014-05-22T19:40:00.430+0000 | 1100 |
| 904 | CREATE VOLUME | RUNNING | 2014-05-22T19:41:11.917+0000 | None | None |
| 905 | Create Image cirros-image | RUNNING | 2014-05-22T19:42:09.985+0000 | None | Bundling Image |
+--------+-----------------------------+----------+------------------------------+------------------------------+----------------------------+

Example 4
^^^^^^^^^

.. code-block:: bash

dcm-list-jobs -j 905

Output
%%%%%%

.. code-block:: bash
+--------+----------------------------------+----------+------------------------------+------------------------------+--------+
| ID | Type | Customer | Name | Endpoint | Status |
+--------+----------------------------------+----------+------------------------------+------------------------------+--------+
| 810976 | Create Volume igable-deleteme-10 | COMPLETE | 2015-12-07T19:17:13.338+0000 | 2015-12-07T19:18:59.810+0000 | 127703 |
+--------+----------------------------------+----------+------------------------------+------------------------------+--------+

Bundling Image
81 changes: 0 additions & 81 deletions docs/cli_tools/dcm-list-snapshots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,87 +19,6 @@ Syntax

.. program-output:: dcm-list-snapshots -h

Options
~~~~~~~

+--------------------+------------------------------------------------------------+
| Option | Description |
+====================+============================================================+
| -r, --regionid | Region ID. |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: Yes (if regionpid/all was not specified) |
| | |
| | Example: 201 |
+--------------------+------------------------------------------------------------+
| -R, --regionpid | Region provider ID. |
| | |
| | Type: Str |
| | |
| | Default: None |
| | |
| | Required: Yes (if regionid/all was not specified) |
| | |
| | Example: us-west-1 |
+--------------------+------------------------------------------------------------+
| -a, --all | List all firewalls. |
+--------------------+------------------------------------------------------------+
| -g, --groupid | Owning group's group ID. |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
| | Example: 102 |
+--------------------+------------------------------------------------------------+
| -G, --groupname | Owning group's group name. |
| | |
| | Type: Str |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
| | Example: admin |
+--------------------+------------------------------------------------------------+
| -b, --budgetid | Budget ID. |
| | |
| | Type: Integer |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
| | Example: 301 |
+--------------------+------------------------------------------------------------+
| -B, --budgetname | Budget Name. |
| | |
| | Type: Str |
| | |
| | Default: None |
| | |
| | Required: No |
| | |
| | Example: DEF |
+--------------------+------------------------------------------------------------+
| -v, --verbose | Produce verbose output |
+--------------------+------------------------------------------------------------+

Common Options
~~~~~~~~~~~~~~

Deprecated Options
~~~~~~~~~~~~~~~~~~

None

Output
~~~~~~

The return value from this command is a list of snapshots.

Expand Down
Loading