196 Commits

Author SHA1 Message Date
Ethan Lynn
6d0cd62172 Switch heat resources & db & tests to oslo.i18n
Use oslo.i18n in resources & db & tests directories.

blueprint oslo-i18n

Change-Id: Idaf718b9d762b9ae89d6045557eadb758b552bd5
2014-09-17 14:28:56 +08:00
Ryan Brown
d73022561b Add heat-keystone-setup-domain to sphinx conf.py
The man page for heat-keystone-setup-domain was not being generated
because it was not included in the sphinx conf.py.

Change-Id: Ic1c2025fc7f61e3c37906b42bd84e1df893920fc
2014-09-11 10:56:16 -04:00
Jenkins
d7e91a1bc3 Merge "Doc: don't generate empty properties fields" 2014-09-02 17:34:42 +00:00
Gauvain Pocentek
0e374945c4 Doc: don't generate empty properties fields
Don't create empty properties fields in the resources samples.

This patch will help resolve niceness gates failures when generating the
docbook HOT reference.

Change-Id: I3c74fa583ac55dc0a23520ec07f5d07e3d1b6fab
Closes-Bug: #1360558
2014-08-29 08:59:27 +02:00
Jeff Peeler
69c662ac24 Rename docker directory to heat_docker
This directory was renamed in 4e8231, which made importing docker
(that is docker-py) difficult if not impossible in Python 2.x. So
rename it to something other than 'docker' to avoid that problem.

(setup.cfg has been modified with the new path)

Change-Id: I3cbb7c5d4b53f70e1dc6102881f8e05852341a9a
Related-bug: #1296758
2014-08-28 23:42:24 -04:00
Jenkins
1f70d9d8cb Merge "Add language attribute to code samples" 2014-08-28 18:35:14 +00:00
Jenkins
531e95a6cc Merge "Edits on template_guide/functions.rst" 2014-08-25 12:50:06 +00:00
Andreas Jaeger
bd253a34ed Edits on template_guide/functions.rst
Edits for consistency:
* Fix spelling and capitalization
* Add missing "."
* Use same layout for "Returns"

Change-Id: Ieb2effc1f45fb261f45775be9664ea93b04c8e98
2014-08-24 13:43:23 +02:00
Jenkins
1073eed7f7 Merge "Man page for heat-keystone-setup-domain" 2014-08-23 16:41:50 +00:00
Gauvain Pocentek
28231c1b18 Add language attribute to code samples
Create the literal_block nodes with a 'language' attribute to add syntax
highlighting in the generated documentation.

This change is not visible in the HTML output, but is used when the
generated XML is imported in the openstack-manuals hot-reference book
(WIP).

The 'hot' language is not currently supported in sphinx or in the
manuals, but it doesn't hurt to have it and it could be implemented
later.

Change-Id: Ie5d4ab31665da812ccd7ec1232d3858786170477
Implements: blueprint heat-templates
Closes-Bug: #1360559
2014-08-23 10:28:05 +02:00
Jenkins
d6f3aeb9c9 Merge "Fix typos in comments and help strings" 2014-08-14 11:54:08 +00:00
Steve Baker
0eb93cbf33 Use setuptools to install contrib plugins
This change creates a pbr setup.cfg and specifies a data_files
entry to install the contrib plugin source into the /usr/lib/heat
plugin directory.

This change also temporarily disables docs building for contrib
resoures until the transition to stevedore is fully complete.

Change-Id: I1c91aee20f72dc2a5a049e67de1d6d7cbabda241
2014-08-13 20:12:29 -05:00
Jenkins
5e64c52c55 Merge "Amend docs with immutable property attribute." 2014-08-13 17:33:26 +00:00
aivanitskiy
9ed313a8be Fix typos in comments and help strings
Change-Id: I68446dd652186191d19551032a634aee03f9e637
2014-08-13 13:54:24 +04:00
tengqm
132e1f348c Man page for heat-keystone-setup-domain
This patch adds a man page to the 'heat-keystone-setup-domain' utility.

Change-Id: I8f92b1296ab1f61039214d7fde4f7a2a236e8893
Closes-Bug: 1326483
2014-08-13 17:17:30 +08:00
Jenkins
54d20e633d Merge "Fix dead link in cfn template doc" 2014-08-11 23:27:55 +00:00
Jenkins
380cac6eae Merge "Parse RST in plug-in class docs" 2014-08-08 20:23:43 +00:00
Pavlo Shchelokovskyy
7d1cf3d680 Amend docs with immutable property attribute.
Include warning about updates not being supported for a propety
based on its `immutable` value being True.

