565 Commits

Author SHA1 Message Date
Jenkins
fa4b6772c5 Merge "Fix docs about using SupportStatus during remove" 2015-08-18 13:45:27 +00:00
Jenkins
b00829f4f5 Merge "Add base_attributes_schema to documentation" 2015-08-18 01:29:38 +00:00
Peter Razumovsky
4d42d61439 Fix docs about using SupportStatus during remove
Fix docs about using SupportStatus for object after
deprecation period. Also, fix several typos and
format mistakes.

Change-Id: I4d26f9977859ff845d7ff561cdd64180f5b848c4
Closes-bug: #1484868
2015-08-14 12:51:18 +03:00
Peter Razumovsky
361f5acb3a Add base_attributes_schema to documentation
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
2015-08-14 12:00:28 +03:00
Oleksii Chuprykov
782bec68ad Add default value for boolean type to pluginguide
Change-Id: If2f837453cf5e31e7b32d703536d912d29b9d641
2015-08-13 18:29:09 +03:00
gordon chung
44336983ae add ceilometer notification agent to docs
when using ceilometer, ceilometer-anotification service is required
as it does all the processing. it is missing from the setup docs.

Change-Id: I4773f896dab580343ab445ec772c45dfe2f3ef7b
2015-08-11 16:37:30 -04:00
Angus Salkeld
dcc1f93c28 Add note on the use of intrinsic functions
Change-Id: Ib90573b46b0077c2ca4902ad92ee7d9fb730f5f7
Closes-bug: #1369736
2015-08-10 10:18:19 +10:00
Sergey Kraynev
54818aa1ca Replace tag 2015.2 to 5.0.0
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
2015-08-06 06:29:09 -04:00
Jenkins
f9117d24a8 Merge "Get 'update' paragraph from top-level schema" 2015-07-28 10:22:02 +00:00
Jenkins
583fa18120 Merge "Move qpid-python to test-requirements" 2015-07-28 09:43:06 +00:00
Tetiana Lashchova
012107dedc Get 'update' paragraph from top-level schema
Change-Id: I4e3ed92303fa268afd5583cc76e3536b18478294
Closes-Bug: #1399120
2015-07-27 08:45:34 +03:00
Atsushi SAKAI
717fd1e184 Fix four typos on heat documentation
behaviour => behavior 2
evironment => environment
Non-dependant => Non-dependent

Change-Id: I895c88dd3382e29d54dd9d08353aa1c3f329d146
Closes-Bug: #1478410
2015-07-27 08:44:29 +09:00
Peter Razumovsky
a43e2c95d8 Add documentation page for Support Status
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
2015-07-20 10:53:55 +03:00
Jenkins
091ffb167b Merge "Add HIDDEN status to SupportStatus" 2015-07-16 01:43:10 +00:00
Peter Razumovsky
e3e8e06fe7 Fix typos in hot_spec documentation
Fix typos and format mistakes in hot_spec docs.
Besides that, all lines now < 80 characters.

Change-Id: I65a69cfa1912a139e162acf8a2bd6d279d1eb46c
2015-07-13 17:05:20 +00:00
Dirk Mueller
a5c7da576c Move qpid-python to test-requirements
qpid-python is only needed if the qpid backend is actually used.
when it is part of requirements.txt, loading of heat-engine
(which is done via stevedore) fails as it forcefully requires
qpid-python then. However heat seems to work just fine without it.

Change-Id: I1c49ec709995da145849d8616fe7207908637fb9
2015-07-13 10:21:36 +02:00
Laura Fitzgerald
e081f563ee Added required name property to Create a key pair example
Added the required property 'name' to the KeyPair resource 'my_key' in
the Create a key pair example.
Existing example failed due to missing property 'name'.

Change-Id: If3db4afb0dc5cb69780b03cf2d91c06d5d6996ef
2015-07-08 11:39:19 +01:00
Jenkins
00afffd6a2 Merge "Fix external references in glossary doc" 2015-07-08 10:05:12 +00:00
Peter Razumovsky
6735bece13 Add HIDDEN status to SupportStatus
Add HIDDEN status to SupportStatus and it's supporting
in code: hiding objects with HIDDEN status in docs and
resousce-type-list.

bp deprecating-improvements

Change-Id: Iebd77d769966bab321aeaf3e23b7f54e9456ad13
2015-07-08 12:18:49 +03:00
Rabi Mishra
8fad873463 Fix external references in glossary doc
Fix some external references in the glossary document.

Change-Id: Idff080f7b126066195cd81952df7541a07f8f0de
2015-07-08 09:31:42 +05:30
Jenkins
4b4b27d0ff Merge "Add str_split function to HOT 2015-10-15" 2015-07-08 01:01:06 +00:00
Thomas Herve
5d2e6ea3f1 Remove hotref links in the documentation
Now that we moved the template_guide in-tree, the hotref sphinx
directive doesn't work anymore and isn't needed. This replaces it with
ref directives and a missing-reference handler managing resources.

Change-Id: I5cba4b96894878a57d577c74dd6ade7fd252b164
2015-07-07 10:11:56 +02:00
Jenkins
7d19752940 Merge "Remove old JSON and YAML docs syntax" 2015-07-03 08:31:21 +00:00
Jenkins
02b723a735 Merge "Introduce Guru Meditation Reports into Heat" 2015-07-03 01:12:39 +00:00
Steve Baker
9f31a3d258 Remove old JSON and YAML docs syntax
This change stops generating JSON (cfn) and YAML example snippets
for resource types. These are ancient and only cause clutter in
the docs.

Change-Id: I94d3a3400f0e9ba8404c2da4364e5f9acc7dc4b2
2015-07-03 11:46:16 +12:00
Rabi Mishra
62d4a28bca Add doc generation for UpdatePolicy
Change-Id: I55213c7615f42415d97600798f111a70dd809c31
2015-07-02 16:34:59 +05:30
zhangchunlong1@huawei.com
1e49aad113 Introduce Guru Meditation Reports into Heat
This commit integrates functionality from the `openstack.common.report`
module into Heat. This enables Heat services to receive SIGUSR1 and
print a Guru Meditation Report to stderr or file. The required modules
were added to 'openstack-common.conf' as well.

Change-Id: I36af98590e5556f012b0e9f79e21585e216b7280
Blueprint: guru-meditation-report
Co-Authored-By: huangtianhua <huangtianhua@huawei.com>
2015-07-02 16:55:25 +08:00
Steven Hardy
80fe9e2327 Add str_split function to HOT 2015-10-15
Adds a new intrinsic function to split strings into lists, and optionally
return a specific list item by index (similar to get_attr/get_param path
based attributes).

Syntax is:

str_split: [",", "apples,pears"]

which returns ["apples", "pears"]

Or with an optional index:

str_split: [",", "apples,pears", 1]

which returns "pears"

Change-Id: Ibc7a315bee278b8a49e44475206361b639536688
blueprint: str-split
2015-07-01 15:54:04 +01:00
Steven Hardy
0d99ede046 HOT version 2015-10-15, remove Fn::Select
Bump the HOT version for the Liberty release, currently planned
for 2015-10-15 [1]

This is the same as 2015-04-30 other than the removal of the
last remaining CFN compatible function, Fn::Select, which should
now be replaced by path based attributes/parameters, e.g:

{get_attr: [aResource, anAttribute, <list index>]}
{get_param: [aListParam, <list index>]}

[1] https://wiki.openstack.org/wiki/Liberty_Release_Schedule

Change-Id: I10e5b12b84a6de01dd3f8a37a2d6cb644f319049
2015-06-26 10:21:50 +01:00
Brian Moss
670bf6d6cb Merge HOT Guide files into Template Guide
The HOT Guide was formerly located in the User
Guide. This patch merges those files into the
heat docs repository in the Template Guide
directory.

Change-Id: I559b1b3edb42b1de40013c37e5967d8898c8a916
Closes-Bug: #1461720
2015-06-25 11:14:50 +10:00
Jenkins
c512e0fb87 Merge "Update version for Liberty" 2015-06-22 14:22:09 +00:00
Jenkins
fba683284f Merge "Fix ceilometer backend in heat docs" 2015-06-22 11:25:56 +00:00
Jenkins
f99df4fc87 Merge "Switch from MySQL-python to PyMySQL" 2015-06-22 10:32:35 +00:00
Doug Hellmann
423110ef6e Update version for Liberty
Update the version for Liberty, switching from date-based versioning
to pre-versioning using SemVer. See
http://lists.openstack.org/pipermail/openstack-dev/2015-May/065211.html
and
http://lists.openstack.org/pipermail/openstack-dev/2015-June/067082.html
for details.

