Pike and later¶
Each official OpenStack project should maintain an installation guide
following the layout described in Project guide setup. When the guide is
openstack-manuals/www/project-data/latest.yaml to include
information about the project and ensure that the
has_install_guide flag is set to
true to ensure that the guide
is listed along with the guides from other projects.
Newton and Ocata¶
For the Newton and Ocata releases only, big tent projects created their own installation guides, based on a standard template, in their own repository. These guides were then centrally published to docs.openstack.org.
The following instructions are superseded by Project guide setup. New installation guides should be created using the layout defined in the spec, rather than the following instructions.
Set up project specific installation guides:
# pip install cookiecutter
Run the Install Guide cookiecutter in the top-level directory of your projects repository to create a skeleton for the install guide of your project:
$ cookiecutter https://opendev.org/openstack/installguide-cookiecutter.git
You will be prompted to answer the following questions to complete the installation:
The name of the install guide directory inside the project repository. This should be,
The service name what the project implements.
Compute, Telemetry Alarming, or Root Cause Analysis
The name how the different components of the project are refering to the project
nova, aodh, or vitrage as in nova-conductor or vitrage-api
A directory will be created with the name that was defined in
install-guide) with the skeleton of the install guide.
install-guidein your project repository, using this content:
[testenv:install-guide] whitelist_externals = rm commands = rm -rf install-guide/build sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
Add the python package
test-requirements.txtfile. Copy the exact requirement line from the global file:
openstackdocstheme>=1.5.0 # Apache-2.0
Add your installation content, and test the build locally with
$ tox -e install-guide
The local build will be generated in the
Commit the changes to your project repository for review.
After these changes have merged, you can set up the jobs for building.
$ git clone https://opendev.org/openstack/project-config
install-guide-jobswithin the entry for your project:
- project: name: heat jobs: ... - install-guide-jobs: service: orchestration
serviceis the service name of the project, like orchestration for heat.
This defines the jobs using the JJB
zuul/layout.yaml, locate the entry for your project and add the
- name: openstack/heat template: - name: install-guide-jobs
This schedules the Install Guide jobs.
Commit the changes to the infra repository for review.