35 Commits

Author SHA1 Message Date
Rajesh Tailor
791b6931aa Remove repeated words
This change fixes repeated adjacent words.

Change-Id: Idb218ead15d0285418e9aac979ec7c0766394fa8
2022-12-22 17:26:10 +05:30
Rajesh Tailor
6901c3aa8a Fix typos in doc pages
Change-Id: Ia68d3469318dd423ceb0843c39d3ac2734a5f264
2022-09-28 20:46:32 +05:30
ljhuang
de002a06a5 Fix typos of "available" and "command"
Change-Id: I314712aaac8de21a4272eb96dcec069baa3dc898
2022-07-27 18:03:59 +08:00
Alex Schultz
c3fbdc45eb Update release docs
Update the docs to include our switch to independent and include details
on what is necessary to create a release for RDO intermediate versions.

Change-Id: I7abf5efb5b41613ac6da0f489c53c06f22100a97
2021-10-21 10:27:03 -06:00
Michele Baldessari
ce853b2f97 Add some docs for pre_deploy_step_tasks
Via If3c74703a684fbd5a815e073cc9da34e9ad672e8 we're adding a new
set of tasks, let's document those.

Change-Id: I9af03c6de241ad7fe706ee12bdd2a6eece9880a6
Depends-On: If3c74703a684fbd5a815e073cc9da34e9ad672e8
2021-04-02 18:53:24 +02:00
Carlos Goncalves
e264e81935 Remove references to DefaultPasswords
The DefaultPasswords interface was removed from tripleo-heat-templates
in Change-Id If83d0f3d72a229d737a45b2fd37507dc11a04649.

Change-Id: I42913c36b634ad1fb1c1b4cc0c798fe98dc430c2
2021-02-26 11:26:17 +01:00
Rajesh Tailor
6447c381b1 Fix typos
This patch tries to fix maximum typos in docs.

Change-Id: Ic406e3a4423cdd7c46c8a4497d43d63c95b2a9f5
2020-08-19 17:20:09 +05:30
Cédric Jeanneret
64aee82ad8 Rename and update links related to tripleo-ansible roles
During the latest cycles, role names were changed, replacing the hyphen
by underscore.

Change-Id: Ib62963bef59062ac9d81d0cf1f3972a08335af9d
2020-08-12 11:18:06 +02:00
Rabi Mishra
b01aaf15a3 Remove mistral related developer documentation
Change-Id: I301489c666545418d1e23c58ba75bc30e3db21b9
2020-05-05 08:15:44 +05:30
Emilien Macchi
6a3eb65d74 Document the existence of tripleo-container-manage Ansible role
Change-Id: I1f27402364ba1ecdb61b0796d543226ea7205c8f
Depends-On: https://review.opendev.org/703481
2020-01-20 20:44:38 +00:00
Emilien Macchi
ae718ec825 THT: add a link for THT deployment readme
This readme is useful for THT devs, let's make it more visible in
tripleo-docs.

Change-Id: I825e31d499f42ef24179492802e5a052be4195b7
2020-01-07 10:47:27 -05:00
Alex Schultz
24c60ef633 Update references to deploy-guide
Since we moved the installation items to the deploy-guide, we need to
make sure we properly reference the new locations.

Change-Id: Ic481bf333b868d32638e5970b18c367f9d23d45c
2019-08-22 09:23:30 -06:00
Alex Schultz
c6918e5da6 Migrate install to deploy-guide
The deployment guide is currently pointed at triplo-docs but it has been
requested that we actually publish a deployment guide. This change
extracts many of the installation doc pages and moves them into the
deploy-guide source tree.  Once the deploy-guide is published, we will
follow up to reference the deployment guide from tripleo-docs.

Change-Id: I0ebd26f014180a92c6cf4ab0929d99b2d860796f
2019-08-16 15:42:17 -06:00
Andreas Jaeger
7e80d90796 Fix some links
* Remove section on tripleo-incubator, this repo is retired.
* Replace docs.openstack.org/developer/X with current link
  docs.openstack.org/X, use https where missing.

Change-Id: I18ff11126a3608a736cbee08c746d91906477c31
2019-08-04 16:38:25 +02:00
Alex Schultz
cd3a8cb3b0 Update documentation around container params
We've changed some of the naming in the Train cycle and need to update
the docs to reflect the current state. Additionally adding notes about
the previous naming conventions.

Change-Id: Ica16b31f332f6b8559a14617126037407f4e8165
2019-07-03 11:32:02 -06:00
Carlos Camacho
449dd57547 Update openstack.org to opendev.org
We need to point now to opendev.org

Change-Id: I4f6e1c2d7ccc13c02e03b5333c30ca927756941e
2019-05-14 15:35:39 +02:00
Marios Andreou
98f9b120fb Adds python-tripleoclient/tripleo-common primer developer docs
Adds a primer for python-tripleoclient - where and how tripleo
commands are defined.

Change-Id: Ic5623ca18a6ea6710c660d7eb96c4e036acfb2c1
Related-Bug: 1804642
2019-04-08 10:54:57 +03:00
Dan Prince
4d8a2dc546 puppet/services -> deployments updates
Updates most of the puppet/services links which now live in
the t-h-t deployments directory.

Change-Id: I7ada61d432085538587f069cfc5256c5b42589b5
Related-Blueprint: services-yaml-flattening
2019-03-26 09:11:52 -04:00
Juan Antonio Osorio Robles
5fbda50eaf Add service template sections walkthough (part 3)
This adds some of the sections from the service template that are
container-related:

* puppet_config
* kolla_config
* docker_config
* docker_puppet_tasks

More patches are coming to describe the rest of the parameters.

Change-Id: Ib478748b50ab94d7e06fefc5a7247fb633423c09
Related-Bug: #1804642
2019-02-21 12:45:02 +02:00
Juan Antonio Osorio Robles
1d5e72b84e Add service template sections walkthough (part 2)
This adds some of the sections from the service template that are
ansible-related:

* host_prep_tasks
* deploy_steps_tasks
* external_deploy_tasks

While this list in not exhaustive (yet), it covers the most important
ones for folks to build their services.

More patches are coming to describe the rest of the parameters.

Change-Id: I207aeae6d425adbcfb04f7df2ad1e73e6f059706
Related-Bug: #1804642
2019-01-21 15:29:12 +02:00
Juan Antonio Osorio Robles
513a2fc3c9 Add service template sections walkthough (part 1)
This adds the first bit of going through all of the available sections
of the service templates. This will hopefully make it easier for folks
to know what's available and how to use it.

This first part adds the bare minimum you need to do to create a
service, and describes each section.

The rest of the sections will be added in subsequent patches.

Change-Id: I1c8e7f5a8967a68554f28a66d4a151c44d892247
Related-Bug: #1804642
2019-01-17 15:51:42 +02:00
Marios Andreou
452a0717d1 Tidy up tripleo docs merge contributor & developer guides
This merges the developer guide and contributor guide in index

Change-Id: I8743c5930aa46cde2735943b87e047e25ff169af
Related-Bug: #1804642
2019-01-16 19:25:42 +02:00
Juan Antonio Osorio Robles
ab6a95fe96 Move developer documentation to top level
It's harder to find as part of the install guide, and shouldn't be there
anyway.

Related-Bug: #1804642
Change-Id: Ia677ced783da6383211fb0bb7a28ec5fb2f538fe
2018-11-29 16:15:36 +02:00
Emilien Macchi
6cd603610b Update docs structure
The upstream docs structure is changing, so this change updates our
existing docs into contributor and install guide sections.

Change-Id: I37fabd25fdda6bc56fcfb331b74e3294e31e68bb
2017-07-07 20:04:52 +00:00
Emilien Macchi
fbf640bfdd First draft of TripleO Release Management document
Change-Id: Iacc7e320014f12feec695ab118fa95f4c2d2e387
2017-05-23 16:25:34 -04:00
Juan Antonio Osorio Robles
4f389ce8df Recommend using conditionals for TLS-everywhere
The documentation used to recommend having a nested template; however,
due to issues with nested stack limits and optimizations, several
commits changed the current services to use conditionals instead [1].

This patch reflects this change by recommending deployers to use
conditionals.

[1] https://review.openstack.org/#/q/status:merged+project:openstack/tripleo-heat-templates+branch:master+topic:conditional-instead-of-stack

Change-Id: I21e23e33faaeb8c4a212f3d450e80c7594f61b3a
2017-03-30 13:42:48 +03:00
Juan Antonio Osorio Robles
a86f16dc8f Add developer docs for internal TLS for services not based on httpd
This covers services that can be configured to use TLS and services that
need a TLS proxy.

bp tls-via-certmonger

Change-Id: If7b3e88e41c8bee3319780dbd65c38243bb3a729
2017-03-23 16:44:31 +00:00
Juan Antonio Osorio Robles
89e0bbd354 Small fixes for internal TLS docs
Change-Id: Ic36af672694a4c9903b2f94ef0bb354c1cd79767
2017-03-23 13:02:04 +02:00
Juan Antonio Osorio Robles
c06a64c79b Developer documentation of Internal TLS for httpd services
This documents the basic parts that developers need to know for enabling
internal TLS for their services, if their services run over httpd.

bp tls-via-certmonger

Change-Id: I1a9fb9d31800640a7e4482c08f74fd794141cffe
2017-03-23 10:32:23 +02:00
Juan Antonio Osorio Robles
e6d4c1a562 Add developer documentation for public TLS for services
This covers how to add services to be proxied by HAProxy and getting it
setting the appropriate options for public TLS to work for a service.

Change-Id: Ie553d9125b766cf890610d18c8090e4b8cb18537
2017-03-23 10:21:11 +02:00
Juan Antonio Osorio Robles
237b7f2d48 Update t-h-t walkthrough documentation
This updates the steps to reference the dynamic roles we now have.
Instead of the hardcoded ones.

It also documents the service_config_settings.

Change-Id: I83526fd46b5eb53a70436f2303550829ec096396
2017-03-22 15:45:43 +00:00
Petr Kovar
77f5365c8a Fix all sphinx errors & warnings
* tripleo-docs now passes sphinx-build -W test.
* Remove unneeded files.
* Don't mix toctree with includes to avoid duplicate labels.
* Add a common file for link references shared across docs.
* Make cross-references work across files.
* Move upload_single_image

Change-Id: I319e0d4e4dd03b7f769d9d38ad2829d6cc9a679a
Depends-On: I839a593df2116264112a6060f1f306910cfba197
2017-02-06 15:14:05 +01:00
Petr Kovar
51bac7d227 Fix a TBD, broken links and markup
Change-Id: I839a593df2116264112a6060f1f306910cfba197
2017-02-02 19:15:57 +01:00
Carlos Camacho
a7c07c3e88 Update references to overcloud-resource-registry-puppet.j2.yaml in docs
We moved overcloud-resource-registry-puppet.yaml
to be used with jinja2.

This patch updates the references to this file.

Change-Id: I074fa890d1a270267e968a2352cbdacf641c33ef
2016-11-25 16:52:27 +01:00
Ben Nemec
c796d38b6a Group advanced topics by type
We're getting to have a lot of "advanced" docs, and most of those
fit into one of a few categories.  This change separates the
advanced topics into one of the following categories:

-Feature Config
-Baremetal Node Config
-Backend Config
-Custom Config
-Developer Docs

Single image building is moved to post deployment since it's not
a normal part of the initial deployment.

Change-Id: I14e31469a533efbfe3c18c4bd11da8b3f8f455e6
2016-08-01 20:45:09 +00:00