tripleo-docs/doc/source/index.rst
Ben Nemec 7f6cb26fa2 Add Liberty and Mitaka admonitions and use them
Many of our stable branch steps are actually specific to one branch,
so instead of having to remember to note that in the text of those
sections, let's just have an admonition that makes the version
explicit.

This also corrects the repo setup steps to separate the Liberty and
Mitaka repos, and moves the branch options to their own section in
the environment selector.

I did not touch the image building repo setup yet because I plan
to change that in a follow-up commit anyway so it matches what we
actually do in tripleo.sh/CI.

Change-Id: I871651f0dd782ad51127d5ef0b01be3806272820
2016-07-08 20:50:13 +00:00

2.4 KiB

Welcome to documentation

Contents:

introduction/introduction environments/environments installation/installation basic_deployment/basic_deployment_cli advanced_deployment/advanced_deployment post_deployment/post_deployment troubleshooting/troubleshooting tht_walkthrough/tht_walkthrough contributions/contributions

Documentation Conventions

Some steps in the following instructions only apply to certain environments, such as deployments to real baremetal and deployments using Red Hat Enterprise Linux (RHEL). These steps are marked as follows:

RHEL

Step that should only be run when using RHEL

RHEL Portal Registration

Step that should only be run when using RHEL Portal Registration

RHEL Satellite Registration

Step that should only be run when using RHEL Satellite Registration

CentOS

Step that should only be run when using CentOS

Baremetal

Step that should only be run when deploying to baremetal

Virtual

Step that should only be run when deploying to virtual machines

Ceph

Step that should only be run when deploying Ceph for use by the Overcloud

Source

Step that should only be run when choosing to use some components directly from their git source code repositories instead of packages.

Stable Branch

Step that should only be run when choosing to use components from their stable branches rather than using packages/source based on current master.

Liberty

Step that should only be run when installing from the Liberty stable branch.

Mitaka

Step that should only be run when installing from the Mitaka stable branch.

SSL

Step that should only be run when deploying with SSL OpenStack endpoints

Self-Signed SSL

Step that should only be run when deploying with SSL and a self-signed certificate.

Any such steps should not be run if the target environment does not match the section marking.