From 1b3231d83ca2936da020173189020107f8dae690 Mon Sep 17 00:00:00 2001 From: Markus Zoeller Date: Fri, 15 Sep 2017 14:00:47 -0600 Subject: [PATCH] docs: installation: remove unnecessary blockquotes Due to missing spaces, some of the content in the installation guide is displayed as blockquote without being really quoted content. This change adds the needed spaces to remove the generated HTML blockquotes. The repositories.txt file gets included at different locations and that file contained the formatting spaces which were needed from the location which includes that file. It's most of the time better to do the indentation at the ".. include" level and leave the file which gets included *without* indentation. Because here, the indentation in the included file worked for some includes but not for all, because the content got used at different indentation levels. That made it necessary to touch the includes in basic_deployment and post_deployment too. Follow up patches will deal with the other install guide sections more in details. Change-Id: Ie2e7fea6d92f7742d23e22452e394b8ff40975eb --- .../basic_deployment/basic_deployment_cli.rst | 2 +- .../install/installation/installing.rst | 65 +++++------ doc/source/install/installation/updating.rst | 16 +-- .../install/post_deployment/upgrade.rst | 2 +- doc/source/install/repositories.txt | 102 +++++++++--------- 5 files changed, 94 insertions(+), 93 deletions(-) diff --git a/doc/source/install/basic_deployment/basic_deployment_cli.rst b/doc/source/install/basic_deployment/basic_deployment_cli.rst index 815b248d..c2777f9a 100644 --- a/doc/source/install/basic_deployment/basic_deployment_cli.rst +++ b/doc/source/install/basic_deployment/basic_deployment_cli.rst @@ -94,7 +94,7 @@ created on the undercloud, one should use a non-root user. #. Install the ``current-tripleo`` delorean repository and deps repository: -.. include:: ../repositories.txt + .. include:: ../repositories.txt 3. Export environment variables diff --git a/doc/source/install/installation/installing.rst b/doc/source/install/installation/installing.rst index 73d4db05..63bc3b7d 100644 --- a/doc/source/install/installation/installing.rst +++ b/doc/source/install/installation/installing.rst @@ -48,15 +48,15 @@ Installing the Undercloud #. Enable needed repositories: - .. admonition:: RHEL - :class: rhel + .. admonition:: RHEL + :class: rhel - Enable optional repo:: + Enable optional repo:: - sudo yum install -y yum-utils - sudo yum-config-manager --enable rhelosp-rhel-7-server-opt + sudo yum install -y yum-utils + sudo yum-config-manager --enable rhelosp-rhel-7-server-opt -.. include:: ../repositories.txt + .. include:: ../repositories.txt .. We need to manually continue our list numbering here since the above "include" directive breaks the numbering. @@ -80,45 +80,46 @@ Installing the Undercloud cp /usr/share/instack-undercloud/undercloud.conf.sample ~/undercloud.conf - .. TODO(bnemec): Find a more permanent location for this tool. - .. note:: There is a tool available that can help with writing a basic - undercloud.conf: - `Undercloud Configuration Wizard `_ - It takes some basic information about the intended overcloud - environment and generates sane values for a number of the important - options. + .. TODO(bnemec): Find a more permanent location for this tool. + + .. note:: There is a tool available that can help with writing a basic + undercloud.conf: + `Undercloud Configuration Wizard `_ + It takes some basic information about the intended overcloud + environment and generates sane values for a number of the important + options. #. Run the command to install the undercloud: - .. admonition:: Source - :class: source + .. admonition:: Source + :class: source - Git checkouts of the puppet modules can be used instead of packages. Export the - following environment variable:: + Git checkouts of the puppet modules can be used instead of packages. Export the + following environment variable:: - export DIB_INSTALLTYPE_puppet_modules=source + export DIB_INSTALLTYPE_puppet_modules=source - It is also possible to use this functionality to use an in-progress review - as part of the undercloud install. See - :doc:`../developer/in_progress_review` for details. + It is also possible to use this functionality to use an in-progress review + as part of the undercloud install. See + :doc:`../developer/in_progress_review` for details. - .. admonition:: SSL - :class: optional + .. admonition:: SSL + :class: optional - To deploy an undercloud with SSL, see :doc:`../advanced_deployment/ssl`. + To deploy an undercloud with SSL, see :doc:`../advanced_deployment/ssl`. - .. admonition:: Validations - :class: validations + .. admonition:: Validations + :class: validations - :doc:`../validations/validations` will be installed and - configured during undercloud installation. You can set - ``enable_validations = false`` in ``undercloud.conf`` to prevent - that. + :doc:`../validations/validations` will be installed and + configured during undercloud installation. You can set + ``enable_validations = false`` in ``undercloud.conf`` to prevent + that. - Install the undercloud:: + Install the undercloud:: - openstack undercloud install + openstack undercloud install Once the install has completed, you should take note of the files ``stackrc`` and diff --git a/doc/source/install/installation/updating.rst b/doc/source/install/installation/updating.rst index d33a45db..990c1d96 100644 --- a/doc/source/install/installation/updating.rst +++ b/doc/source/install/installation/updating.rst @@ -9,7 +9,7 @@ You can upgrade any packages that are installed on the undercloud machine. #. Enable new Delorean repositories: -.. include:: ../repositories.txt + .. include:: ../repositories.txt .. We need to manually continue our list numbering here since the above "include" directive breaks the numbering. @@ -25,14 +25,14 @@ You can upgrade any packages that are installed on the undercloud machine. .. admonition:: Stable Branch :class: stable - Stop services so that they are not restarted by packaging scripts - when they are updated. The service restarts will be handled by the - undercloud upgrade command after new configuration has been applied.:: + Stop services so that they are not restarted by packaging scripts + when they are updated. The service restarts will be handled by the + undercloud upgrade command after new configuration has been applied.:: - sudo systemctl stop openstack-* - sudo systemctl stop neutron-* - sudo systemctl stop openvswitch - sudo systemctl stop httpd + sudo systemctl stop openstack-* + sudo systemctl stop neutron-* + sudo systemctl stop openvswitch + sudo systemctl stop httpd #. Update the TripleO CLI package:: diff --git a/doc/source/install/post_deployment/upgrade.rst b/doc/source/install/post_deployment/upgrade.rst index 530b7829..a8238ff3 100644 --- a/doc/source/install/post_deployment/upgrade.rst +++ b/doc/source/install/post_deployment/upgrade.rst @@ -54,7 +54,7 @@ Upgrading the Undercloud Get and enable new repos for `NEW_VERSION`: -.. include:: ../repositories.txt + .. include:: ../repositories.txt 2. Run undercloud upgrade: diff --git a/doc/source/install/repositories.txt b/doc/source/install/repositories.txt index 99f5972d..7facb908 100644 --- a/doc/source/install/repositories.txt +++ b/doc/source/install/repositories.txt @@ -1,89 +1,89 @@ - .. admonition:: Stable Branch - :class: stable +.. admonition:: Stable Branch + :class: stable - Enable the appropriate repos for the desired release, as indicated below. - Do not enable any other repos not explicitly marked for that release. + Enable the appropriate repos for the desired release, as indicated below. + Do not enable any other repos not explicitly marked for that release. - .. admonition:: Newton - :class: newton mton + .. admonition:: Newton + :class: newton mton - Enable latest RDO Newton Delorean repository for all packages + Enable latest RDO Newton Delorean repository for all packages - :: + :: - sudo curl -L -o /etc/yum.repos.d/delorean-newton.repo https://trunk.rdoproject.org/centos7-newton/current/delorean.repo + sudo curl -L -o /etc/yum.repos.d/delorean-newton.repo https://trunk.rdoproject.org/centos7-newton/current/delorean.repo - Enable the Newton Delorean Deps repository + Enable the Newton Delorean Deps repository - :: + :: - sudo curl -L -o /etc/yum.repos.d/delorean-deps-newton.repo https://trunk.rdoproject.org/centos7-newton/delorean-deps.repo + sudo curl -L -o /etc/yum.repos.d/delorean-deps-newton.repo https://trunk.rdoproject.org/centos7-newton/delorean-deps.repo - .. admonition:: Ceph - :class: ceph + .. admonition:: Ceph + :class: ceph - Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph + Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph - :: + :: - sudo yum -y install --enablerepo=extras centos-release-ceph-jewel - sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo + sudo yum -y install --enablerepo=extras centos-release-ceph-jewel + sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo - .. admonition:: Ocata - :class: ocata ntoo + .. admonition:: Ocata + :class: ocata ntoo - Enable latest RDO Ocata Delorean repository for all packages + Enable latest RDO Ocata Delorean repository for all packages - :: + :: - sudo curl -L -o /etc/yum.repos.d/delorean-ocata.repo https://trunk.rdoproject.org/centos7-ocata/current/delorean.repo + sudo curl -L -o /etc/yum.repos.d/delorean-ocata.repo https://trunk.rdoproject.org/centos7-ocata/current/delorean.repo - Enable the Ocata Delorean Deps repository + Enable the Ocata Delorean Deps repository - :: + :: - sudo curl -L -o /etc/yum.repos.d/delorean-deps-ocata.repo https://trunk.rdoproject.org/centos7-ocata/delorean-deps.repo + sudo curl -L -o /etc/yum.repos.d/delorean-deps-ocata.repo https://trunk.rdoproject.org/centos7-ocata/delorean-deps.repo - .. admonition:: Ceph - :class: ceph + .. admonition:: Ceph + :class: ceph - Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph + Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph - :: + :: - sudo yum -y install --enablerepo=extras centos-release-ceph-jewel - sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo + sudo yum -y install --enablerepo=extras centos-release-ceph-jewel + sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo - Enable last known good RDO Trunk Delorean repository for core openstack packages +Enable last known good RDO Trunk Delorean repository for core openstack packages - :: +:: - sudo curl -L -o /etc/yum.repos.d/delorean.repo https://trunk.rdoproject.org/centos7-master/current-tripleo/delorean.repo + sudo curl -L -o /etc/yum.repos.d/delorean.repo https://trunk.rdoproject.org/centos7-master/current-tripleo/delorean.repo - Enable latest RDO Trunk Delorean repository only for the |project| packages +Enable latest RDO Trunk Delorean repository only for the |project| packages - :: +:: - sudo curl -L -o /etc/yum.repos.d/delorean-current.repo https://trunk.rdoproject.org/centos7/current/delorean.repo - sudo sed -i 's/\[delorean\]/\[delorean-current\]/' /etc/yum.repos.d/delorean-current.repo - sudo /bin/bash -c "cat <>/etc/yum.repos.d/delorean-current.repo + sudo curl -L -o /etc/yum.repos.d/delorean-current.repo https://trunk.rdoproject.org/centos7/current/delorean.repo + sudo sed -i 's/\[delorean\]/\[delorean-current\]/' /etc/yum.repos.d/delorean-current.repo + sudo /bin/bash -c "cat <>/etc/yum.repos.d/delorean-current.repo - includepkgs=diskimage-builder,instack,instack-undercloud,os-apply-config,os-collect-config,os-net-config,os-refresh-config,python-tripleoclient,openstack-tripleo-*,openstack-puppet-modules,puppet-* - EOF" + includepkgs=diskimage-builder,instack,instack-undercloud,os-apply-config,os-collect-config,os-net-config,os-refresh-config,python-tripleoclient,openstack-tripleo-*,openstack-puppet-modules,puppet-* + EOF" - Enable the Delorean Deps repository +Enable the Delorean Deps repository - :: +:: - sudo curl -L -o /etc/yum.repos.d/delorean-deps.repo https://trunk.rdoproject.org/centos7/delorean-deps.repo + sudo curl -L -o /etc/yum.repos.d/delorean-deps.repo https://trunk.rdoproject.org/centos7/delorean-deps.repo - .. admonition:: Ceph - :class: ceph +.. admonition:: Ceph + :class: ceph - Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph + Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph - :: + :: - sudo yum -y install --enablerepo=extras centos-release-ceph-jewel - sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo + sudo yum -y install --enablerepo=extras centos-release-ceph-jewel + sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo