From 7bc10a557740bb46aa317707afedce4e5452607d Mon Sep 17 00:00:00 2001 From: Peter Razumovsky Date: Wed, 29 Oct 2014 18:39:49 +0300 Subject: [PATCH] Clarifying missed importance of attrs in hot-spec 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 --- doc/hot-guide/source/hot_spec.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/hot-guide/source/hot_spec.rst b/doc/hot-guide/source/hot_spec.rst index 3b1bd9d8c8..aa874f5e16 100644 --- a/doc/hot-guide/source/hot_spec.rst +++ b/doc/hot-guide/source/hot_spec.rst @@ -148,6 +148,8 @@ type are ``string``, ``number``, ``comma_delimited_list``, ``json`` and ``boolean``. + This attribute is required. + label A human readable name for the parameter. @@ -433,6 +435,8 @@ resource ID type The resource type, such as ``OS::Nova::Server`` or ``OS::Neutron::Port``. + This attribute is required. + properties A list of resource-specific properties. The property value can be provided in place, or via a function (see :ref:`hot_spec_intrinsic_functions`). @@ -551,11 +555,15 @@ parameter name description A short description of the output parameter. + This attribute is optional. + parameter value 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 the functions. + This attribute is required. + The example below shows how the IP address of a compute resource can be defined as an output parameter: