Added a generic sphinx extension to allow text from a file to
be pulled into the documentation in simple table format.
It allows flexibility to be used for other types of
list of heat configuration data in the future.
Change-Id: I96c936df3bc42c385e73a8dc76c0f9a29e17ea3f
Closes-Bug: #1453718
Currently any attempt to substitute placeholders using data from a
json/map or list parameter/attribute results in an error, which is
inconvenient if you wish to provide such data to an instance, e.g
so it can be used in a script via jq/python or whatever.
So, tolerate non-string parameter values, and attempt to serialize
them as json, then substitute the resulting json strings.
Change-Id: I362cc76ac3f68d4649a62459455c0dcae2dcd25d
Closes-Bug: #1489028
Currently any attempt to join json/map or list parameters/attributes
results in an error, which is inconvenient if you wish to join
several paramters/attributes into a single string that may be easily
consumed in an instance (e.g by splitting each element on a delimiter
then using jq or python to process the json).
So, tolerate non-string list items, and attempt to serialize them
as json, then join the resulting json strings.
Partial-Bug: #1489028
Change-Id: I699fa2ec43d173fff1f06887aaa80e3fbac8d668
when we enable ceilometer using plugin model, by default
all ceilometer services are enabled. so I replaced the
lines which will enable services with ceilometer
plugin model
Change-Id: I9a048f970441809d5062a59002c36e5c2ad2c667
Closes-Bug: #1494581
Current url for image is incorrect (doesn't exists),
so change it to correct, which satisfies specified image
in aws loadbalancer hardcoded template.
Change-Id: Ibdb9d421258cc8de866bafda09dc6f56fd29ba34
Closes-bug: #1494603
Aligns the wording with previous summary blocks and highlights the
addition of the str_split function. Also clarifies the new
support for multiple lists for list_join, which is new for liberty.
Change-Id: I3ed8f38e3246ac5407233204deee9569d0ef190f
In the man page for heat-manage db_version command, revision is getting
printed out instead of version. This has been fixed via this commit.
DocImpact Change-Id: I9c89b83eb60011d34c0b473a11f83bd8833d755e
Closes-Bug: #1489250
Change-Id: I6f15836e9a0604d592647363008268437b95b4e6
There is confusing description for network property
of OS::Nova::Server. Clarify this description.
Change-Id: I137ef18afae0527c114f037fe607ddf65513adea
Closes-bug: #1487757
Add to hot_spec doc information about supporting by
get_attr returning dict of all attributes since 2015-10-15.
implements bp get-attr-all-attributes
Change-Id: I7e4a8f80093629ccc66249dc29131e90b17e3f3d
The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover"(dhellman). For the heat
project, since there are so many plugins that need documentation,
we discussed having the initial/parent patch be the enabling
of the extension alone, then following up with individual patches
that add the appropriate documentation to each plugin that requires it.
The next patch in the set will be one of the plugins that needs
documentation, and it will depend on this patch that enables the
extension.
More details in the ML thread at
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html
Change-Id: Id05f80c2221c66ed3e2561983654e19bb253c572
This fixes the existing parameter names and adds missing ones for the
HOT Hello World doc page. It also updates the description of parameters
for the CFN WP Single Instance to match those of the template.
Closes-Bug: #1461515
Change-Id: Ic8ac05c1dcc3f54ec1a88dc391d32ce877931084
Heat resources are now assigned an orchestration id prior to their
instantiation by nova, cinder, et. al. This id is now added to
stack lifecycle scheduler hints. In addition to nova receiving
such hints, cinder is also now supported.
Change-Id: I5a13feb1bdedfbbe44de15e3d9eae72e56ec8a25
Closes-Bug: #1476345
Also, since this is not primarily developer documentation any more,
remove the word 'developer' from the page title.
Change-Id: Ia3fb3aae150f6439bc8c8b0eac71b634dca3d445
Related-Bug: 1488292
It is often helpful to point people at the documentation
for a specific attribute or property. This change achieves
this by using sections instead if definition items to
format the documentation of a property/attribute.
Complex property schemas are indented using block quotes
and the fragment identifier is appended to so that each
link is unique. (eg, #OS::Ceilometer::Alarm-prop-query-*-field)
The 'required' and 'optional' sections have been brought up one
level, replacing 'Properties' with 'Required Properties' and
'Optional Properties'.
Closes-Bug: #1486429
Change-Id: Ifd497aac74e8aff76ea91a295df17bb1da949ba8
2015-04-30 is the latest template version in a stable heat
release, so it should be used for resource reference snippets.
While there is potential for keeping resource.py on the latest
stable using python, this approach just replaces the snippet
string so it can be simply updated at the same time as the rst
files.
Change-Id: I95802fa7a6853d52a7e78f420853ef2a88d6c5e4
This replaces any existing literal blocks containing template snippets
with a yaml highlighted code block, which is more consistent with
newer content.
The resource HOT Syntax generation is also fixed to use yaml syntax
highlighting by setting the rawsource argument
Change-Id: Ie3404420ef70eba6402a4f7171cc56fb5a1f9445
Fix a minor error in one of the sample snippets in the Instances
section of template guide. This will allow a user to copy and
paste and have the template work.
Change-Id: I35a59912fe6a4310c6000edfe2e969f5e8224664
Current resources page description has confusing
lists of properties, user have to search required
and optional properties, and this is unconvenient.
Add grouping by necessity of property: required and
optional.
Change-Id: I9b586faa21b275232bb5b323af4d4e1497d1a79b
Closes-bug: #1486549
Add information that now implementing of handle_delete
is optional, if it's satisfy required format.
Change-Id: I36bf3d8fcd2e15dca8180a6f857056586c89eca9
Fix docs about using SupportStatus for object after
deprecation period. Also, fix several typos and
format mistakes.
Change-Id: I4d26f9977859ff845d7ff561cdd64180f5b848c4
Closes-bug: #1484868
Currently base_attributes_schema omitted in docs,
so there's no chance to learn about base attributes.
This patch adds base_attributes_schema to docs and
fixes description of "show" base attribute.
Change-Id: Id382e39401d368367f1813e7f9e4508d4dffef72
Closes-bug: #1484142
when using ceilometer, ceilometer-anotification service is required
as it does all the processing. it is missing from the setup docs.
Change-Id: I4773f896dab580343ab445ec772c45dfe2f3ef7b
We still have couple places in docs and tests where use old version of
tag 2015.2. This patch replaces it by new tag 5.0.0.
Change-Id: I80ef87035ac002fa41ce7119d1f1b0dc616ba024
Add documentation page with Support Status usage guide.
It contains information about deprecation process and
description how to use SupportStatus class.
bp deprecating-improvements
Change-Id: Iaee7334006997fc154edaddae3d78e617fb2cb82
