tripleo-docs/doc/source/index.rst
Marios Andreou 566efcd81e Move CI docs from contributor guide into new CI guide
Creates a new CI guide in the index and moves all the ci docs
from under the contributor index where they currently live.  This makes
it easier to find CI related docs and also makes the contributor guide
index significantly shorter and so again easier to navigate for newcomer

Change-Id: I8a2c6df43e23bed7572cc81929d0086335f6eb7a
Related-Bug: #1804642
2019-01-31 09:41:08 +00:00

2.8 KiB

Welcome to documentation

TripleO is a project aimed at installing, upgrading and operating OpenStack clouds using OpenStack's own cloud facilities as the foundation - building on Nova, Ironic, Neutron and Heat to automate cloud management at datacenter scale

Contributor Guide

contributor/index developer/index

Tripleo CI Guide

ci/index

Install Guide

install/index

Upgrades/Updates/FFWD-Upgrade

upgrade/index

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

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.

Ocata

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

Pike

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

Queens

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

Rocky

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

Validations

Steps that will run the pre and post-deployment validations

Optional Feature

Step that is optional. A deployment can be done without these steps, but they may provide useful additional functionality.

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