565 Commits

Author SHA1 Message Date
Ethan Lynn
267a4f076b Deprecate heat-keystone-setup
Keystone shell is deprecated in this release, use openstack client
in heat-keystone-setup. And add a deprecation warning to this
script.

Change-Id: I11334f0c8b035723a11f42bcfea054fc358a3e9f
Closes-Bug: #1460884
2015-11-13 10:28:42 +08:00
Bertrand Lallau
ef5a2976b2 Update instructions to generate GMR error reports
Guru Meditation Reports (GMR) code in oslo.reports was recently updated
to expect SIGUSR2 as opposed to SIGUSR1, because it is reserved by
Apache 'mod_wsgi' for its own use.

[1] https://review.openstack.org/#/c/223133/ -- guru_meditation_report:
    Use SIGUSR2 instead of SIGUSR1

Change-Id: I4dbf1a11d3737c4a8444b3a79de824acecb56d7d
2015-11-04 13:38:17 +01:00
Jenkins
9755629750 Merge "Implement new map_merge intrinsic function" 2015-10-22 13:07:02 +00:00
ricolin
11c69696ac replace git protocol by https
It will better to clone with https as "HTTPS works practically everywhere"
and 9418 port is blocked by many corporate firewalls.

Change-Id: I27edb8919af8ca3617bb50a305edfe7bbbe96836
2015-10-22 10:06:05 +08:00
Dan Prince
7f8e92ee00 Implement new map_merge intrinsic function
Adds a new map_merge function for Mitaka which can be used
to merge maps. Values in latter maps override those in earlier
ones.

Also, creates a new HOT template version for Mitaka which includes
the new map_merge function.

Implements: blueprint map-merge-function
Change-Id: I2bdfc70d04a4fa14cefcf928ea5947fbe7529cf9
2015-10-21 19:33:18 -04:00
ricolin
35047c131f Replace github with openstack git repo
git.openstack.org is our official server, github is just a
read-only mirror.

Linking to github might also raise the expectation that we use the usual
github workflow which is not the case.

Change-Id: I3b3e8213c264757838c8e5fd33221eebf219cdc8
2015-10-21 09:51:40 +08:00
Jenkins
205b163d08 Merge "Fix [H405] pep rule in doc/source" 2015-10-09 10:00:39 +00:00
Peter Razumovsky
00b2c9da15 Fix [H405] pep rule in doc/source
Implements bp docstring-improvements

Change-Id: I8a90a6fa677a89135cfad13984280e8fb94e8b0c
2015-10-08 15:13:52 +03:00
Hironori Shiina
e77c268e8c Fix typo in document
Fix 'anwsers' to 'answers'.

Change-Id: I3f876a023352362ce6495f1516f7a76330efe2a7
2015-10-08 04:12:22 +00:00
Steve Baker
98f687c1bc Organise doc links for Operating Heat
The second section of doc links is aimed at operators, so existing
content which affects operators has been moved here (package based
install, scaling, service man pages).

The yum/apt install pages have been simplified to point at
docs.openstack.org and any other community based installation resources
(RDO, Juju charms).

Change-Id: I3e89a288bf6b64ba286c11df1369e073d2c2a35e
2015-10-06 11:38:14 +13:00
Steve Baker
a2d1b7ee38 Aim first doc link list at end users
This change renames the first doc link section Getting Started to
Using Heat and makes the content relevant to end users of Heat.

End users author templates, create stacks, and use the heat CLI.
They are not necessarily interested in installing heat from packages or
devstack.

This change breaks out the basic create-stack content into its own page
and links to that from the first Using Heat contents list. The rest of
the getting started content is moved to the Developers section for now,
pending later changes aimed at developers and operators.

Change-Id: I79988e08864c5a87ebc4f8f5a39102d50b26f748
2015-10-06 11:38:14 +13:00
Steve Baker
3d440cd0dc Align the docs intro text with the old wiki page
This landing page is now aimed at users, operators and developers
(instead of just developers).

This change rewrites the intro section to also cover points made
in the old wiki landing page [1] which needs to be deprecated with
a link to this page instead.

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

Change-Id: I452807a2d9a8821c4a81d63eb8e824e04b344ef5
2015-10-06 11:25:09 +13:00
Steve Baker
80ac4e3b0a Align update_policy section heading with HOT
Change-Id: I88f864b3a8624deafbf852c9cebe0cbf01f01821
2015-10-05 09:47:42 +13:00
huangtianhua
75048514a4 Add mitaka version '6.0.0' in doc
Change-Id: I55ab9dad186e757234f2e9e9f4eb28ac56d179ba
2015-09-25 16:40:00 +08:00
Dmitry Tyurnikov
1bb37b6857 Some lambda were replaced on def
Always use a def statement instead of an assignment statement that binds
a lambda expression directly to an identifier.

Yes:
def f(x): return 2*x

No:
f = lambda x: 2*x

https://www.python.org/dev/peps/pep-0008/

Change-Id: I776b80bb4bc2184125f461c801897f84d3f29254
2015-09-23 11:35:29 +01:00
Mark Vanderwiel
6b837a85ff Add table of custom constraints to hot spec
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
2015-09-18 18:53:16 -05:00
Steven Hardy
66f4178d28 Allow map/list items for str_replace
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
2015-09-16 19:07:18 +01:00
Jenkins
b8fb5c61e7 Merge "Allow map/list items for list_join" 2015-09-16 17:20:42 +00:00
Steven Hardy
ec2fd65174 Allow map/list items for list_join
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
2015-09-16 00:35:05 +00:00
Jenkins
967528cc6b Merge "Enable ceilometer services using new plugin model" 2015-09-15 11:25:04 +00:00
venkatamahesh
ef2c4f9c1c Enable ceilometer services using new plugin model
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
2015-09-14 14:39:36 +05:30
Ethan Lynn
d6b618be55 Add command to clean dead engine from service list
Add command 'service clean' to remove dead engines
from service list.

Closes-Bug: #1495374
Change-Id: I644eee717f8e76ab9d5d7d6847442740ea201e6b
2015-09-14 16:59:18 +08:00
Jenkins
b878014c1b Merge "Fix syntax in "Heat Orchestration Template (HOT) specification"" 2015-09-14 01:28:53 +00:00
Jenkins
9737eecbfb Merge "Fix url for image in getting_started doc" 2015-09-13 23:01:31 +00:00
Christian Berendt
3e2b480cf8 Fix syntax in "Heat Orchestration Template (HOT) specification"
Change-Id: I603099a13ddef26c6cd6fb1810e71b9cd63028e8
2015-09-13 20:08:53 +02:00
Peter Razumovsky
603745a8fd Fix url for image in getting_started doc
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
2015-09-11 10:05:46 +03:00
Steven Hardy
8bbb4f2970 Clarify hot_spec description of latest HOT version
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
2015-09-10 09:19:47 +01:00
Jenkins
6b1a76e5a1 Merge "Add immutable parameter for schema in pluginguide" 2015-09-09 23:58:20 +00:00
Jenkins
212c0fccc0 Merge "Change revision to version in heat-manage db_version command" 2015-09-09 09:36:12 +00:00
Sreeram Vancheeswaran
1a1cf9dcd6 Change revision to version in heat-manage db_version command
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
2015-09-08 14:06:45 +05:30
Peter Razumovsky
e9cedf5abd Clarify definition of server network prop in doc
There is confusing description for network property
of OS::Nova::Server. Clarify this description.

Change-Id: I137ef18afae0527c114f037fe607ddf65513adea
Closes-bug: #1487757
2015-09-07 15:30:14 +03:00
Oleksii Chuprykov
347f21ca1d Add immutable parameter for schema in pluginguide
Change-Id: Ia2e8dc5df568f8213c8a7a41d98b7eaae4dbb963
2015-09-07 14:09:18 +03:00
Jenkins
1d845828dd Merge "Add information about new get_attr functionality" 2015-09-04 09:45:46 +00:00
Jenkins
97572d146d Merge "enabling the stevedore.sphinxext extension." 2015-09-02 16:05:30 +00:00
Peter Razumovsky
292ad4e13f Add information about new get_attr functionality
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
2015-09-01 17:32:17 +03:00
Jay Clark
40d8b0f454 enabling the stevedore.sphinxext extension.
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
2015-09-01 07:03:56 +00:00
Jenkins
a1575bfe95 Merge "Fix docs for Hello World and WP Single templates" 2015-09-01 06:26:48 +00:00
Brian Moss
615ad218d4 [Heat Docs] Update links to Cloud Admin Guide
Update links to the Cloud Admin Guide after the RST conversion
of that book altered URLs.

Change-Id: I55ce13eb8bf3e6d4b8f45eb7284570f81258532a
2015-09-01 10:44:33 +10:00
Jenkins
831eaf0e7d Merge "Adds resource uuid, volume support to lifecycle scheduler hints" 2015-08-29 02:44:44 +00:00
Anderson Mesquita
31e970c45d Fix docs for Hello World and WP Single templates
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
2015-08-28 10:58:46 -07:00
Joe D'Andrea
b31259a9ed Adds resource uuid, volume support to lifecycle scheduler hints
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
2015-08-27 12:05:39 -04:00
Steve Baker
fc5834bb7f Use the official mission statement in index.rst
Also, since this is not primarily developer documentation any more,
remove the word 'developer' from the page title.

Change-Id: Ia3fb3aae150f6439bc8c8b0eac71b634dca3d445
Related-Bug: 1488292
2015-08-27 09:59:25 +12:00
Steve Baker
453acc407a flake8 check doc/source
Change-Id: I26001e29a37b340ea8d11d9b054f51f7cd305318
2015-08-27 09:59:25 +12:00
Steve Baker
25f707cdf0 Use sections for individual properties and attributes
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-08-27 09:59:25 +12:00
Steve Baker
569bd15521 Use latest stable template version in snippets
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
2015-08-27 09:59:25 +12:00
Steve Baker
e9707af332 Use code-block:: yaml for all template snippets
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
2015-08-27 09:59:25 +12:00
Jenkins
be34997f70 Merge "Add properties grouping by necessity in docs" 2015-08-23 22:47:23 +00:00
Chris Buccella
84760c8e76 Fix sample snippet in the template guide
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
2015-08-22 15:13:39 -04:00
Peter Razumovsky
9aee53d393 Add properties grouping by necessity in docs
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
2015-08-21 11:39:34 +03:00
Peter Razumovsky
97ef1a96d6 Add info about refactored handle_delete to doc
Add information that now implementing of handle_delete
is optional, if it's satisfy required format.

Change-Id: I36bf3d8fcd2e15dca8180a6f857056586c89eca9
2015-08-19 17:27:12 +03:00