Improve Undercloud documentation

* Introduce .. code-block:: bash for better color formatting
* Improving formatting in accordance to rst standart
* Adding sudo rm -rf /var/cache/yum after yum clean all

Change-Id: Ia08f205ec880ebe0a972c99d730345d9140dbf46
This commit is contained in:
Sergii Golovatiuk 2018-04-13 12:53:04 +02:00
parent 7d376e6b09
commit c19410a838
2 changed files with 75 additions and 39 deletions

View File

@ -7,14 +7,16 @@ You can upgrade any packages that are installed on the undercloud machine.
.. note::
You may wish to backup your current repos before disabling them::
You may wish to backup your current repos before disabling them
mkdir /home/stack/REPOBACKUP
.. code-block:: bash
mkdir -p /home/stack/REPOBACKUP
sudo mv /etc/yum.repos.d/delorean* /home/stack/REPOBACKUP
::
.. code-block:: bash
sudo rm /etc/yum.repos.d/delorean*
sudo rm /etc/yum.repos.d/delorean*
#. Enable new Delorean repositories:
@ -24,9 +26,12 @@ You can upgrade any packages that are installed on the undercloud machine.
.. We need to manually continue our list numbering here since the above
"include" directive breaks the numbering.
3. Clean the yum cache to ensure only the new repos are used::
3. Clean the yum cache to ensure only the new repos are used
sudo yum clean all
.. code-block:: bash
sudo yum clean all
sudo rm -rf /var/cache/yum
#. Update required package:
@ -36,9 +41,11 @@ You can upgrade any packages that are installed on the undercloud machine.
It is strongly recommended that you validate the state of your undercloud
before starting any upgrade operations. The tripleo-validations_ repo has
some 'pre-upgrade' validations that you can execute by following the
instructions at validations_ to execute the "pre-upgrade" group::
instructions at validations_ to execute the "pre-upgrade" group
mistral execution-get-output $(openstack workflow execution create -f value -c ID tripleo.validations.v1.run_groups '{"group_names": ["pre-upgrade"]}')
.. code-block:: bash
mistral execution-get-output $(openstack workflow execution create -f value -c ID tripleo.validations.v1.run_groups '{"group_names": ["pre-upgrade"]}')
.. admonition:: Newton to Ocata
:class: ntoo
@ -74,22 +81,28 @@ You can upgrade any packages that are installed on the undercloud machine.
the Ocata to Pike upgrade.
Update TripleO CLI package::
Update TripleO CLI package
.. code-block:: bash
sudo yum update python-tripleoclient
#. Run the undercloud upgrade command. This command will upgrade all packages
and use puppet to apply new configuration and restart all OpenStack
services::
services
.. code-block:: bash
openstack undercloud upgrade
.. note::
You may wish to use time and capture the output to a file for any debug::
You may wish to use time and capture the output to a file for any debug
time openstack undercloud upgrade 2>&1 | tee undercloud_upgrade.log
.. code-block:: bash
time openstack undercloud upgrade 2>&1 | tee undercloud_upgrade.log
.. note::

View File

@ -2,15 +2,18 @@
Download and install the python2-tripleo-repos RPM from
`the current RDO repository <https://trunk.rdoproject.org/centos7/current/>`_.
For example::
For example
sudo yum install -y https://trunk.rdoproject.org/centos7/current/python2-tripleo-repos-<version>.el7.centos.noarch.rpm
.. code-block:: bash
.. note:: tripleo-repos removes any repositories that it manages before each
run. This means all repositories must be specified in a single
tripleo-repos call. As an example, the correct way to install the
current and ceph repos is to run ``tripleo-repos current ceph``,
not two separate calls.
sudo yum install -y https://trunk.rdoproject.org/centos7/current/python2-tripleo-repos-<version>.el7.centos.noarch.rpm
.. note::
tripleo-repos removes any repositories that it manages before each run.
This means all repositories must be specified in a single tripleo-repos
call. As an example, the correct way to install the current and ceph repos
is to run ``tripleo-repos current ceph``, not two separate calls.
.. admonition:: Stable Branch
:class: stable
@ -21,76 +24,96 @@ For example::
.. admonition:: Newton
:class: newton mton
Enable the current Newton repositories::
Enable the current Newton repositories
.. code-block:: bash
sudo -E tripleo-repos -b newton current
.. admonition:: Ceph
:class: ceph
Include the Ceph repo in the tripleo-repos call::
Include the Ceph repo in the tripleo-repos call
sudo -E tripleo-repos -b newton current ceph
.. code-block:: bash
sudo -E tripleo-repos -b newton current ceph
.. admonition:: Ocata
:class: ocata ntoo
Enable the current Ocata repositories::
Enable the current Ocata repositories
sudo -E tripleo-repos -b ocata current
.. code-block:: bash
sudo -E tripleo-repos -b ocata current
.. admonition:: Ceph
:class: ceph
Include the Ceph repo in the tripleo-repos call::
Include the Ceph repo in the tripleo-repos call
.. code-block:: bash
sudo -E tripleo-repos -b ocata current ceph
.. admonition:: Pike
:class: pike otop
Enable the current Pike repositories::
Enable the current Pike repositories
sudo -E tripleo-repos -b pike current
.. code-block:: bash
sudo -E tripleo-repos -b pike current
.. admonition:: Ceph
:class: ceph
Include the Ceph repo in the tripleo-repos call::
Include the Ceph repo in the tripleo-repos call
sudo -E tripleo-repos -b pike current ceph
.. code-block:: bash
sudo -E tripleo-repos -b pike current ceph
.. admonition:: Queens
:class: queens ptoq
Enable the current Queens repositories::
Enable the current Queens repositories
sudo -E tripleo-repos -b queens current
.. code-block:: bash
sudo -E tripleo-repos -b queens current
.. admonition:: Ceph
:class: ceph
Include the Ceph repo in the tripleo-repos call::
Include the Ceph repo in the tripleo-repos call
sudo -E tripleo-repos -b queens current ceph
.. code-block:: bash
sudo -E tripleo-repos -b queens current ceph
.. warning::
The remaining repositories configuration steps below should not be done for stable
releases!
The remaining repositories configuration steps below should not be done for
stable releases!
Run tripleo-repos to install the appropriate repositories. The option below
will enable the latest master TripleO packages and the latest promoted
packages for all other OpenStack services and dependencies. There are other
repository configurations available in tripleo-repos, see its --help output
for details.
::
sudo -E tripleo-repos current-tripleo-dev
.. code-block:: bash
sudo -E tripleo-repos current-tripleo-dev
.. admonition:: Ceph
:class: ceph
Include the Ceph repository in the tripleo-repos command::
Include the Ceph repository in the tripleo-repos command
sudo -E tripleo-repos current-tripleo-dev ceph
.. code-block:: bash
sudo -E tripleo-repos current-tripleo-dev ceph