openstack/openstack-manuals
Code Issues Proposed changes

Clarifying missed importance of attrs in hot-spec

Browse Source 
Following the discussion in commit
I27f3a732480a851fd2eceb83e5fcc850ee59bb73, description
of some attributes (such as type in Resources section or
value in Outputs section) gives unclear answer, which
attribute is required and which is optional.

Change-Id: Ie6e207e427a577d46acb731cee495834faecd90d
Partial-bug: #1386242
This commit is contained in:
Peter Razumovsky 2014-10-29 18:39:49 +03:00
parent 77b9dd9543
commit 7bc10a5577
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/hot-guide/source/hot_spec.rst
View File

@ -148,6 +148,8 @@ type
are ``string``, ``number``, ``comma_delimited_list``, ``json`` and are ``string``, ``number``, ``comma_delimited_list``, ``json`` and
``boolean``. ``boolean``.
This attribute is required.
label label
A human readable name for the parameter. A human readable name for the parameter.
@ -433,6 +435,8 @@ resource ID
type type
The resource type, such as ``OS::Nova::Server`` or ``OS::Neutron::Port``. The resource type, such as ``OS::Nova::Server`` or ``OS::Neutron::Port``.
This attribute is required.
properties properties
A list of resource-specific properties. The property value can be provided A list of resource-specific properties. The property value can be provided
in place, or via a function (see :ref:`hot_spec_intrinsic_functions`). in place, or via a function (see :ref:`hot_spec_intrinsic_functions`).
@ -551,11 +555,15 @@ parameter name
description description
A short description of the output parameter. A short description of the output parameter.
This attribute is optional.
parameter value parameter value
The value of the output parameter. This value is usually resolved by means The value of the output parameter. This value is usually resolved by means
of a function. See :ref:`hot_spec_intrinsic_functions` for details about of a function. See :ref:`hot_spec_intrinsic_functions` for details about
the functions. the functions.
This attribute is required.
The example below shows how the IP address of a compute resource can The example below shows how the IP address of a compute resource can
be defined as an output parameter: be defined as an output parameter: