From 96c6635a1596184fb982f8c599196c52101b6d05 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 4 Aug 2019 15:57:15 +0200 Subject: [PATCH] Update links Replace moved networking-guide with current location. Replace non-existing anchor in https://galeracluster.com with page link. Replace some more moved pages with new location. Fix many places to use https instead of http. Use internal RST link that can be verified instead of external one for /user/security/index.html. Checked with: sphinx-build -a -E -W -d doc/build/doctrees -b linkcheck doc/source doc/build/html Change-Id: I0368e509ba6702e0da1a9c96f7cee76a6d35b3e0 --- deploy-guide/source/conf.py | 6 +++--- .../admin/maintenance-tasks/ansible-modules.rst | 12 ++++++------ doc/source/admin/maintenance-tasks/galera.rst | 8 ++++---- doc/source/admin/troubleshooting.rst | 5 +++-- doc/source/conf.py | 4 ++-- doc/source/contributor/code-rules.rst | 8 ++++---- doc/source/contributor/contribute.rst | 4 ++-- doc/source/contributor/testing.rst | 6 +++--- .../reference/architecture/container-networking.rst | 2 +- doc/source/reference/architecture/manifesto.rst | 2 +- doc/source/reference/architecture/security.rst | 8 ++++---- doc/source/reference/architecture/storage-arch.rst | 4 ++-- doc/source/reference/inventory/inventory.rst | 2 +- doc/source/reference/inventory/manage-inventory.rst | 2 +- doc/source/user/ceph/full-deploy.rst | 2 +- doc/source/user/prod/gnocchi_redis.rst | 2 +- doc/source/user/security/hardening.rst | 2 +- doc/source/user/security/index.rst | 2 ++ doc/source/user/security/ssl-certificates.rst | 2 +- 19 files changed, 43 insertions(+), 40 deletions(-) diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index 1c2766481e..fcad507fa0 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -56,9 +56,9 @@ else: 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) -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) +deploy_guide_prefix = "https://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(current_series) +dev_docs_prefix = "https://docs.openstack.org/openstack-ansible/{}/%s".format(current_series) +role_docs_prefix = "https://docs.openstack.org/openstack-ansible-%s/{}".format(current_series) # Substitutions loader rst_epilog = """ diff --git a/doc/source/admin/maintenance-tasks/ansible-modules.rst b/doc/source/admin/maintenance-tasks/ansible-modules.rst index 13d41fee42..9f1c87417d 100644 --- a/doc/source/admin/maintenance-tasks/ansible-modules.rst +++ b/doc/source/admin/maintenance-tasks/ansible-modules.rst @@ -20,8 +20,8 @@ module. Modules can be used to control system resources, or handle the execution of system commands. For a more information about modules , see -`Module Index `_ and -`About Modules `_. +`Module Index `_ and +`About Modules `_. If you need to run a particular command against a subset of a group, you could use the limit flag ``-l``. For example, if a ``compute_hosts`` group @@ -41,8 +41,8 @@ only needed to execute a command on ``compute1`` and ``compute4``: Run the ad-hoc Ansible commands from the ``openstack-ansible/playbooks`` directory. -For more information, see `Inventory `_ -and `Patterns `_. +For more information, see `Inventory `_ +and `Patterns `_. Running the shell module ------------------------ @@ -75,7 +75,7 @@ to :command:`chdir=/home/user ls` when running Ansible from the CLI: $ ansible compute_hosts -m shell -a 'ls -la /home/user' For more information, see `shell - Execute commands in nodes -`_. +`_. Running the copy module ----------------------- @@ -84,7 +84,7 @@ The copy module copies a file on a local machine to remote locations. Use the fetch module to copy files from remote locations to the local machine. If you need variable interpolation in copied files, use the template module. For more information, see `copy - Copies files to remote locations -`_. +`_. The following example shows how to move a file from your deployment host to the ``/tmp`` directory on a set of remote machines: diff --git a/doc/source/admin/maintenance-tasks/galera.rst b/doc/source/admin/maintenance-tasks/galera.rst index 2c6e4cb6a9..2c9af90dd7 100644 --- a/doc/source/admin/maintenance-tasks/galera.rst +++ b/doc/source/admin/maintenance-tasks/galera.rst @@ -87,7 +87,7 @@ one of the nodes. # systemctl start mysql # systemctl set-environment _WSREP_NEW_CLUSTER='' - Please also have a look at `upstream starting a cluster page `_ + Please also have a look at `upstream starting a cluster page `_ This can also be done with the help of ansible using the shell module: @@ -163,8 +163,8 @@ fails, please review `restarting the cluster`_ and `recovering the primary component`_ in the galera documentation as they're invaluable for a full cluster recovery. -.. _restarting the cluster: http://galeracluster.com/documentation-webpages/restartingcluster.html -.. _recovering the primary component: http://galeracluster.com/documentation-webpages/pcrecovery.html +.. _restarting the cluster: https://galeracluster.com/library/training/tutorials/restarting-cluster.html +.. _recovering the primary component: https://galeracluster.com/documentation-webpages/pcrecovery.html Recover a single-node failure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -239,7 +239,7 @@ recover cannot join the cluster because it no longer exists. server indicates ``non-Primary`` because it cannot achieve quorum. #. Run the following command to - `rebootstrap `_ + `rebootstrap `_ the operational node into the cluster: .. code-block:: shell-session diff --git a/doc/source/admin/troubleshooting.rst b/doc/source/admin/troubleshooting.rst index 7b3b866c85..081f51e1c7 100644 --- a/doc/source/admin/troubleshooting.rst +++ b/doc/source/admin/troubleshooting.rst @@ -173,7 +173,7 @@ node and running the :command:`service status`. See the following links for additional information to verify OpenStack services: -- `Identity service (keystone) `_ +- `Identity service (keystone) `_ - `Image service (glance) `_ - `Compute service (nova) `_ - `Networking service (neutron) `_ @@ -537,7 +537,8 @@ To set this permanently, set this variable in ``/usr/local/bin/openstack-ansible.rc``. Refer to the Ansible documentation on `fact caching`_ for more details. -.. _fact caching: http://docs.ansible.com/ansible/playbooks_variables.html#fact-caching +.. _fact caching: https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#fact-caching + Forcing regeneration of cached facts ------------------------------------ diff --git a/doc/source/conf.py b/doc/source/conf.py index e2549e2b66..cddc0af3e8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -66,8 +66,8 @@ with open(os.path.join(CONF_PATH, GNOCCHI_DETAILS), 'r') as fdesc: gnocchi_branch = gnocchi_file_content['gnocchi_git_track_branch'] # References variable for substitutions -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) +deploy_guide_prefix = "https://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(current_series) +dev_docs_prefix = "https://docs.openstack.org/openstack-ansible/{}/%s".format(current_series) # Substitutions loader rst_epilog = """ diff --git a/doc/source/contributor/code-rules.rst b/doc/source/contributor/code-rules.rst index 4cd46cd521..0b55532606 100644 --- a/doc/source/contributor/code-rules.rst +++ b/doc/source/contributor/code-rules.rst @@ -44,8 +44,8 @@ General Guidelines for Submitting Code .. _Git Commit Good Practice: https://wiki.openstack.org/wiki/GitCommitMessages .. _workflow documented here: https://docs.openstack.org/infra/manual/developers.html#development-workflow -.. _advanced gerrit usage: http://www.mediawiki.org/wiki/Gerrit/Advanced_usage -.. _Ansible best practices: http://docs.ansible.com/playbooks_best_practices.html +.. _advanced gerrit usage: https://www.mediawiki.org/wiki/Gerrit/Advanced_usage +.. _Ansible best practices: https://docs.ansible.com/playbooks_best_practices.html .. _the reno tool: https://docs.openstack.org/reno/latest/ .. _documentation: @@ -73,7 +73,7 @@ Guide`_, with particular reference to the following sections: * Writing style * RST formatting conventions -.. _OpenStack Documentation Contributor Guide: https://docs.openstack.org/contributor-guide/ +.. _OpenStack Documentation Contributor Guide: https://docs.openstack.org/doc-contrib-guide/ .. _codecomments: @@ -131,7 +131,7 @@ OpenStack Manuals or service documentation and OpenStack-Ansible documentation should link to those documents when available, rather than duplicate their content. -.. _keystone role documentation: https://docs.openstack.org/developer/openstack-ansible-os_keystone/ +.. _keystone role documentation: https://docs.openstack.org/openstack-ansible-os_keystone/ .. _reno: diff --git a/doc/source/contributor/contribute.rst b/doc/source/contributor/contribute.rst index b13dc71a9d..2b24e4ada4 100644 --- a/doc/source/contributor/contribute.rst +++ b/doc/source/contributor/contribute.rst @@ -105,7 +105,7 @@ Here are a few rules to get started: See also the :ref:`documentation` section. .. _Working on Specifications and Blueprints: https://docs.openstack.org/infra/manual/developers.html#working-on-specifications-and-blueprints -.. _Tempest: https://docs.openstack.org/developer/tempest/ +.. _Tempest: https://docs.openstack.org/tempest/ Example process to develop a new role @@ -231,5 +231,5 @@ Backporting patch on any existing environment deployed by OpenStack-Ansible. The general `OpenStack Guidelines for stable branches`_ can be used as a reference. -.. _Submitting a change to a branch for review: http://www.mediawiki.org/wiki/Gerrit/Advanced_usage#Submitting_a_change_to_a_branch_for_review_.28.22backporting.22.29 +.. _Submitting a change to a branch for review: https://www.mediawiki.org/wiki/Gerrit/Advanced_usage#Submitting_a_change_to_a_branch_for_review_.28.22backporting.22.29 .. _OpenStack Guidelines for stable branches: https://docs.openstack.org/project-team-guide/stable-branches.html diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index d9bc0f808e..c49b1f7176 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -121,8 +121,8 @@ A consolidated set of all lint tests may be done locally by executing: ./run_tests.sh linters .. _PEP8: https://www.python.org/dev/peps/pep-0008/ -.. _Bashate: https://opendev.org/openstack-dev/bashate -.. _ansible-lint: https://github.com/willthames/ansible-lint +.. _Bashate: https://opendev.org/openstack/bashate +.. _ansible-lint: https://github.com/ansible/ansible-lint Documentation building ---------------------- @@ -303,7 +303,7 @@ See also the `zuul user guide`_. However, for reliability purposes, a few variables are defined to point to the OpenStack infra pypi and packages mirrors. -.. _zuul user guide: https://docs.openstack.org/infra/zuul/user/index.html +.. _zuul user guide: https://zuul-ci.org/docs/zuul/user/index.html The integrated repo functional test is using the ``scripts/gate-check-commit.sh`` script, which receives arguments diff --git a/doc/source/reference/architecture/container-networking.rst b/doc/source/reference/architecture/container-networking.rst index 56bb3ff421..4be5485a73 100644 --- a/doc/source/reference/architecture/container-networking.rst +++ b/doc/source/reference/architecture/container-networking.rst @@ -12,7 +12,7 @@ For more information about how the OpenStack Networking service (neutron) uses the interfaces for instance traffic, please see the `OpenStack Networking Guide`_. -.. _OpenStack Networking Guide: http://docs.openstack.org/networking-guide/ +.. _OpenStack Networking Guide: https://docs.openstack.org/neutron/latest/admin/index.html For details on the configuration of networking for your environment, please have a look at :ref:`openstack-user-config-reference`. diff --git a/doc/source/reference/architecture/manifesto.rst b/doc/source/reference/architecture/manifesto.rst index a193f5cdef..37ec5f4c50 100644 --- a/doc/source/reference/architecture/manifesto.rst +++ b/doc/source/reference/architecture/manifesto.rst @@ -34,7 +34,7 @@ instead of unique protocols that require remote daemons or agents. Ansible uses playbooks written in the YAML language for orchestration. For more information, see `Ansible - Intro to -Playbooks `_. +Playbooks `_. Ansible is a simple yet powerful orchestration tool that is ideally equipped for deploying OpenStack-powered clouds. The declarative nature of diff --git a/doc/source/reference/architecture/security.rst b/doc/source/reference/architecture/security.rst index f816036113..69f4bb0eab 100644 --- a/doc/source/reference/architecture/security.rst +++ b/doc/source/reference/architecture/security.rst @@ -31,7 +31,7 @@ certificates, keys, and CA certificates. To learn more about how to customize the deployment of encrypted communications, see -`Securing services with SSL certificates `_. +:ref:`Securing services with SSL certificates `. Host security hardening ~~~~~~~~~~~~~~~~~~~~~~~ @@ -56,7 +56,7 @@ to all deployments. The role has been carefully designed to perform as follows: For more information about the security configurations, see the `security hardening role`_ documentation. -.. _security hardening role: http://docs.openstack.org/developer/ansible-hardening/ +.. _security hardening role: https://docs.openstack.org/ansible-hardening/ .. _Security Technical Implementation Guide: https://en.wikipedia.org/wiki/Security_Technical_Implementation_Guide .. _Payment Card Industry Data Security Standard: https://www.pcisecuritystandards.org/pci_security/ @@ -154,5 +154,5 @@ For more information about recommended network policies for OpenStack clouds, see the `API endpoint process isolation and policy`_ section of the `OpenStack Security Guide`_ -.. _API endpoint process isolation and policy: http://docs.openstack.org/security-guide/api-endpoints/api-endpoint-configuration-recommendations.html#network-policy -.. _OpenStack Security Guide: http://docs.openstack.org/security-guide +.. _API endpoint process isolation and policy: https://docs.openstack.org/security-guide/api-endpoints/api-endpoint-configuration-recommendations.html#network-policy +.. _OpenStack Security Guide: https://docs.openstack.org/security-guide diff --git a/doc/source/reference/architecture/storage-arch.rst b/doc/source/reference/architecture/storage-arch.rst index ca7abbb270..81e6b676cf 100644 --- a/doc/source/reference/architecture/storage-arch.rst +++ b/doc/source/reference/architecture/storage-arch.rst @@ -64,7 +64,7 @@ the `LVMVolumeDriver`_ and many of the drivers for commercial storage devices. `cinder-manage CLI tool`_. This configuration might change if `cinder volume active-active support spec`_ is implemented. -.. _cinder driver: http://docs.openstack.org/developer/cinder/drivers.html +.. _cinder driver: https://docs.openstack.org/cinder/drivers.html .. _LVMVolumeDriver: https://docs.openstack.org/cinder/latest/drivers.html#lvmvolumedriver .. _limitation with container iSCSI connectivity: https://bugs.launchpad.net/ubuntu/+source/lxc/+bug/1226855 .. _cinder-manage CLI tool: https://docs.openstack.org/cinder/latest/cli/cinder-manage.html @@ -128,7 +128,7 @@ created. | | image cache. | +----+---------------------------------------------------------------------+ -.. _glance_store drivers: http://docs.openstack.org/developer/glance_store/drivers/ +.. _glance_store drivers: https://docs.openstack.org/glance_store/drivers/ Ephemeral storage (nova) ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/inventory/inventory.rst b/doc/source/reference/inventory/inventory.rst index 3252fed21b..254922a9f0 100644 --- a/doc/source/reference/inventory/inventory.rst +++ b/doc/source/reference/inventory/inventory.rst @@ -4,7 +4,7 @@ Inventory OpenStack-Ansible uses an included script to generate the inventory of hosts and containers within the environment. This script is called by Ansible -through its `dynamic inventory functionality `_. +through its `dynamic inventory functionality `_. In this section, you will find documentation relevant to the inventory for OpenStack-Ansible. diff --git a/doc/source/reference/inventory/manage-inventory.rst b/doc/source/reference/inventory/manage-inventory.rst index 34d545845b..eeb418dcfe 100644 --- a/doc/source/reference/inventory/manage-inventory.rst +++ b/doc/source/reference/inventory/manage-inventory.rst @@ -41,7 +41,7 @@ A host can be removed with the ``--remove-item/-r`` parameter. Use the host's name as an argument. -.. _`dynamic inventory functionality`: http://docs.ansible.com/ansible/intro_dynamic_inventory.html +.. _`dynamic inventory functionality`: https://docs.ansible.com/ansible/intro_dynamic_inventory.html Exporting host information ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/user/ceph/full-deploy.rst b/doc/source/user/ceph/full-deploy.rst index 8efcaa795e..6a30e47abe 100644 --- a/doc/source/user/ceph/full-deploy.rst +++ b/doc/source/user/ceph/full-deploy.rst @@ -28,7 +28,7 @@ This example environment has the following characteristics: Integration with Ceph ~~~~~~~~~~~~~~~~~~~~~ -OpenStack-Ansible allows `Ceph storage `_ cluster +OpenStack-Ansible allows `Ceph storage `_ cluster integration in two ways: * connecting to your own ceph cluster by pointing to its information diff --git a/doc/source/user/prod/gnocchi_redis.rst b/doc/source/user/prod/gnocchi_redis.rst index db0223c13a..699e33b04b 100644 --- a/doc/source/user/prod/gnocchi_redis.rst +++ b/doc/source/user/prod/gnocchi_redis.rst @@ -173,4 +173,4 @@ Performance Tests for Gnocchi For more ideas how to tune your Gnocchi stack, take a look at these presentations: -* https://docs.openstack.org/developer/performance-docs/test_results/telemetry_gnocchi_with_ceph/index.html +* https://docs.openstack.org/performance-docs/test_results/telemetry_gnocchi_with_ceph/index.html diff --git a/doc/source/user/security/hardening.rst b/doc/source/user/security/hardening.rst index e07322a147..422a08d014 100644 --- a/doc/source/user/security/hardening.rst +++ b/doc/source/user/security/hardening.rst @@ -26,4 +26,4 @@ audit an environment by using a playbook supplied with OpenStack-Ansible: For more information about the security configurations, see the `security hardening role`_ documentation. -.. _security hardening role: http://docs.openstack.org/developer/ansible-hardening/ +.. _security hardening role: https://docs.openstack.org/ansible-hardening/ diff --git a/doc/source/user/security/index.rst b/doc/source/user/security/index.rst index 5721211bdd..185bc2837d 100644 --- a/doc/source/user/security/index.rst +++ b/doc/source/user/security/index.rst @@ -1,3 +1,5 @@ +.. _security_settings: + ================= Security settings ================= diff --git a/doc/source/user/security/ssl-certificates.rst b/doc/source/user/security/ssl-certificates.rst index dc9dbaa53a..74367f6e31 100644 --- a/doc/source/user/security/ssl-certificates.rst +++ b/doc/source/user/security/ssl-certificates.rst @@ -6,7 +6,7 @@ between various services in an OpenStack deployment. The OpenStack-Ansible project currently offers the ability to configure SSL certificates for secure communication between services: -.. _OpenStack Security Guide: http://docs.openstack.org/security-guide/secure-communication.html +.. _OpenStack Security Guide: https://docs.openstack.org/security-guide/secure-communication.html All public endpoints reside behind haproxy, resulting in the only certificate management most environments need are those for haproxy.