Currently the template guide example of return value for reference shows an
arbitrary string, this patch repalces it with an appropriate return.
Change-Id: Iacea741456640e3cd6ce72c6a616c87ae79334bb
Closes-bug: #1226798
- The original heat wadl (heat-api-1.0.wadl) and the samples have now
been deleted from this repo. The wadl has been renamed and migrated
to the following location along with the samples:
https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/
orchestration-api/src/v1/orchestration-api.wadl
- Inserted api-ref/src/wadls/heat-api/src/README.rst file in repo
that specifies the new wadl location.
- Updated pom file to latest version of clouddocs-maven-plugin.
- Currently clouddocs-maven-plugin 1.11.0 has a bug which creates
new sections for the request and response examples for each API
call. This will be fixed in an upcoming release of the plugin.
- Several remarks are inserted in the manual text and marked with
security="writeronly" so they do not appear in the output. You
are welcome to provide any answers and feedback you may have for
these remarks.
- Fix title for commit to resolve H803 build exception.
- Fix extra spaces in file /wadls/heat-api/src/README.rst, and
wrap lines in commit message at less than 70 characters.
Change-Id: I478b394268f64b41317ab77fff6d6366ddd7efa1
We need to use Ceilometer's mongo backend if we want to use
alarms as the sql backend is missing a feature.
Works around bug #1223710
Change-Id: Ib569cfd650ce14480496530e7bbf1b2f71a24c02
F17 CFN links in Getting Started material were no longer valid. The
missing path component (F17) has been added.
As other impacted content is slated for removal this resolves the issue
with the CFN links described in bug #1231310.
Change-Id: I21e1c69aadc4d36b7c3e3e277c01bd80345611b9
Closes-Bug: #1231310
The ubuntu getting started guide has not been maintained, and
most likely no longer works. We should point people to Debian/Ubuntu
docs when they exist, or the devstack getting started guide.
Change-Id: I27a12b5366739ffcad459706c0712882b89abd2f
Closes-Bug: #1182428
Remove all of the old tools/openstack related info from
the on_fedora docs - the best source of documentation for
Fedora is now the RDO docs (for Heat RPM package installs),
or the on_devstack guide for development installs.
Change-Id: Id33d94cc063361698eb87315a56ef7f720ecaa73
Partial-Bug: #1182428
Fix description of outputs section in the HOT specification, and thus make it
consistent with the HOT template guide (which is correct).
Also fix incorrect uses of the native server resource's resource name and
attribute names.
Change-Id: I98643873c370d03619ee7df9c7e09b2cdf3cf08c
Closes-Bug: #1233318
str_replace uses python templates, whereas Fn::Replace uses python
string.replace.
During the original review for Fn::Replace, python templates were
decided against because $ would often need double-escaping in shell scripts.
https://review.openstack.org/#/c/31736/
Having different behaviours between Fn::Replace and str_replace will
add complication for users migrating existing templates to HOT.
Another advantage of using straight string replacement is seen when
the template generates a executable script. In this case it is generally
possible to write a template that can also be executed directly in a
dev/test environment. This would often not be possible if the template
format required placeholders to be prefixed with a $.
Whatever behaviour exists when Havana is release will have to be
supported indefinitely so now is the time to decide if this is going
to be fixed.
Closes-Bug: #1228640
Change-Id: I72879b374a3c61dfe0e4004251ab709d914f2e25
Only refer to heat.conf in the docs and scripts.
For install.sh copy the iniset() function from devstack
to assist in setting some semi-sane defaults.
Change-Id: I933891e35103c003f1272bc89c7b42d2ad76697b
This will document the python api to:
heat.api
heat.engine (not the resources as we have docs for those)
heat.rpc
(copied from ceilometer)
Change-Id: I5a400f72d4ec115fb700ab8b24dbccf0b5cd3200
This is to allow the CloudWatch::Alarm to be implemented as
a resource template. The Dimensions need to be converted
from [{Name: bla, Value: foo}] into a normal dict.
So we define the Dimensions as a CommaDelimitedList in the template,
then in TemplateResource we see that the property is a list of dicts
and convert it into the aws style memberlist
'.member.0.Name=bla,.member.0.Value=green'
then in the CW template we can do the following:
matching_metadata:
"Fn::MemberListToMap": [Name, Value, {"Fn:: Split": [",",
{Ref: Dimensions}]}]
Note: this in not a single case usage as we can use this for the Tags
property that is in a lot of other resources.
Change-Id: I68910c51eaeb0857531028e87b89b9192db4c8ba
This magic new line makes the main index look a lot better.
It wasn't showing the "HOT templates" level.
Change-Id: I3f7fb65911a4b0f3ad57ddf22c00ec8236261c7e
Fix syntax description of get_attr function in HOT specification.
Colon instead of comma was used in array.
Contributes to blueprint hot-specification
Change-Id: I8007d476093ecd5be41020025b486147a5ac038b
This patch adds support for two functions, get_resource and str_replace to HOT
to enable the definition of new HOT samples. Especially str_replace aims to
simplify the definition of scripts in HOT templates.
Change-Id: Ic14fee36bdc0b9c5d79ade7ece5fa1b5331c864a
The new home for these tools is
https://github.com/openstack-dev/heat-cfnclient
These tools are now aimed at heat developers only
and they will not be released or packaged.
Change-Id: I1ea62ef17e81ab53cacb5e4940f0c4e2516ed383
This patch adds initial input for the HOT template guide and the HOT
specification.
Note that content so far is based on features implemented so far and
not forward-looking in any way. Whenever new features get implemented,
the guide and spec will be extended appropriately.
Contributes to blueprint hot-specification
Change-Id: I63d29ab0a1db6703b39f981161063d4fd9f97126
quantumclient is gone upstream and has been replaced by neutronclient.
This patch retains the OS::Quantum::XX namespace
Fixes: bug #1197208
Change-Id: Id48f9598ea1884132d411ad533770ae49494102b
- Switched to definition lists for parameters to be consistent
with generated resource docs
- Make consistent the layout of literal blocks and returns
- Other minor grammatical and layout fixes
Change-Id: I62eb179ce2a20024d2195cc7eb88e2e79bd4ae68
There are separate pages for OpenStack, AWS and Rackspace resources.
Currently the following sources are used for resource type documentation:
- the docstring for the resource class
- properties_schema
- attributes_schema
Change-Id: I901d227e8bc2a7209f216b57653da77a4f500e47
Implements a resourcepages directive which generates resource type
documentation for any type that matches the specified type prefix.
For example:
.. resourcepages:: OS::
Implements blueprint generate-resource-docs
Change-Id: I3b2c94a766686e17e2bdbe8be27657decd65bb3e
updated index.rst to mimic the layout of the keystone docs
updated the structure for troubleshooting
ported howto guides from the heat wiki
ported the troubleshooting page from the heat wiki
updated the nav for the man pages and getting started
added docs for a cfn template and hot template
Change-Id: I14c1b0b6aa6ea3529c4de994851f7a798a3061bf
pbr injects version information as part of the build_sphinx command,
so having it here is overkill.
Change-Id: I1f89e068da3e47b94434cb71db87704f9665dea2
Support "Environment" section in the create/update body.
We the roll up the parameters and the environment and send
that as json using the rpc "params" argument. So no changes
to the rpc layer are needed. The engine knows how to deal
with both formats in the Environments class.
blueprint envirnonments
Change-Id: I6d6085d5c052a5f9115ecd46891b00d2fad4d1db
Update references to the to-be-removed in-tree templates, so
we use raw URLs to the heat-templates repo instead
Change-Id: I2121cedc2bffe1760d845dd2d87d97dd2265f1e9
Replace references to heat-jeos with documentation describing the
use of the new heat-templates/tools/heat-jeos.sh example script
fixes bug #1171602
Change-Id: I88fd2a5667cccd79a77c4a663c782fb537279fac
Load a single api-paste.ini file, specified by config
Delete unused paste.ini files
Update docs for new paste.ini and config arrangement
There will be a corresponding devstack change, and once this is in
I will email the packagers on the packaging implications
Change-Id: Ic10b1a486094d15bfd832f0f934e6268ec323085
Update GettingStarted to drop references to F16/essex and add the
password sed which is required when running grizzly installed via
tools/openstack on Fedora
Change-Id: I08d265e2e2388b54a6aa9f47c4930c32f71f3e93