Change-Id: I10fe495a2a35429b3d6e254c23ae91732e2e4dd8
Implements: blueprint implement-aws-updates-not-supported
2014-08-08 16:12:06 +03:00
Chris Buccella
0891d19a9d Fix dead link in cfn template doc
The link referenced in templates/cfn/WordPress_Single_Instance
is dead. Looks like the directory was restructured. Updated using
a like for the F18 version of the template.

Change-Id: I46705cd31e2be6f3f131c64944665eabe6347dc9
2014-08-06 16:30:33 -04:00
Jenkins
7a34e8cf9c Merge "Correct example syntax and whitespace" 2014-08-04 08:45:48 +00:00
Jenkins
211c9cb96a Merge "Added reference to the Nova Flavor documentation." 2014-08-02 05:02:08 +00:00
igor
82af86be8b Correct example syntax and whitespace
Corrects some examples and remove trailing whitespace in
the Heat Resource Plug-in Development Guide
page (pluginguide.html)

Closes-Bug: 1350503

Change-Id: I34b142e950b9a4588b415d44274732d835cfd8f4
2014-07-31 19:28:26 +01:00
Randall Burt
6367aab293 Parse RST in plug-in class docs
In order to make the generated documentation for resource plug-ins more
readable, parse the class comments as RST and append to the section.

Change-Id: Icb37344c64c21bcac536e8f2916b102eb9754851
2014-07-29 21:39:45 +00:00
Ryan Brown
6eab982dad Remove rst2script.sed and integration.sh
rst2script.sed was referenced in the Fedora getting started
documentation, but the recommended way to use Heat/Openstack
on Fedora is now to use RDO/packstack.

Also removes the reference to rst2script.sed in the
getting_started/on_fedora documentation.

Also removes obsolete integration.sh script.

Partial-Bug: 1338066

Change-Id: I7f2b0d84ccef324ccb8e32ca4c6d90f9a3f2dda3
2014-07-25 12:40:36 -04:00
Zane Bitter
c26cf90325 Create a new revision of HOT for Juno
The next revision of HOT, dated 2014-10-16 to coincide with the Juno
release date, will support the list_join function and remove support for
the CFN-style functions. There may also be other changes throughout the
Juno development cycle.

Change-Id: I20d9586201806ac34e303689660ff565cb9f2b5c
2014-07-15 10:21:56 -04:00
Matthew Printz
e4a6926d5f Fix typo in HOT template guide
Under the "Template input parameters" section, there was a typo in the
following sentence:
"For example, the following definition for the instance_type parameter
would select the ‘m1.small’ flavor unless specified otherwise be the
user."

Closes-Bug: 1339269
Change-Id: I59a170407669c74d23f36b232b3d492e52ce5eac
2014-07-08 15:31:49 -05:00
Jenkins
af3c236167 Merge "HOT intrinisic function list_join like Fn::Join" 2014-07-07 03:41:56 +00:00
Jenkins
e4c2f98597 Merge "Makefile option to build xml docs" 2014-07-04 17:48:53 +00:00
Jenkins
b4de7ef38b Merge "Re-organise top-level template guide structure" 2014-07-04 16:52:11 +00:00
Steve Baker
1e8e0fcc46 HOT intrinisic function list_join like Fn::Join
We have an increasing number of attributes which are a list of strings.

In HOT there is no way to join a list into a string as with the CFN
function Fn::Join.

This change implements HOT intrinsic function list_join using an
identical implementation as Fn::Join.

Tripleo will benefit from this function since the lack of a join
function in HOT is one of the barriers to transitioning to the
HOT template format.

Change-Id: I29e0b744271213429fff6922397b925eb9ccc204
2014-07-04 16:36:09 +12:00
Steve Baker
30e416324e Order intrinsic function docs alphabetically
The current order appears to be arbitrary. There is no other obvious
natural order so this change reorders alphabetically by the name
of the function.

Change-Id: Id1b0f02b8fb77f4e55827d962e3463d05245e564
2014-07-04 16:35:29 +12:00
Steve Baker
7e272cc4fe Makefile option to build xml docs
Change-Id: I15316f7a8e3fef679c9b322ef34d94848715b206
2014-07-02 22:08:01 +02:00
Dan
5fef57124c Document get_file get_param incompatibility
Adds a doc note that get_file only accepts static
arguments.

Change-Id: I3386a6f70c3ca2a8d32b7d0d56f6eb5c0bf56774
2014-06-26 15:47:34 -07:00
Steve Baker
a2eb685d23 Re-organise top-level template guide structure
The current structure must be baffling for new template authors.

First is a section on Environments, which is actually an advanced
topic. Then is a section on cfn compatible functions which users
should be spurning in favour of HOT intrinisic functions.

The actual docs on how to write a HOT template and the HOT spec
is buried at the end.

