openstack/senlin
Code Issues Proposed changes

Refresh user guide

Browse Source 
Change-Id: Ia9567d0fbe84a82c8bb19dce9485323a30977198
This commit is contained in:
liyi 2017-07-25 16:13:30 +08:00
parent 0a01df361e
commit d713b797de
4 changed files with 61 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/user/actions.rst
View File

@ -157,6 +157,7 @@ An example is shown below::
| created_at | 2016-09-23T09:00:25Z |
| depended_by | [] |
| depends_on | [] |
| domain_id | None |
| end_at | 1450683904.0 |
| id | 8fac487f-861a-449e-9678-478133bea8de |
| inputs | {} |

36
doc/source/user/clusters.rst
View File

@ -89,12 +89,12 @@ can be used for this purpose. For example, the following command filters the
clusters by the ``status`` field::
$ openstack cluster list --filters status=ACTIVE
+----------+------+--------+---------------------+
| id | name | status | created_at |
+----------+------+--------+---------------------+
| 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28 |
| 092d0955 | c2 | ACTIVE | 2015-05-05T13:27:48 |
+----------+------+--------+---------------------+
+----------+------+--------+----------------------+------------+
| id | name | status | created_at | updated_at |
+----------+------+--------+----------------------+------------+
| 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28Z | None |
| 092d0955 | c2 | ACTIVE | 2015-05-05T13:27:48Z | None |
+----------+------+--------+----------------------+------------+
The option :option:`--filters` accepts a list of key-value pairs separated by
semicolon (``;``), where each key-value pair is expected to be of format
@ -110,11 +110,11 @@ clusters returned from Senlin server each time, using the option
:option:`--limit <LIMIT>`. For example::
$ openstack cluster list --limit 1
+----------+------+--------+---------------------+
| id | name | status | created_at |
+----------+------+--------+---------------------+
| 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28 |
+----------+------+--------+---------------------+
+----------+------+--------+----------------------+------------+
| id | name | status | created_at | updated_at |
+----------+------+--------+----------------------+------------+
| 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28Z | None |
+----------+------+--------+----------------------+------------+
Another option you can specify is the ID of a cluster after which you want to
see the returned list starts. In other words, you don't want to see those
@ -123,11 +123,11 @@ option :option:`--marker <ID>` for this purpose. For example::
$ openstack cluster list --limit 1 \
--marker 2959122e-11c7-4e82-b12f-f49dc5dac270
+----------+------+--------+---------------------+
| id | name | status | created_at |
+----------+------+--------+---------------------+
| 092d0955 | c2 | ACTIVE | 2015-05-05T13:27:48 |
+----------+------+--------+---------------------+
+----------+------+--------+----------------------+------------+
| id | name | status | created_at | updated_at |
+----------+------+--------+----------------------+------------+
| 092d0955 | c2 | ACTIVE | 2015-05-05T13:27:48Z | None |
+----------+------+--------+----------------------+------------+
Only 1 cluster record is returned in this example and its UUID comes after the
one specified from the command line.
@ -143,6 +143,7 @@ associated with the cluster. For example::
+------------------+--------------------------------------+
| Property | Value |
+------------------+--------------------------------------+
| config | {} |
| created_at | None |
| data | {} |
| dependents | {} |
@ -150,7 +151,6 @@ associated with the cluster. For example::
| domain_id | None |
| id | 60424eb3-6adf-4fc3-b9a1-4a035bf171ac |
| init_at | 2015-05-05T13:35:47Z |
| is_profile_only | None |
| location | None |
| max_size | -1 |
| metadata | {} |
@ -237,6 +237,7 @@ An example is shown below::
+------------------+--------------------------------------+
| Field | Value |
+------------------+--------------------------------------+
| config | {} |
| created_at | 2015-07-07T03:30:53Z |
| data | {} |
| dependents | {} |
@ -244,7 +245,6 @@ An example is shown below::
| domain_id | None |
| id | 2b7e9294-b5cd-470f-b191-b18f7e672495 |
| init_at | 2015-05-07T03:30:52Z |
| is_profile_only | None |
| location | None |
| max_size | -1 |
| metadata | {} |

