openstack/tripleo-docs
Code Issues Proposed changes

Update references to deploy-guide

Browse Source 
Since we moved the installation items to the deploy-guide, we need to
make sure we properly reference the new locations.

Change-Id: Ic481bf333b868d32638e5970b18c367f9d23d45c
This commit is contained in:
Alex Schultz 2019-08-22 09:15:25 -06:00
parent 4296ccbff3
commit 24c60ef633
12 changed files with 69 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/ci/baremetal_jobs.rst
View File

@ -3,11 +3,8 @@ Baremetal jobs
This section gives an overview and some details on the baremetal CI jobs. The
baremetal deployment is intended as a multinode real world "production-like"
environment for TripleO.
.. TODO(aschultz): fix this when deploy-guide is published
.. - see :doc:`../install/environments/baremetal`
.. for more information on setting up a baremetal environment.
environment for TripleO. - see `Baremetal deploy guide <baremetal_deploy_guide_>`_
for more information on setting up a baremetal environment.
The baremetal jobs, previously running in the RDO Phase 2 of the promotion
pipeline from Jenkins servers, now are triggered from an internal Software
@ -20,6 +17,7 @@ have better coverage on issues seen in production environments. It also
allows an aproximation of OVB jobs running in RDO cloud in order to get an
"apples-to-apples" comparison to eliminate infra issues.
.. _baremetal_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/provisioning/index.html
Where
-----
@ -27,7 +25,7 @@ Where
The hardware is maintained internally and cannot be accessed by upstream
Zuul or RDO Cloud. The internal Software Factory instance provides a version
of infra upstream tools as Zuul, Gerrit and Nodepool for running the defined
baremetal jobs. Refer to `Software_Factory_documentation_` for more details.
baremetal jobs. Refer to `Software Factory Documentation <Software_Factory_documentation_>`_ for more details.
The jobs will use hardware_environments/<env name>/instackenv.json file and the
hardware_environments/<env name>/network_configs/single_nic_vlans settings file.

8
doc/source/ci/standalone_scenario_jobs.rst
View File

@ -3,11 +3,8 @@ Standalone Scenario jobs
This section gives an overview and some details on the standalone scenario ci
jobs. The standalone deployment is intended as a one node development
environment for TripleO.
.. TODO(aschultz): fix this when deploy-guide is published
.. - see :doc:`../install/containers_deployment/standalone`
.. for more information on setting up a standalone environment.
environment for TripleO. - see the `Standalone Deploy Guide <standalone_deploy_guide_>`_
for more information on setting up a standalone environment.
A 'scenario' is a concept used in TripleO
to describe a collection of services - see the service-testing-matrix_ for more
@ -23,6 +20,7 @@ the multinode jobs to the more resource friendly standalone versions.
.. _service-testing-matrix: https://github.com/openstack/tripleo-heat-templates/blob/master/README.rst#service-testing-matrix
.. _openstack-dev-thread: http://lists.openstack.org/pipermail/openstack-dev/2018-October/136192.html
.. _standalone_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/standalone.html
Where

8
doc/source/developer/tht_walkthrough/tls_for_services.rst
View File

@ -224,9 +224,8 @@ Internal TLS
How it works
~~~~~~~~~~~~
.. TODO(aschultz): fix this when deployment guide is published
.. If you haven't read the section :doc:`../../install/advanced_deployment/tls_everywhere`
.. it is highly recommended you read that first before continuing.
If you haven't read the section `TLS Everywhere <tls_everywhere_deploy_guide_>`_
it is highly recommended you read that first before continuing.
As mentioned, the default CA is FreeIPA, which issues the certificates that the
nodes request, and they do the requests via certmonger.
@ -390,8 +389,9 @@ stack already outputs. This will give the appropriate parameters to a hook that
sets the nova metadata, which in turn will be taken by the *novajoin* service
generate the service principals for httpd for the host.
.. TODO(aschultz): add See deployment guide tls_everywhere link
See the `TLS Everywhere Deploy Guide <tls_everywhere_deploy_guide_>`_
.. _tls_everywhere_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/ssl.html#tls-everywhere-for-the-overcloud
.. _configuring-haproxy-internal-tls:
Configuring HAProxy to use TLS for your service

10
doc/source/developer/tripleoclient_primer.rst
View File

@ -19,12 +19,12 @@ The example used here is::
openstack overcloud container image build
This command is used to build the container images listed in the
tripleo-common file overcloud_containers.yaml_ using Kolla_.
tripleo-common file overcloud_containers.yaml_ using Kolla_.
.. TODO(aschultz): update with deployment guide link
.. See :doc:`Building
.. Containers</install/containers_deployment/3rd_party>` for more information on
.. how to use this command as an operator.
See the `Building Containers Deploy Guide <building_containers_deploy_guide_>`_ for more information on
how to use this command as an operator.
.. _building_containers_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/3rd_party.html
One of the TipleO CI jobs that executes this command is the
tripleo-build-containers-centos-7_ job. This job invokes the overcloud container

12
doc/source/install/advanced_deployment/deploy_openshift.rst
View File

@ -14,10 +14,9 @@ Define the OpenShift roles
TripleO installs OpenShift services using composable roles for
`OpenShiftMaster`, `OpenShiftWorker`, and `OpenShiftInfra`. When you import
a baremetal node using `instackenv.json`, you can tag it to use a certain
composable role.
composable role. See `Custom Roles <custom_roles_deploy_guide_>`_ for more information.
.. TODO(aschultz): update this with deploy guide link
.. See :doc:`custom_roles` for more information.
.. _custom_roles_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/custom_roles.html
1. Generate the OpenShift roles:
@ -148,9 +147,10 @@ This procedure describes how to enroll a physical node as an OpenShift node.
Configure the container registry
********************************
.. TODO(aschultz): include reference to deploy guide
.. Follow :doc:`container_image_prepare` to configure TripleO for the container
.. image preparatio.
Follow `container image preparation <container_image_preparation_deploy_guide_>`_ to configure TripleO for the
container image preparation.
.. _container_image_preparation_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/container_image_prepare.html
This generally means generating a `/home/stack/containers-prepare-parameter.yaml` file:

6
doc/source/install/deploy-guide.rst Normal file
View File

@ -0,0 +1,6 @@
Deploy Guide
============
The installation instructions have been moved to the `TripleO Deploy Guide <tripleo_deploy_guide_>`_.
.. _tripleo_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/

31
doc/source/install/deprecated/basic_deployment_ui.rst
View File

@ -27,24 +27,28 @@ The validations are optional but strongly recommended.
#. Make sure you have your environment ready and undercloud running:
.. TODO(aschultz): Update reference to deploy guide
.. * :doc:`../environments/environments`
.. * :doc:`../installation/installing`
* `Environment Setup <environment_setup_deploy_guide_>`_
* `Undercloud Installation <undercloud_installation_deploy_guide_>`_
.. _environment_setup_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/environments/index.html
.. _undercloud_installation_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/install_undercloud.html
#. Make sure the images are uploaded in Glance on the undercloud:
.. TODO(aschultz): Update reference to deploy guide
.. * :ref:`basic-deployment-cli-get-images`
.. * :ref:`basic-deployment-cli-upload-images`
* `Get Images <get_images_deploy_guide_>`_
* `Upload Images <upload_images_deploy_guide_>`_
.. _get_images_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/install_overcloud.html#get-images
.. _upload_images_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/install_overcloud.html#upload-images
Access the UI
-------------
The UI is accessible on the undercloud URL. With the default settings
the URLs may look like the following, depending on whether the
undercloud was set up with SSL:
undercloud was set up with `SSL <undercloud_ssl_>`_:
.. TODO(aschultz): update reference to deploy guide` <../advanced_deployment/ssl>`:
.. _undercloud_ssl: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/ssl.html#undercloud-ssl
* http://192.168.24.1:3000 if it was not
* https://192.168.24.2 if set up with SSL
@ -141,8 +145,9 @@ Register Nodes
Navigate to the **Nodes** tab in the top bar and click on the
*Register Nodes* button. New nodes can be added in two ways:
.. TODO(aschultz): update with reference to deploy guide
.. * Importing an :ref:`instackenv.json <instackenv>` file
* Importing an `instackenv.json <instackenv_file_>`_ file
.. _instackenv_file: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/environments/baremetal.html#instackenv-json
* Importing an instackenv.json file
* Manually defining nodes via the *Add New* button.
@ -161,9 +166,9 @@ Once introspection is completed, nodes need to be "provided" in order
to move to the ``available`` state and be available for
deployments. Select the nodes and click on the *Provide Nodes* button.
.. TODO(aschultz): update this reference to deploy guide
.. #.. note:: For more information about node states, see
.. # :doc:`../advanced_deployment/node_states`.
.. note:: For more information about node states, see `Node States <node_states_>`_.
.. _node_states: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/provisioning/node_states.html
Tag Nodes
^^^^^^^^^

2
doc/source/install/index.rst
View File

@ -6,6 +6,8 @@ TripleO Install Guide
:includehidden:
introduction/introduction
deploy-guide
deprecated/basic_deployment_ui
advanced_deployment/features
advanced_deployment/custom

6
doc/source/install/introduction/architecture.rst
View File

@ -252,11 +252,9 @@ unusable.
This second mode allows users to ensure that their different hardware types end
up running their intended role, though requires either manual node tagging or
using introspection rules to tag nodes
.. TODO(aschutlz): update reference to deploy guide
.. (see :doc:`../advanced_deployment/profile_matching`).
using introspection rules to tag nodes (see `Profile Matching <profile_matching_deploy_guide_>`_).
.. _profile_matching_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/provisioning/profile_matching.html
Deployment Planning

6
doc/source/install/introduction/introduction.rst
View File

@ -25,6 +25,12 @@ few other open source plugins which increase |project|'s capabilities.
Go to :doc:`components` to learn more.
**Deployment Guide**
See additional information about how to deploy TripleO in the `Deploy Guide <tripleo_deploy_guide_>`_.
.. _tripleo_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/
.. toctree::
:hidden:

10
doc/source/upgrade/developer/upgrades/fast_fw_upgrade.rst
View File

@ -2,11 +2,11 @@ TripleO Fast Forward Upgrade (FFU) N -> N+3
----------------------------------------------------
For a detailed background on how the Fast Forward Upgrade (FFU) workflow was
proposed please refer to the relevant spec_.
proposed please refer to the relevant spec_.
.. TODO(aschultz): update to deployment guide
.. For a guide on running the FFU in
.. your environment see the :ref:`ffu-docs`.
For a guide on running the FFU in your environment see the `FFU Deploy Guide <ffu_deploy_guide_>`_.
.. _ffu_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/post_deployment/upgrade/fast_forward_upgrade.html
This document will explore some
of the technical details of the Newton to Queens FFU specifically.
@ -68,7 +68,7 @@ Ceph related upgrade and deployment will be applied here with calls to
ceph-ansible_.
Amongst other things, the P..Q upgrade_tasks stop and disable those systemd
services that are being migrated to run in containers. The Queens deploy_steps_playbook_
services that are being migrated to run in containers. The Queens `deploy steps playbook <deploy_steps_playbook_>`_
will then apply the required puppet and docker configuration to start the
containers for those services. For this to be possible the Heat stack update
which starts step 3 and that generates the ansible playbooks must include the

16
doc/source/upgrade/developer/upgrades/major_upgrade.rst
View File

@ -4,10 +4,9 @@ Overcloud Major Upgrade Workflow and CLI
The purpose of this documentation is to deep-dive into the code which
delivers the major upgrade workflow in TripleO. For information about
the steps an operator needs to perform when running this upgrade
please see the overator docs.
please see the `operator docs <major_upgrade_deploy_guide_>`_.
.. TODO(aschultz): Update to deploy guide
.. :doc:`operator docs</upgrade/major_upgrade>`.
.. _major_upgrade_deploy_guide: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/post_deployment/upgrade/major_upgrade.html
The major upgrade workflow is delivered almost exclusively via Ansible
playbook invocations on the overcloud nodes. Heat is used to generate
@ -81,10 +80,9 @@ the `overcloud deploy` command. It is especially important that the
operator includes the environment file containing the references for
the target version container images.
.. TODO(aschultz): update to deploy guide
.. See the doc:`operator docs</upgrade/major_upgrade>` for
.. pointers to how that file is generated and for reference it will look
.. something like
See the `operator docs <major_upgrade_deploy_guide_>`_ for
pointers to how that file is generated and for reference it will look
something like
.. code-block:: bash
@ -143,7 +141,9 @@ ansible inventory based on the Heat stack outputs, so that for example
``Controller`` and ``overcloud-controller-0`` are both valid values for
the ansible-playbook |--limit| parameter.
.. TODO(aschultz): add ref to deploy-guide "openstack overcloud upgrade run"
See `overcloud upgrade run <overcloud_upgrade_run_>`_ for additional information.
.. _overcloud_upgrade_run: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/post_deployment/upgrade/major_upgrade.html#openstack-overcloud-upgrade-run
As documented in the major upgrade documentation and the nodes_or_roles_helptext_,
the operator *must* use ``--roles`` for the controllers. Upgrading the