Also new version was updated in resources with SupportStatus version 2015.2.

Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c
2015-06-22 04:13:01 -04:00
kairat_kushaev
4c16b78455 Fix ceilometer backend in heat docs
Latest devstack does not support CEILOMETER_BACKEND=mongo
in local.conf. So we need to fix it in the documentation for
newbies.

Change-Id: I48747be9d5c54d496653439d731f0ef77201a4f2
2015-06-19 12:38:48 +03:00
Jeremy Stanley
f6e34c9017 Switch from MySQL-python to PyMySQL
As discussed in the Liberty Design Summit "Moving apps to Python 3"
cross-project workshop, the way forward in the near future is to
switch to the pure-python PyMySQL library as a default.

https://etherpad.openstack.org/p/liberty-cross-project-python3

Also set the OS_TEST_DBAPI_ADMIN_CONNECTION override variable so
that oslo.db opportunistic detection will know to use PyMySQL until
I12b32dc097a121bd43991bc38dd4d289b65e86c1 makes it the default
behavior.

Change-Id: I17e052215ce6e1604cdda848ccc20862452ccbc7
Co-Authored-By: Victor Sergeyev <vsergeyev@mirantis.com>
2015-06-18 18:05:44 +00:00
Jenkins
77641c401a Merge "Use pbr new autodoc feature" 2015-06-18 09:27:13 +00:00
Peter Razumovsky
8935ae46be Add additional info for DEPRECATED objects
Add previous_status supporting in docs.

bp deprecating-improvements

Change-Id: I9cc33613d59b275a287630a5908cdf549dd061ca
2015-06-16 18:05:01 +03:00
Julien Danjou
6015b725f7 Use pbr new autodoc feature
This relies on the new pbr feature that autogenerates the documentation.

Change-Id: Ie3287dfc6a9a4566eb1c444af63ae86954c69e68
2015-06-16 11:35:02 +02:00
Pradeep Kumar Singh
e97124a8ed Modify heat-engine's description in developer docs
Closes-Bug: #1462888

Change-Id: I1fb034d69d899b67db2706a3c192fcc8e40f4aee
2015-06-10 13:40:56 +05:30
Jenkins
6a73e1af4a Merge "Modify heading of the template sample page" 2015-06-04 16:51:16 +00:00
Pradeep Kumar Singh
affc4a52f8 Modify heading of the template sample page
Currently the headings for Hello World HOT template
and AWS Wordpress Single Instance Template pages is
"Template". This patch modifies the heading
of these pages.

Closes-Bug: #1337108

Change-Id: Ib1aaf1000f085b1b9568ef4f2322e7519703c838
2015-06-04 19:05:42 +05:30
Jenkins
d2c06aa902 Merge "Change "ReST" to "REST" in developer doc" 2015-06-03 23:40:50 +00:00
Pradeep Kumar Singh
355418374b Change "ReST" to "REST" in developer doc
Closes-Bug: #1461023

Change-Id: I4a1142ef25f2cf5f4e1c2b41243173dc6cebcce1
2015-06-03 21:26:29 +05:30
Pradeep Kumar Singh
b1f2240925 Change "Devstack" to "DevStack" in headings
This patch changes "Devstack" to "DevStack" and
"Openstack" to "OpenStack" in HEAT developer
documentation, so that their uses can be unified.

Closes-Bug: #1461456

Change-Id: Ie01b1a87205430672e56a41a51764b975090c1f9
2015-06-03 14:36:24 +05:30
Jenkins
bd85341ac4 Merge "Added documentation on resource contributions" 2015-06-03 01:18:03 +00:00
Miguel Grinberg
6311fa3050 Add unsupported resources page to documentation
This change adds a new page to the sphinx documentation that lists all
the resources that are not officially supported, such as those marked as
deprecated, unsupported, prototype, etc.

Change-Id: I0a14899f4f9e1539242f898f2d74d2677689d260
2015-05-28 14:58:46 -07:00
Miguel Grinberg
aa15bc1339 Added documentation on resource contributions
A section on how to contribute resources to the Heat project was added
to the documentation.

Change-Id: I682169053a6d53844fd0257fd43e82459629558c
2015-05-26 19:13:41 -07:00
Tetiana Lashchova
bc89203e6e Add note that OS::project_id is available since Kilo
Change-Id: I3a4ba714de17939a1454cfa399256bc825fe33b2
Closes-Bug: #1457675
2015-05-22 12:50:00 +03:00
Jenkins
9a8323ddaa Merge "Fix docs about configuring heat with devstack" 2015-05-14 20:50:41 +00:00