From e4551ef3e249e7495be332db9d8d3cd1df85b5d9 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Thu, 16 Feb 2017 10:28:37 +0000 Subject: [PATCH] [DOCS] Move limited connectivity section to Deploy Guide The limited connectivity section was temporarily moved into the developer guide temporarily when re-arranging the deploy guide, but never moved back. As this is important information for deployers to see, this is being moved into the deploy guide appendix, then references to it are added to the AIO and Deployment Guide in appropriate places. The following notes regarding additional changes apply: - The pip offline install content for the limited connectivity page breaks the flow and doesn't really fit in the two models proposed. This content should move to the pip install role. - The reference to the get_url/get_uri bug for Ansible 1.9 no longer applies as Newton onwards now uses Ansible 2.1.x and above. - An unused Appendix H reference in the Security Appendix has been removed. - The Appendices have been re-arranged slightly to try to show the information in a perceived order of importance. Change-Id: If4b8a75277374ed7e96a1ce6610ed8a897125693 --- .../source/app-advanced-config-options.rst | 2 +- .../source/app-advanced-config-security.rst | 1 - deploy-guide/source/app-ceph.rst | 2 +- .../source/app-limited-connectivity.rst | 37 +++---------------- deploy-guide/source/app-resources.rst | 2 +- deploy-guide/source/app-security.rst | 2 +- deploy-guide/source/app.rst | 1 + deploy-guide/source/deploymenthost.rst | 5 +++ doc/source/developer-docs/index.rst | 1 - doc/source/developer-docs/quickstart-aio.rst | 6 +++ 10 files changed, 22 insertions(+), 37 deletions(-) rename doc/source/developer-docs/installation-hosts-limited-connectivity.rst => deploy-guide/source/app-limited-connectivity.rst (82%) diff --git a/deploy-guide/source/app-advanced-config-options.rst b/deploy-guide/source/app-advanced-config-options.rst index 2aaa43bbbb..d9caf1db09 100644 --- a/deploy-guide/source/app-advanced-config-options.rst +++ b/deploy-guide/source/app-advanced-config-options.rst @@ -1,5 +1,5 @@ =================================== -Appendix F: Advanced configuration +Appendix G: Advanced configuration =================================== .. TODO: include intro on what advanced configuration is, whether it’s required diff --git a/deploy-guide/source/app-advanced-config-security.rst b/deploy-guide/source/app-advanced-config-security.rst index e4ac94352a..ec8a576fbb 100644 --- a/deploy-guide/source/app-advanced-config-security.rst +++ b/deploy-guide/source/app-advanced-config-security.rst @@ -36,4 +36,3 @@ For more information about the security configurations, see the .. _openstack-ansible-security: http://docs.openstack.org/developer/openstack-ansible-security/ .. _Security Technical Implementation Guide (STIG): https://en.wikipedia.org/wiki/Security_Technical_Implementation_Guide .. _OpenStack-Ansible host security: http://docs.openstack.org/developer/openstack-ansible-security/ -.. _Appendix H: ../install-guide/app-custom-layouts.html diff --git a/deploy-guide/source/app-ceph.rst b/deploy-guide/source/app-ceph.rst index 260dba6567..b4c1e2ec5d 100644 --- a/deploy-guide/source/app-ceph.rst +++ b/deploy-guide/source/app-ceph.rst @@ -1,5 +1,5 @@ ==================================== -Appendix G: Ceph-Ansible integration +Appendix H: Ceph-Ansible integration ==================================== OpenStack-Ansible allows `Ceph storage `_ cluster integration diff --git a/doc/source/developer-docs/installation-hosts-limited-connectivity.rst b/deploy-guide/source/app-limited-connectivity.rst similarity index 82% rename from doc/source/developer-docs/installation-hosts-limited-connectivity.rst rename to deploy-guide/source/app-limited-connectivity.rst index 1e00ae1f04..b027a21ed1 100644 --- a/doc/source/developer-docs/installation-hosts-limited-connectivity.rst +++ b/deploy-guide/source/app-limited-connectivity.rst @@ -1,6 +1,8 @@ -=============================================== -Installation on hosts with limited connectivity -=============================================== +.. _limited-connectivity-appendix: + +================================================ +Appendix F: Installing with limited connectivity +================================================ Many playbooks and roles in OpenStack-Ansible retrieve dependencies from the public Internet by default. Many deployers block direct outbound connectivity @@ -18,23 +20,6 @@ Example internet dependencies - Source code repositories - GPG keys for package validation -Install pip through deployment host -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You may install pip via the deployment host in environments where the -deployment host has internet connectivity, but the containers do not. - -Configure the ``pip_offline_install`` variable to enable the deployment -host to fetch pip along with its dependencies, then transfer them to the -remote container for installation. - -Configuration changes are made in ``/etc/openstack_deploy/user_variables.yml``. - -.. code-block:: yaml - - # Install pip via deployment host - pip_offline_install: true - Practice A: Mirror internet resources locally ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -100,8 +85,7 @@ automation for creating the proxy server(s). .. note:: We recommend you set your ``/etc/environment`` variables with proxy - settings before launching ``scripts/run-playbooks.sh`` to avoid - failure. + settings before launching any scripts or playbooks to avoid failure. Basic proxy configuration ------------------------- @@ -166,12 +150,3 @@ The list above is intentionally not exhaustive. Additional variables may exist within the project and will be named using the `*_validate_certs` pattern. Disable certificate chain validation on a case by case basis and only after encountering failures that are known to only be caused by the proxy server(s). - -Ansible support for proxy servers ---------------------------------- - -The `get_url` and `uri` modules in Ansible 1.9.x have inconsistent and buggy -behavior when used in concert with many popular proxy servers and -configurations. An example Launchpad bug can be found `here -`_. The comments -contain a workaround that has been effective for some deployers. diff --git a/deploy-guide/source/app-resources.rst b/deploy-guide/source/app-resources.rst index b5285ea0f3..10d35602bc 100644 --- a/deploy-guide/source/app-resources.rst +++ b/deploy-guide/source/app-resources.rst @@ -1,5 +1,5 @@ ================================= -Appendix H: Additional resources +Appendix I: Additional resources ================================= Ansible resources: diff --git a/deploy-guide/source/app-security.rst b/deploy-guide/source/app-security.rst index b6e73f8563..9124861702 100644 --- a/deploy-guide/source/app-security.rst +++ b/deploy-guide/source/app-security.rst @@ -8,7 +8,7 @@ default. This appendix provides a detailed overview of the most important security enhancements. For more information about configuring security, see -:deploy_guide:`Appendix F `. +:deploy_guide:`Appendix G `. .. note:: diff --git a/deploy-guide/source/app.rst b/deploy-guide/source/app.rst index 4272663259..116b763942 100644 --- a/deploy-guide/source/app.rst +++ b/deploy-guide/source/app.rst @@ -10,6 +10,7 @@ Appendices app-custom-layouts.rst app-security.rst app-networking.rst + app-limited-connectivity.rst app-advanced-config-options.rst app-ceph.rst app-resources.rst diff --git a/deploy-guide/source/deploymenthost.rst b/deploy-guide/source/deploymenthost.rst index 038f323dd1..5d933247e6 100644 --- a/deploy-guide/source/deploymenthost.rst +++ b/deploy-guide/source/deploymenthost.rst @@ -81,6 +81,11 @@ Install the source and dependencies Install the source and dependencies for the deployment host. +.. note:: + + If you are installing with limited connectivity, please review + :ref:`limited-connectivity-appendix` before proceeding. + #. Clone the latest stable release of the OpenStack-Ansible Git repository in the ``/opt/openstack-ansible`` directory: diff --git a/doc/source/developer-docs/index.rst b/doc/source/developer-docs/index.rst index d6c49193f1..c342377527 100644 --- a/doc/source/developer-docs/index.rst +++ b/doc/source/developer-docs/index.rst @@ -14,7 +14,6 @@ Contents: :maxdepth: 2 quickstart-aio - installation-hosts-limited-connectivity scripts playbooks contribute diff --git a/doc/source/developer-docs/quickstart-aio.rst b/doc/source/developer-docs/quickstart-aio.rst index 12163764ea..5e2adf5c67 100644 --- a/doc/source/developer-docs/quickstart-aio.rst +++ b/doc/source/developer-docs/quickstart-aio.rst @@ -56,6 +56,12 @@ system packages are upgraded and then reboot into the new kernel: # apt-get dist-upgrade # reboot +.. note:: + + If you are installing with limited connectivity, please review + the *Installing with limited connectivity* appendix in the + `Deployment Guide`_ before proceeding. + Start by cloning the OpenStack-Ansible repository and changing into the repository root directory: