565 Commits

Author SHA1 Message Date
Thomas Herve
346e5561b5 Fix doc build
Sphinx 1.7 removed the Directive from the compat module. Let's use the
docutils version.

Change-Id: I22972feea961f0eb2996d605ff98bbe1f5df2711
2018-03-03 10:51:07 +01:00
Zuul
df7920913b Merge "Fix typo in contributing/blueprint.rst doc" 2018-02-21 01:15:13 +00:00
Zuul
d562bcb46d Merge "include sample config file in docs" 2018-02-11 08:45:49 +00:00
David Rabel
38b961d6d5 Fix hot_spec.rst in Template Guide
Add missing space and words in
doc/source/template_guide/hot_spec.rst

Change-Id: Ic0e5c827d04b78c337c6562df73b5bd1ccf2a977
2018-02-07 08:09:42 +01:00
ricolin
46d1e89c27 include sample config file in docs
Leverage oslo.config to rebuild our sample config file in docs.

Change-Id: I359e63fad43a5fcde4fe30a97cbed8f4f71961c5
2018-02-01 15:38:25 +00:00
rabi
f62167f3de Remove heat-api-cloudwatch from man pages list
Change-Id: I603a3be18ff4cd9b3c7db8a4728d0ac864d0b089
2018-02-01 18:50:23 +05:30
rabi
d3ea2918a3 Cleanup remaning doc for CloudWatch API
Change-Id: I0423dba4eb2a9ddfd7419869ac5943638786a282
Partial-Bug: #1743707
2018-02-01 05:24:05 +00:00
Zuul
04be5a736e Merge "Remove CloudWatch API" 2018-01-31 19:29:03 +00:00
Zuul
54dd15cfd8 Merge "Updated the template guide." 2018-01-30 07:03:13 +00:00
rabi
6d55417f80 Remove CloudWatch API
This patch removes the API, the next set of patches in the
series would remove stack watch service and related
WatchRule implementation.

Change-Id: I8b0472be862907298c8da51f435b5d8b19610ec3
Partial-Bug: #1743707
2018-01-28 09:11:17 +05:30
Zuul
4cbec2c07a Merge "Remove potential co-gating integration tests" 2018-01-27 06:35:21 +00:00
ricolin
ba86129965 Remove potential co-gating integration tests
This patch propose to use heat tempest plugin for potential
co-gating integration tests.
These tests are consider as potential co-gating. And we now
already maintain them in heat tempest plugin.

This also disables all except two of the gate/test jobs, to enable us to
land this series and stop the carnage. The jobs will be re-enabled once
all of the duplicated tests have been eliminated.

Change-Id: I55e204b72cd5a2876576852b10ad09f24d04beb4
2018-01-26 17:50:26 -05:00
Zuul
8dbc4977f1 Merge "docs: fix user-data end user guide link" 2018-01-26 21:10:24 +00:00
Matt Riedemann
9a5252ae6e docs: fix user-data end user guide link
The user-data doc has moved out of the openstack-manuals
repo and into the nova docs, so this updates the link.

Change-Id: I6fac7128f8c099deaea31b3834cab0e472bc10fe
Closes-Bug: #1714017
2018-01-26 20:23:51 +00:00
liumk
a69c2f4bb4 fix a typo in heat-manage.rst: s/covergence/convergence/
Change-Id: If5da5974162209b7f8f513f65d2d2050ba2c4c59
2018-01-22 04:07:59 -05:00
ricolin
222a8ac5e9 [policy in code] part 7 add sample and releasenote
Since we're moving all policy into code and documenting it there we
should generate those docs automatically, so they are less likely to
be out-of-date.
Also add releasenote for ops to aware that Heat is now using
policies in code and their Orchestration service needs to avoid
depends on policy.json file if file not exist, since there is no
such file by default after this patch.
Partially-Implements: bp policy-in-code

Change-Id: I25fc5a110b1fe515918e042f220c23ac9a7e811f
2017-12-13 10:58:56 +08:00
Zuul
218c182fbb Merge "Remove SSLMiddleware" 2017-11-27 03:36:19 +00:00
Zuul
0af0bcd2d1 Merge "Added tags attribute to the template parameter" 2017-11-16 12:29:33 +00:00
Saravanan KR
a1a0609e8e Added tags attribute to the template parameter
In some scenarios, it is required to categorize the parameter.
Associating tags with the parameter, it is will be easy to
categorize the parameter and add simple validations to users.
This patch introduces a new attribute 'tags' with the parameters,
which is a list of strings.

Change-Id: I20fc95d606b0b8a08d3b46bf33f4860bff49c74f
2017-11-13 15:51:19 +05:30
Zane Bitter
6c8697442e Do deep redirects from old docs.openstack.org URLs
The docs.openstack.org site was rearranged so that the old docs at
/developer/heat/ are now at /heat/latest/. The base .htaccess file in
openstack-manuals redirects everything in the old hierarchy to the root
of the new one unless there is a .htaccess file present (see
I0af0e32d9c646d61f4c72599cdc4613299aa5ec9).

Add a .htaccess file so that old links redirect to the equivalent page
in the new location.

Change-Id: I74de09f4e25c2eda050053d3b8646586c9f24c04
Closes-Bug: #1722820
2017-11-02 16:25:01 -04:00
ricolin
f2fd3884e8 Remove SSLMiddleware
We deprecate SSLMiddleware in 6.0.0, and announce to remove it at
8.0.0. Now will be a good time to remove it out.

Change-Id: Iaf9be21ffcec9018ad91a5122ed7f2477a7e4a52
2017-10-18 02:19:46 +00:00
ricolin
a4f2dccf0e Correct example for list_concat-unique function
Change-Id: I330a265a16b0d7a2ac9f94e859f7b81f1e193dc5
2017-10-12 18:56:27 +08:00
Jenkins
0de1e372c7 Merge "Minor doc fix: tmpl_diff argument for handle_update" 2017-09-08 06:40:10 +00:00
Monty Taylor
584a5b0ba5
Remove vestigate HUDSON_PUBLISH_DOCS reference
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.

Change-Id: I7fed29322e00fa72b949692e01d821faa3f718ba
2017-09-02 08:44:52 -05:00
Jenkins
ccfb868f72 Merge "* Add new HOT version for Queens release" 2017-08-23 09:20:36 +00:00
Jenkins
8afa507ffd Merge "* Add Queens version '10.0.0' in doc" 2017-08-23 08:10:44 +00:00
npraveen35
e18a523c99 heat config eliminate ec2authtoken
eliminate [ec2authtoken] section, if auth_uri is specified in
'clients_keystone' section

Change-Id: Ie11139a5d9a176037f1c9f50a62ff6dbd1b20b8f
Closes-Bug: #1705664
2017-08-22 04:03:15 +00:00
huangtianhua
c3546d9309 * Add new HOT version for Queens release
The new version is "2018-03-02" or "queens".

Change-Id: Icbb7ff4d717dd10d18a93387edfdb8fcee3d7927
2017-08-22 10:03:18 +08:00
huangtianhua
20a0a48d74 * Add Queens version '10.0.0' in doc
Change-Id: Id99503e561ce112c0e4803ca1566be3186c1bd31
2017-08-22 09:49:04 +08:00
Praveen Yalagandula
327f36c7f4 Minor doc fix: tmpl_diff argument for handle_update
The description for tmpl_diff argument in handle_update function
was incomplete and could be misconstrued as referring to the
values in the old definition. This documentation fix rectifies
that issue. Also, corrected the name "templ_diff" to "tmpl_diff".

Related-Bug: 1709147
Change-Id: Iaa55aeb14cf836d0dc589bdbe711fa29f6ef6080
2017-08-09 22:50:51 +00:00
kaz_shinohara
50088c572e Updated the template guide.
The current template guide does not show required/optional flag
for subproperties, it means that users need to look at the source
code to clarify if the subproperties is required or not.
Updated a sphinx extension doc/ext/resource.py to display
required/optional flag for subproperties.

Change-Id: Ie9e23d633d749aa7ad087330520cd3b83294794a
Closes-Bug: #1694748
2017-08-04 18:02:38 +09:00
Kien Nguyen
10a1161dfa Add upgrades guideline for operators
This patch set will add upgrades guideline for operators.

Change-Id: Ic61e4e11ec50c221038a007559bd67fe48a3ac65
Implements: blueprint heat-rolling-upgrades
2017-07-31 16:02:41 +07:00
rabi
27d297346e Move in-tree admin guide from openstack-manuals
Change-Id: I3abb96744039200327c33c7565d7571d74541d6b
Closes-Bug: #1706174
2017-07-25 16:59:03 +05:30
rabi
4e4bc0171c Move in-tree config-reference from openstack-manuals
Change-Id: I9f1d1c4e783906cdbe2f3412dfc2e33b3fb546fc
Partial-Bug: #1706174
2017-07-25 16:58:54 +05:30
rabi
e869e5397f Move install guides to doc/source/install
Change-Id: Iac205e96624d4dd58d797bdff342adceeb846bb5
Partial-Bug: #1706174
2017-07-25 11:06:15 +05:30
huangtianhua
ba7f7888f6 Support 'permutations' for 'repeat' function
Adds a new section 'permutations' for 'repeat'
function to decide whether to do nested loops
to iterate over all the permutations of
the elements in the given lists, the default value
is True if no specify and keep the same behavior as
before.
For example:

  repeat:
    template:
      network: %net%
      port: %port%
      ip: %ip%
    for_each:
      %net%: [n1, n2]
      %port%: [p1, p2]
      %ip%: [ip1, ip2]
    permutations: False

Will be resolve to:
   [{network: n1, port: p1, ip: ip1},
    {network: n2, port: p2, ip: ip2}]

Change-Id: I2a008400fb71453f6a78656f2e041ae2efa098a2
Blueprint: improve-repeat-function
2017-07-18 09:32:15 +00:00
Jenkins
88082b0e2b Merge "Add httpd documentation and sample configs" 2017-07-13 03:59:07 +00:00
rabi
00df019f9f switch from oslosphinx to openstackdocstheme
Change-Id: I042e255e544231741b7550fb92b46142ceb0e6cd
2017-07-11 12:27:56 +05:30
rabi
bcd8c814b7 Add httpd documentation and sample configs
This adds uwsgi sample configs and documentation for
deploying api services with httpd.

This moves the existing mod_wsgi sample configs from devtsack
folder as they are not specific to devstack.

Change-Id: I91fd64d9deba3371b62c00ba8b01a7aca21b2393
2017-07-07 11:00:06 +05:30
Andreas Jaeger
019f93ce79 Remove obsolete docbkx directory
heat now has an api-ref document. Remove the obsolete DocBook api-ref
and the heat-admin skeleton guide.

Change-Id: I8965cc804e566f689c76036be373cd2c153e472e
2017-07-03 10:05:06 +02:00
huangtianhua
306ee63083 Add an example on how to use 'contains' as condition
This adds an example in docs on how to use
newly added function 'contains' as condition.

Change-Id: I9c5f314925f5b6592742cb4eb04e4c8247ec743c
2017-06-23 14:26:51 +08:00
huangtianhua
f4c4ec63ab Add 'contains' function
Add new function 'contains' to check whether
the specific value is in a sequence. The resolve
result of the new function is a boolean value, so
we put it as a condition function too.

Change-Id: I90074070dd917df13345fb7c8d4ed09e4a76e864
Blueprint: support-contains-function
2017-06-22 07:26:19 +00:00
huangtianhua
77e5072621 Allow function 'yaql' as condition function
Allow 'yaql' in condition definition, like:

parameters:
  ServiceNames:
    type: comma_delimited_list
    default: ['neutron', 'heat']
conditions:
  contains_neutron:
    yaql:
      expression: $.data.service_names.contains('neutron')
      data:
        service_names:
          get_param: ServiceNames

Closes-Bug: #1693093

Change-Id: I83a540336c01a696780621fb2b39486a6abf0917
2017-05-25 01:19:26 +00:00
huangtianhua
812e786efb Support 'list_concat_unique'
Adds function 'list_concat_unique' to concat
several lists using python's extend function
and make sure without repeating items.

Blueprint: support-list-concat-unique-function
Change-Id: Ia0e35eb578ebe91543c644155a86030b3258118b
2017-05-18 01:29:48 +00:00
Jenkins
d6d836ff62 Merge "Add the HOT fuction str_replace_vstrict" 2017-05-15 06:10:17 +00:00
ChangBo Guo(gcb)
381a84a4e8 Remove usage of parameter enforce_type
Oslo.config deprecated parameter enforce_type and change its default
value to True in Ifa552de0a994e40388cbc9f7dbaa55700ca276b0. Remove
the usage of it to avoid DeprecationWarning: "Using the 'enforce_type'
argument is deprecated in version '4.0' and will be removed in version
'5.0': The argument enforce_type has changed its default value to True
and then will be removed completely."

Change-Id: I91b0f0a52b5ce8654702510eed76d5dea8cc8fe4
Related--Bug: #1517839
2017-05-08 17:55:32 +08:00
Kashif Siddiqui
03574f8a0b Fix typo in contributing/blueprint.rst doc
Change-Id: If5f2aafa3247dc00fc77280bfef0dfc14b6b2cfe
Closes-Bug: #1689080
2017-05-07 14:08:23 +00:00
Jenkins
9513feca7d Merge "Fix doc generation for Python3" 2017-05-01 20:45:34 +00:00
Crag Wolfe
1f8d70346a Add the HOT fuction str_replace_vstrict
The already existing str_replace_strict function raises an error if a
param is not present in the template. str_replace_vstrict, newly added
in this patch, is identical but also raises an error if any of the
params have an empty value.

Change-Id: I5407135cc0435cfbad2d18964fe2119c999f67a3
2017-04-21 19:08:20 -07:00
Juan Antonio Osorio Robles
19ba1c031f doc: Add description of list_concat in pike notes
Change-Id: Ifcc165112dd0bdd90d2a06df066cafde54f5bdfa
2017-04-21 11:27:06 +03:00