openstack/openstack-ansible
Code Issues Proposed changes

Ensure that RDO/SUSE series repo instructions stay up to date

Browse Source 
The deployment host documentation gets out of date really quickly.
This patch makes it self maintaining. Note that due to the fact
that RDO/SUSE do not implement their repositories for a new
release until much, much later in the cycle, we use the previous
release repo for master. This will self-update during our RC
when the stable branch is cut.

Some formatting adjustments have made to prevent the interpretation
of URL's as links by sphinx and to remove the use of multi-line shell
commands.

Closes-Bug: #1759721
Change-Id: Id28540d335390a52e0eb65a734a1d594235265d6
This commit is contained in:
Jesse Pretorius 2018-04-03 17:48:13 +01:00
parent 8662acf5ec
commit ca49f4121e
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
deploy-guide/source/conf.py
View File

@ -47,20 +47,27 @@ current_series = openstackdocstheme.ext._get_series_name()
if current_series == "latest": if current_series == "latest":
watermark = "Pre-release" watermark = "Pre-release"
latest_tag = "master" latest_tag = "master"
rdo_series = previous_series_name
suse_series = previous_series_name.capitalize()
else: else:
watermark = series_names = current_series.capitalize() watermark = series_names = current_series.capitalize()
latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n') latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n')
rdo_series = current_series_name
suse_series = current_series_name.capitalize()
deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(current_series) deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(current_series)
dev_docs_prefix = "http://docs.openstack.org/openstack-ansible/{}/%s".format(current_series) dev_docs_prefix = "http://docs.openstack.org/openstack-ansible/{}/%s".format(current_series)
role_docs_prefix = "http://docs.openstack.org/openstack-ansible-%s/{}".format(current_series) role_docs_prefix = "http://docs.openstack.org/openstack-ansible-%s/{}".format(current_series)
# Substitutions loader # Substitutions loader
rst_epilog = """ rst_epilog = """
.. |latest_tag| replace:: {latest_tag} .. |latest_tag| replace:: {latest_tag}
.. |rdo_series| replace:: {rdo_series}
.. |suse_series| replace:: {suse_series}
""".format( """.format(
latest_tag=latest_tag, latest_tag=latest_tag,
rdo_series=rdo_series,
suse_series=suse_series
) )
# Format: Reference name: (string containing %s for substitution, linkname) # Format: Reference name: (string containing %s for substitution, linkname)

23
deploy-guide/source/deploymenthost.rst
View File

@ -59,8 +59,7 @@ Before you begin, we recommend upgrading your system packages and kernel.
.. code-block:: shell-session .. code-block:: shell-session
# apt-get install aptitude build-essential git ntp ntpdate \ # apt-get install aptitude build-essential git ntp ntpdate openssh-server python-dev sudo
openssh-server python-dev sudo
#. Configure NTP to synchronize with a suitable time source. #. Configure NTP to synchronize with a suitable time source.
@ -81,11 +80,10 @@ Before you begin, we recommend upgrading your system packages and kernel.
#. Install additional software packages if they were not installed #. Install additional software packages if they were not installed
during the operating system installation: during the operating system installation:
.. code-block:: shell-session .. parsed-literal::
# yum install https://rdoproject.org/repos/openstack-pike/rdo-release-pike.rpm # yum install \https://rdoproject.org/repos/openstack-|rdo_series|/rdo-release-|rdo_series|.rpm
# yum install git ntp ntpdate openssh-server python-devel \ # yum install git ntp ntpdate openssh-server python-devel sudo '\@Development Tools'
sudo '@Development Tools'
#. Configure NTP to synchronize with a suitable time source. #. Configure NTP to synchronize with a suitable time source.
@ -123,11 +121,10 @@ Before you begin, we recommend upgrading your system packages and kernel.
#. Install additional software packages if they were not installed #. Install additional software packages if they were not installed
during the operating system installation: during the operating system installation:
.. code-block:: shell-session .. parsed-literal::
# zypper ar http://download.opensuse.org/repositories/Cloud:/OpenStack:/Pike/openSUSE_Leap_42.3 OBS:Cloud:OpenStack:Pike # zypper ar \http://download.opensuse.org/repositories/Cloud:/OpenStack:/|suse_series|/openSUSE_Leap_42.3 OBS:Cloud:OpenStack:|suse_series|
# zypper install git-core ntp openssh python-devel \ # zypper install git-core ntp openssh python-devel sudo gcc libffi-devel libopenssl-devel
sudo gcc libffi-devel libopenssl-devel
#. Configure NTP to synchronize with a suitable time source. #. Configure NTP to synchronize with a suitable time source.
@ -176,16 +173,14 @@ Install the source and dependencies for the deployment host.
.. parsed-literal:: .. parsed-literal::
# git clone -b |latest_tag| https://git.openstack.org/openstack/openstack-ansible \\ # git clone -b |latest_tag| \https://git.openstack.org/openstack/openstack-ansible /opt/openstack-ansible
/opt/openstack-ansible
If git.openstack.org can not be accessed to run git clone, github.com can be used If git.openstack.org can not be accessed to run git clone, github.com can be used
as an alternative repo: as an alternative repo:
.. parsed-literal:: .. parsed-literal::
# git clone -b |latest_tag| https://github.com/openstack/openstack-ansible.git \\ # git clone -b |latest_tag| \https://github.com/openstack/openstack-ansible.git /opt/openstack-ansible
/opt/openstack-ansible
#. Change to the ``/opt/openstack-ansible`` directory, and run the #. Change to the ``/opt/openstack-ansible`` directory, and run the
Ansible bootstrap script: Ansible bootstrap script: