openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
919 Commits 3 Branches 0 Tags 17 MiB
b21b0cadf0
Go to file
Steve Baker b21b0cadf0 Document container prepare workflow 
This docs change will result in switching over to the workflow driven
container prepare by doing the following:

- Only document calling "openstack tripleo container image prepare"
  when testing more complex ContainerImagePrepare parameters
- Remove reference to containers-default-parameters.yaml, replacing it
  in overcloud deploy with containers-prepare-parameter.yaml directly
- For minor updates, instruct users to check the contents of
  containers-prepare-parameter.yaml so they know what will happen during
  the minor update

This change does not cover major upgrades to Rocky since the major
upgrade docs are still on Queens.

The rocky major upgrade instructions should describe running
"openstack tripleo container image prepare default" then merging the result
with any customized containers-default-parameters.yaml which they had
in their previous deployment (in the common case, no merging will be
needed).

Change-Id: I3eca2beeeacb31994cb870e8d4c5f3ba01051078
Blueprint: container-prepare-workflow
2018-09-05 13:48:34 +12:00
_custom Update docs for deploying Queens 2018-03-08 12:39:31 -07:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Update docs structure 2017-07-07 20:04:52 +00:00
doc/source Document container prepare workflow 2018-09-05 13:48:34 +12:00
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.gitreview Add .gitreview 2015-09-09 10:09:29 +01:00
.zuul.yaml import zuul job settings from project-config 2018-08-24 04:59:13 +00:00
README.rst Replace the old links in docs 2018-02-27 01:23:16 -08:00
requirements.txt Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Replace the old links in docs 2018-02-27 01:23:16 -08:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Drop duplicate openstackdocstheme requirement 2018-01-29 13:50:47 -05:00
tox.ini fix tox python3 overrides 2018-07-16 07:47:47 +00:00

README.rst

Team and repository tags

image

TripleO Documentation

This is the documentation source for the TripleO project. You can read the generated documentation at TripleO Docs.

You can find out more about TripleO at the TripleO Wiki.

Getting Started

Documentation for the TripleO project is hosted on the OpenStack Gerrit site. You can view all open and resolved issues in the openstack/tripleo-docs project at TripleO Reviews.

General information about contributing to the OpenStack documentation available at OpenStack Documentation Contributor Guide

Quick Start

The following is a quick set of instructions to get you up and running by building the TripleO documentation locally. The first step is to get your Python environment configured. Information on configuring is available at Python Project Guide

Next you can generate the documentation using the following command. Be sure to run all the commands from within the recently checked out repository.

tox -edocs

Now you have the documentation generated for the various available formats from the local source. The resulting documentation will be available within the doc/build/ directory.