31
doc/source/user/policy_types.rst
View File

@ -60,18 +60,19 @@ Senlin server comes with some built-in policy types. You can check the list
of policy types using the following command::
$ openstack cluster policy type list
+------------------------------------+
| name |
+------------------------------------+
| senlin.policy.affinity-1.0 |
| senlin.policy.batch-1.0 |
| senlin.policy.deletion-1.0 |
| senlin.policy.health-1.0 |
| senlin.policy.loadbalance-1.1 |
| senlin.policy.region_placement-1.0 |
| senlin.policy.scaling-1.0 |
| senlin.policy.zone_placement-1.0 |
+------------------------------------+
+--------------------------------+---------+----------------------------+
| name | version | support_status |
+--------------------------------+---------+----------------------------+
| senlin.policy.affinity | 1.0 | SUPPORTED since 2016.10 |
| senlin.policy.batch | 1.0 | EXPERIMENTAL since 2017.02 |
| senlin.policy.deletion | 1.0 | SUPPORTED since 2016.04 |
| senlin.policy.health | 1.0 | EXPERIMENTAL since 2017.02 |
| senlin.policy.loadbalance | 1.0 | SUPPORTED since 2016.04 |
| senlin.policy.region_placement | 1.0 | EXPERIMENTAL since 2016.04 |
| | | SUPPORTED since 2016.10 |
| senlin.policy.zone_placement | 1.0 | EXPERIMENTAL since 2016.04 |
| | | SUPPORTED since 2016.10 |
+--------------------------------+---------+----------------------------+
The output is a list of policy types supported by the Senlin server.
@ -86,6 +87,12 @@ show the schema of a specific policy type along with other properties, you can
use the following command::
$ openstack cluster policy type show senlin.policy.deletion-1.0
support_status:
'1.0':
- since: '2016.04'
status: SUPPORTED
id: senlin.policy.deletion-1.0
location: null
name: senlin.policy.deletion
schema:
criteria:

30
doc/source/user/profile_types.rst
View File

@ -78,13 +78,13 @@ Senlin server comes with some built-in profile types. You can check the list
of profile types using the following command::
$ openstack cluster profile type list
+--------------------------------+
| name |
+--------------------------------+
| container.dockerinc.docker-1.0 |
| os.heat.stack-1.0 |
| os.nova.server-1.0 |
+--------------------------------+
+----------------------------+---------+----------------------------+
| name | version | support_status |
+----------------------------+---------+----------------------------+
| container.dockerinc.docker | 1.0 | EXPERIMENTAL since 2017.02 |
| os.heat.stack | 1.0 | SUPPORTED since 2016.04 |
| os.nova.server | 1.0 | SUPPORTED since 2016.04 |
+----------------------------+---------+----------------------------+
The output is a list of profile types supported by the Senlin server.
@ -98,6 +98,12 @@ show the schema of a specific profile type along with other properties, you
can use the following command::
$ openstack cluster profile type show os.heat.stack-1.0
support_status:
'1.0':
- since: '2016.04'
status: SUPPORTED
id: os.heat.stack-1.0
location: null
name: os.heat.stack
schema:
context:
@ -137,6 +143,14 @@ format by specifying the :option:`-f json` option as exemplified below::
$ openstack cluster profile type show -f json os.heat.stack-1.0
{
"support_status": {
"1.0": [
{
"status": "SUPPORTED",
"since": "2016.04"
}
]
},
"name": "os.heat.stack",
"schema": {
"files": {
@ -155,6 +169,8 @@ format by specifying the :option:`-f json` option as exemplified below::
"updatable": false
}
},
"id": "os.heat.stack-1.0",
"location": null
}