Reconcile all 'Ansible control host' references

Ensure all references to the Ansible control host are worded as such, to
ensure consistency and avoid potential confusion with the OpenStack
controllers.

Change-Id: Id92e537ccbfdd55287b8eae296f649640c70ce17

ansible/group_vars/all/globals

@@ -2,9 +2,9 @@
 # Kayobe global configuration.
 
 ###############################################################################
-# Local path configuration (ansible control host).
+# Local path configuration (Ansible control host).
 
-# Path to Kayobe configuration directory on ansible control host.
+# Path to Kayobe configuration directory on Ansible control host.
 kayobe_config_path: "{{ lookup('env', 'KAYOBE_CONFIG_PATH') | default('/etc/kayobe', true) }}"
 
 ###############################################################################

ansible/group_vars/all/ssh

@@ -8,10 +8,10 @@ ssh_key_type: "rsa"
 # Name of SSH key.
 ssh_key_name: "{{ 'id_' ~ ssh_key_type }}"
 
-# Path to SSH private key on the control host.
+# Path to SSH private key on the Ansible control host.
 ssh_private_key_path: "{{ lookup('env', 'HOME') ~ '/.ssh/' ~ ssh_key_name }}"
 
-# Path to SSH public key on the control host.
+# Path to SSH public key on the Ansible control host.
 ssh_public_key_path: "{{ ssh_private_key_path ~ '.pub' }}"
 
 ###############################################################################

ansible/roles/ip-allocation/tasks/main.yml

@@ -1,6 +1,6 @@
 ---
-# Facts may not be available for the control host, so read the OS release
+# Facts may not be available for the Ansible control host, so read the OS
-# manually.
+# release manually.
 - name: Check the OS release
   local_action:
     module: shell . /etc/os-release && echo $ID

ansible/roles/junos-switch/tasks/main.yml

@@ -16,7 +16,7 @@
   become: True
 
 # For ansible 2.3+, only the NETCONF client ncclient is required. This must be
-# installed on the ansible control host where the ansible-connection subprocess
+# installed on the Ansible control host where the ansible-connection subprocess
 # is executed.
 - name: Ensure python dependencies are installed
   local_action:

dev/functions

@@ -131,7 +131,7 @@ function seed_hypervisor_deploy {
     # Deploy a seed hypervisor.
     environment_setup
 
-    echo "Bootstrapping the ansible control host"
+    echo "Bootstrapping the Ansible control host"
     run_kayobe control host bootstrap
 
     echo "Configuring the seed hypervisor"
@@ -142,7 +142,7 @@ function seed_deploy {
     # Deploy a kayobe seed in a VM.
     environment_setup
 
-    echo "Bootstrapping the ansible control host"
+    echo "Bootstrapping the Ansible control host"
     run_kayobe control host bootstrap
 
     if [[ ${KAYOBE_SEED_VM_PROVISION} = 1 ]]; then
@@ -182,7 +182,7 @@ function overcloud_deploy {
 
     environment_setup
 
-    echo "Bootstrapping the ansible control host"
+    echo "Bootstrapping the Ansible control host"
     run_kayobe control host bootstrap
 
     echo "Configuring the controller host"

doc/source/administration.rst

@@ -10,8 +10,8 @@ Reconfiguring Containerised Services
 
 When configuration is changed, it is necessary to apply these changes across
 the system in an automated manner.  To reconfigure the overcloud, first make
-any changes required to the configuration on the control host.  Next, run the
+any changes required to the configuration on the Ansible control host.  Next,
-following command::
+run the following command::
 
     (kayobe) $ kayobe overcloud service reconfigure
 
@@ -86,7 +86,7 @@ Saving Overcloud Service Configuration
 It is often useful to be able to save the configuration of the control
 plane services for inspection or comparison with another configuration set
 prior to a reconfiguration or upgrade. This command will gather and save the
-control plane configuration for all hosts to the ansible control host::
+control plane configuration for all hosts to the Ansible control host::
 
     (kayobe) $ kayobe overcloud service configuration save
 
@@ -109,7 +109,7 @@ generated in a directory other than the default configuration directory of
 The configuration will be generated remotely on the overcloud hosts in the
 specified directory, with one subdirectory per container. This command may be
 followed by ``kayobe ovecloud service configuration save`` to gather the
-generated configuration to the ansible control host.
+generated configuration to the Ansible control host.
 
 Checking Network Connectivity
 =============================

doc/source/architecture.rst

@@ -7,9 +7,10 @@ Hosts in the System
 
 In a system deployed by Kayobe we define a number of classes of hosts.
 
-Control host
+Ansible control host
-    The control host is the host on which kayobe, kolla and kolla-ansible will
+    The Ansible control host is the host on which kayobe, kolla and
-    be installed, and is typically where the cloud will be managed from.
+    kolla-ansible will be installed, and is typically where the cloud will be
+    managed from.
 Seed host
     The seed host runs the bifrost deploy container and is used to provision
     the cloud hosts.  By default, container images are built on the seed.

doc/source/configuration/kayobe.rst

@@ -81,7 +81,7 @@ Inventory
 
 The inventory should contain the following hosts:
 
-Control host
+Ansible Control host
     This should be localhost.
 Seed hypervisor
     If provisioning a seed VM, a host should exist for the hypervisor that

doc/source/configuration/kolla-ansible.rst

@@ -3,7 +3,7 @@ Kolla-ansible Configuration
 ===========================
 
 Kayobe relies heavily on kolla-ansible for deployment of the OpenStack control
-plane. Kolla-ansible is installed locally on the ansible control host (the host
+plane. Kolla-ansible is installed locally on the Ansible control host (the host
 from which kayobe commands are executed), and kolla-ansible commands are
 executed from there.
 
@@ -18,12 +18,12 @@ kolla-ansible is installed and executed.
    ====================== ================================================== ============================
    Variable               Purpose                                            Default
    ====================== ================================================== ============================
-   ``$KOLLA_CONFIG_PATH`` Path on the ansible control host in which          ``/etc/kolla``
+   ``$KOLLA_CONFIG_PATH`` Path on the Ansible control host in which          ``/etc/kolla``
                           the kolla-ansible configuration will be generated.
                           These files should not be manually edited.
-   ``$KOLLA_SOURCE_PATH`` Path on the ansible control host in which          ``$PWD/src/kolla-ansible``
+   ``$KOLLA_SOURCE_PATH`` Path on the Ansible control host in which          ``$PWD/src/kolla-ansible``
                           the kolla-ansible source code will be cloned.
-   ``$KOLLA_VENV_PATH``   Path on the ansible control host in which          ``$PWD/venvs/kolla-ansible``
+   ``$KOLLA_VENV_PATH``   Path on the Ansible control host in which          ``$PWD/venvs/kolla-ansible``
                           the kolla-ansible virtualenv will be created.
    ====================== ================================================== ============================
 

doc/source/custom-ansible-playbooks.rst

@@ -76,11 +76,11 @@ installed from Galaxy.  These roles may then be used by custom playbooks.
 Galaxy role dependencies may be defined in
 ``$KAYOBE_CONFIG_PATH/ansible/requirements.yml``.  These roles will be
 installed in ``$KAYOBE_CONFIG_PATH/ansible/roles/`` when bootstrapping the
-control host::
+Ansible control host::
 
     (kayobe) $ kayobe control host bootstrap
 
-And updated when upgrading the control host::
+And updated when upgrading the Ansible control host::
 
     (kayobe) $ kayobe control host upgrade
 

doc/source/deployment.rst

@@ -219,7 +219,7 @@ To see the active Docker containers::
 
     $ docker ps
 
-Leave the seed VM and return to the shell on the control host::
+Leave the seed VM and return to the shell on the Ansible control host::
 
     $ exit
 
@@ -398,7 +398,7 @@ OpenStack admin endpoints as the admin user::
 
 Kayobe also generates an environment file that can be used to access the
 OpenStack public endpoints as the admin user which may be required if the
-admin endpoints are not available from the control host::
+admin endpoints are not available from the Ansible control host::
 
     $ source ${KOLLA_CONFIG_PATH:-/etc/kolla}/public-openrc.sh
 

doc/source/development/manual.rst

@@ -38,7 +38,7 @@ Source the kayobe environment file::
 
     source kayobe-env
 
-Bootstrap the kayobe control host::
+Bootstrap the kayobe Ansible control host::
 
     kayobe control host bootstrap
 

doc/source/installation.rst

@@ -5,17 +5,18 @@ Installation
 Prerequisites
 =============
 
-Currently Kayobe supports the following Operating Systems on the control host:
+Currently Kayobe supports the following Operating Systems on the Ansible
+control host:
 
 - CentOS 7.3
 - Ubuntu 16.04
 
 To avoid conflicts with python packages installed by the system package manager
 it is recommended to install Kayobe in a virtualenv. Ensure that the
-``virtualenv`` python module is available on the control host. It is necessary
+``virtualenv`` python module is available on the Ansible control host. It is
-to install the GCC compiler chain in order to build the extensions of some of
+necessary to install the GCC compiler chain in order to build the extensions of
-kayobe's python dependencies. Finally, for cloning and working with the kayobe
+some of kayobe's python dependencies. Finally, for cloning and working with the
-source code repository, Git is required.
+kayobe source code repository, Git is required.
 
 On CentOS::
 
@@ -30,9 +31,9 @@ Installation
 
 This guide will describe how to install Kayobe from source in a virtualenv.
 
-The directory structure for a kayobe control host environment is configurable,
+The directory structure for a kayobe Ansible control host environment is
-but the following is recommended, where ``<base_path>`` is the path to a top
+configurable, but the following is recommended, where ``<base_path>`` is the
-level directory::
+path to a top level directory::
 
     <base_path>/
         src/

doc/source/release-notes.rst

@@ -118,7 +118,7 @@ Features
 --------
 
 * Adds support for the OpenStack Pike release.
-* Adds support for saving overcloud service configuration to the ansible
+* Adds support for saving overcloud service configuration to the Ansible
   control host.
 * Adds support for generating overcloud service configuration, without applying
   it to the running system.
@@ -177,7 +177,7 @@ Features
   inspection data in environments without Swift.
 * Adds configuration of gatewys in provisioning and inspection networks.
 * Adds support for free-form configuration of Glance.
-* Adds support for Ubuntu control hosts.
+* Adds support for Ubuntu Ansible control hosts.
 * Adds support for passing through host variables from kayobe to kolla-ansible.
   By default ``ansible_host``, ``ansible_port``, and
   ``ansible_ssh_private_key_file``.
@@ -192,8 +192,8 @@ Upgrade Notes
   set the ``seed_vm_root_image`` variable.
 * The default value of ``kolla_enable_haproxy`` has been changed to ``True``.
 * If using a custom inventory, a ``network`` group should be added to it. If
-  the control hosts are providing networking services, then the ``network``
+  the Ansible control hosts are providing networking services, then the
-  group should be a subgroup of the ``controllers`` group.
+  ``network`` group should be a subgroup of the ``controllers`` group.
 * The ``overcloud_groups`` variable is now determined more intelligently, and
   it is generally no longer necessary to set it manually.
 * The provisioning network is now used to access the TFTP server during
@@ -213,7 +213,7 @@ Features
 * Support static routes on control plane networks
 * Improve documentation
 * Initial support for in-development Pike release
-* Upgrade kayobe control host & control plane
+* Upgrade kayobe Ansible control host & control plane
 * Support overcloud service destroy command
 * Support fluentd custom output configuration
 

doc/source/upgrading.rst

@@ -66,8 +66,8 @@ host environment if necessary. When ready, source the environment file::
 
     $ source kayobe-env
 
-Upgrading the Control Host
+Upgrading the Ansible Control Host
-==========================
+==================================
 
 Before starting the upgrade we must upgrade the Ansible control host.  Tasks
 performed here include:
@@ -188,7 +188,7 @@ Saving Overcloud Service Configuration
 It is often useful to be able to save the configuration of the control
 plane services for inspection or comparison with another configuration set
 prior to a reconfiguration or upgrade. This command will gather and save the
-control plane configuration for all hosts to the ansible control host::
+control plane configuration for all hosts to the Ansible control host::
 
     (kayobe) $ kayobe overcloud service configuration save
 
@@ -211,7 +211,7 @@ generated in a directory other than the default configuration directory of
 The configuration will be generated remotely on the overcloud hosts in the
 specified directory, with one subdirectory per container. This command may be
 followed by ``kayobe ovecloud service configuration save`` to gather the
-generated configuration to the ansible control host.
+generated configuration to the Ansible control host.
 
 Upgrading Containerised Services
 --------------------------------

etc/kayobe/globals.yml

@@ -2,9 +2,9 @@
 # Kayobe global configuration.
 
 ###############################################################################
-# Local path configuration (ansible control host).
+# Local path configuration (Ansible control host).
 
-# Path to Kayobe configuration directory on ansible control host.
+# Path to Kayobe configuration directory on Ansible control host.
 #kayobe_config_path:
 
 ###############################################################################

etc/kayobe/inventory/hosts.example

@@ -1,7 +1,7 @@
 # Kayobe hosts inventory file. This file should be modified to define the hosts
 # and their top-level group membership.
 
-# This host acts as the configuration management control host. This must be
+# This host acts as the configuration management Ansible control host. This must be
 # localhost.
 localhost ansible_connection=local
 

etc/kayobe/ssh.yml

@@ -5,10 +5,10 @@
 # Name of SSH key.
 #ssh_key_name:
 
-# Path to SSH private key on the control host.
+# Path to SSH private key on the Ansible control host.
 #ssh_private_key_path:
 
-# Path to SSH public key on the control host.
+# Path to SSH public key on the Ansible control host.
 #ssh_public_key_path:
 
 ###############################################################################

kayobe/cli/commands.py

@@ -113,12 +113,12 @@ class ControlHostBootstrap(KayobeAnsibleMixin, VaultMixin, Command):
     """Bootstrap the Kayobe control environment.
 
     * Downloads and installs Ansible roles from Galaxy.
-    * Generates an SSH key for the ansible control host, if one does not exist.
+    * Generates an SSH key for the Ansible control host, if one does not exist.
-    * Installs kolla-ansible on the ansible control host.
+    * Installs kolla-ansible on the Ansible control host.
     """
 
     def take_action(self, parsed_args):
-        self.app.LOG.debug("Bootstrapping Kayobe control host")
+        self.app.LOG.debug("Bootstrapping Kayobe Ansible control host")
         ansible.install_galaxy_roles(parsed_args)
         playbooks = _build_playbook_list("bootstrap")
         self.run_kayobe_playbooks(parsed_args, playbooks)
@@ -130,12 +130,12 @@ class ControlHostUpgrade(KayobeAnsibleMixin, VaultMixin, Command):
     """Upgrade the Kayobe control environment.
 
     * Downloads and installs updated Ansible roles from Galaxy.
-    * Generates an SSH key for the ansible control host, if one does not exist.
+    * Generates an SSH key for the Ansible control host, if one does not exist.
-    * Updates kolla-ansible on the ansible control host.
+    * Updates kolla-ansible on the Ansible control host.
     """
 
     def take_action(self, parsed_args):
-        self.app.LOG.debug("Upgrading Kayobe control host")
+        self.app.LOG.debug("Upgrading Kayobe Ansible control host")
         # Use force to upgrade roles.
         ansible.install_galaxy_roles(parsed_args, force=True)
         playbooks = _build_playbook_list("bootstrap")
@@ -552,7 +552,7 @@ class OvercloudIntrospectionDataSave(KayobeAnsibleMixin, VaultMixin, Command):
     """Save hardware introspection data for the overcloud.
 
     Save hardware introspection data from the seed's ironic inspector service
-    to the control host.
+    to the Ansible control host.
     """
 
     def get_parser(self, prog_name):