This change remedies this state of affairs by moving the
Heat Orchestration Template (HOT) Guide to the start, followed by
the HOT spec.

The Environments section is now after the resource types, and the
Functions section has been renamed CloudFormation Compatible
Functions.

How we document CloudFormation coverage probably needs to be
rethought, but that is beyond the scope of this change.

Change-Id: I2ef2568309427b37555bae3d6b24a1464a7379b1
2014-06-26 17:05:26 +12:00
Jenkins
91fddd5c45 Merge "Instructions on image creation for SoftwareConfig." 2014-06-26 04:32:34 +00:00
Jenkins
9f9a1fe489 Merge "Heat and Openstack incomplete documentation" 2014-06-17 00:04:55 +00:00
tengqm
f585eb3083 Instructions on image creation for SoftwareConfig.
Instructions on creating images that can be used for SoftwareConfig and
SoftwareDeployment are added.

Change-Id: If4bc6197ca38d73378ada6a6b32e47a658d88fc5
2014-06-13 14:39:51 +08:00
Dimitri Mazmanov
ecd6f719fc Added reference to the Nova Flavor documentation.
Updated contrib documentation with reference to the nova flavour README file.
Fixed the reference to the Docker documentation.

Change-Id: I23e352b8ec44424611066c0f64051ad3586b8c91
2014-06-09 12:12:29 +02:00
Jenkins
b1197da2ad Merge "doc: generate a valid xml tree" 2014-06-08 16:32:30 +00:00
Andre
8e20beccce Heat and Openstack incomplete documentation
Improve documentation running a heat template with devstack

Change-Id: Ifb6abd30a882d4c5197090c87498781702488b9c
Closes-Bug: #1326089
2014-06-04 14:08:35 -03:00
Gauvain Pocentek
a0610746a9 doc: generate a valid xml tree
This patch makes sure that the <emphasis> tags used in the resources
generator are embeded in a <paragraph>.

This change makes it easier to convert from docutils XML to docbook by
providing a valid XML tree.

Change-Id: Icd48d8cc6d868f484de895a07bd696e951884109
2014-05-29 10:39:06 +02:00
Jenkins
40c8de0c3f Merge "Fix broken link to API reference" 2014-05-29 08:34:22 +00:00
Jason Dunsmore
6984a77938 Add Boolean parameter type
Add a boolean parameter type to allow passing in boolean values via
parameters.

blueprint boolean-parameter-type

Change-Id: I693d0aa5bdc54bb57b8363633f1b41c59ccae7d3
2014-05-28 14:49:30 -05:00
Pavlo Shchelokovskyy
50ff4ec2fe Order imports in alphabetical order (9/9)
This patch fixes all the missed and newly introduced violations of the H306
style checking rule and enables it in tox.

Change-Id: I5566e66421d5397c0103958f02ea38e6e3c68892
Implements: blueprint reduce-flake8-ignored-rules (partial)
2014-05-22 16:49:51 +03:00
Anderson Mesquita
cd54af3c67 Fix broken link to API reference
The link to the API reference was pointing to api-ref-orchestration,
which is incorrect.  This changes it to api-ref-orchestration-v1.

Closes-Bug: #1320956
Change-Id: I3eb46af60dffc47e62ffbfc9f407f7f1a86a56a1
2014-05-19 13:24:01 -04:00
Angus Salkeld
e378408196 Make a top level contrib doc header
This is to just make it clear that there are other resources
besides Rackspace ones.

This is not really a bug as both the rackspace and docker
headings are the same level, but when going to the page it
is easy to see why the bug was made.

Change-Id: I76a8bcf63b7c976c4fcf0baecfd58e5fcbb65d96
Fixes-bug: #1311565
2014-05-09 07:16:47 +10:00
Chmouel Boudjnah
8c73c49dfe Skip tests when loading plugins
All python files in plugins were automatically loaded which would
add the dependencies of the tests to the plugins.

Let skip the files in the .tests. namespace

Closes-Bug: #1292655
Change-Id: I25eac87559b5852e9645fbb84c8b4d07b4c1ff42
2014-04-30 23:19:57 +02:00
Sergey Kraynev
26d9b41f1a Using attribute schema for building documentation
At now attributes have their own Schema class with support_status
option. This information should be displayed in documentation.
Current change makes possible to use new schema for building
documentation.

Change-Id: I40af79b57defb99c7b131583b5fedfd3a67968d1
Closes-Bug: #1306383
2014-04-30 09:26:48 +00:00
Jenkins
5790ffad53 Merge "Fix many typos" 2014-04-29 09:07:07 +00:00
Alex Gaynor
69074f7512 Fix many typos
Change-Id: I2c4b04945dd44cec6d3b245ac00345da7e9ba1bf
2014-04-25 16:45:43 -07:00