Execute service setup against a delegated host using Ansible built-in modules

In order to reduce the packages required to pip install on to the hosts,
we allow the service setup to be delegated to a specific host, defaulting
to the deploy host. We also switch as many tasks as possible to using the
built-in Ansible modules which make use of the shade library.

The 'virtualenv' package is now installed appropriately by the openstack_hosts
role, so there's no need to install it any more. The 'httplib2' package is a
legacy Ansible requirement for the get_url/get_uri module which is no longer
needed. The keystone client library is not required any more now that we're
using the upstream modules. As there are no required packages left, the task
to install them is also removed.

Change-Id: I9ce106569ced891c551b36506d360e4b8718c7e3

defaults/main.yml

@@ -17,6 +17,11 @@
 # (c) 2016 Donovan Francesco <donovan.francesco@is.co.za>
 # (c) 2016 Paul Stevens <paul.stevens@is.co.za>
 
+# Set the host which will execute the shade modules
+# for the service setup. The host must already have
+# clouds.yaml properly configured.
+trove_service_setup_host: "{{ openstack_service_setup_host | default('localhost') }}"
+
 trove_package_state: "latest"
 trove_pip_package_state: "latest"
 
@@ -200,14 +205,6 @@ trove_service_user_domain_id: default
 #Glance images
 trove_glance_images: []
 
-trove_requires_pip_packages:
-  - httplib2
-  - python-glanceclient
-  - python-keystoneclient
-  - virtualenv
-  - shade
-  - futures
-
 trove_pip_packages:
   - cryptography
   - MySQL-python

meta/main.yml

@@ -24,4 +24,3 @@ dependencies:
     when:
       - ansible_pkg_mgr == 'apt'
   - galera_client
-  - openstack_openrc

releasenotes/notes/trove-service-setup-host-5bb64b2356ca81e2.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    The trove service setup in keystone will now be executed
+    through delegation to the ``trove_service_setup_host`` which,
+    by default, is ``localhost`` (the deploy host). Deployers can
+    opt to rather change this to the utility container by implementing
+    the following override in ``user_variables.yml``.
+
+    .. code-block:: yaml
+
+      trove_service_setup_host: "{{ groups['utility_all'][0] }}"
+
+deprecations:
+  - |
+    The variable ``trove_requires_pip_packages`` is no longer required
+    and has therefore been removed.

tasks/trove_install.yml

@@ -38,19 +38,6 @@
   when:
     - trove_developer_mode | bool
 
-- name: Install required pip packages
-  pip:
-    name: "{{ trove_requires_pip_packages }}"
-    state: "{{ trove_pip_package_state }}"
-    extra_args: >-
-      {{ trove_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
-      {{ (pip_install_upper_constraints is defined) | ternary('--constraint ' + pip_install_upper_constraints | default(''),'') }}
-      {{ pip_install_options | default('') }}
-  register: install_packages
-  until: install_packages is success
-  retries: 5
-  delay: 2
-
 - name: Retrieve checksum for venv download
   uri:
     url: "{{ trove_venv_download_url | replace('tgz', 'checksum') }}"

tasks/trove_service_setup.yml

@@ -15,111 +15,95 @@
 #
 # (c) 2016 Donovan Francesco <donovan.francesco@is.co.za>
 # (c) 2016 Paul Stevens <paul.stevens@is.co.za>
-# Reference: https://docs.openstack.org/trove/latest/install/manual_install.html
-- name: Ensure the trove tenant exists
-  keystone:
-    command: "ensure_tenant"
-    endpoint: "{{ keystone_service_adminurl }}"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-    tenant_name: "{{ trove_service_tenant_name }}"
-    project_name: "{{ trove_service_project_name }}"
-    description: "{{ trove_service_description }}"
-  register: add_trove_tenant
-  until: add_trove_tenant  is success
-  retries: 5
-  delay: 2
-  no_log: True
-  tags:
-    - trove-api-setup
-    - trove-service-add
-    - trove-setup
 
-- name: Ensure the service for trove exists
+# We set the python interpreter to the ansible runtime venv if
-  keystone:
+# the delegation is to localhost so that we get access to the
-    command: "ensure_service"
+# appropriate python libraries in that venv. If the delegation
-    endpoint: "{{ keystone_service_adminurl }}"
+# is to another host, we assume that it is accessible by the
-    login_user: "{{ keystone_admin_user_name }}"
+# system python instead.
-    login_password: "{{ keystone_auth_admin_password }}"
+- name: Setup the service
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+  delegate_to: "{{ trove_service_setup_host }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+  vars:
-    service_name: "{{ trove_service_name }}"
+    ansible_python_interpreter: >-
+      {{ (trove_service_setup_host == 'localhost') | ternary(ansible_playbook_python, ansible_python['executable']) }}
+  block:
+    - name: Add service to the keystone service catalog
+      os_keystone_service:
+        cloud: default
+        state: present
+        name: "{{ trove_service_name }}"
         service_type: "{{ trove_service_type }}"
         description: "{{ trove_service_description }}"
-  register: add_trove_service
+        endpoint_type: admin
-  until: add_trove_service  is success
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
       retries: 5
-  delay: 2
+      delay: 10
-  no_log: True
-  tags:
-    - trove-api-setup
-    - trove-service-add
-    - trove-setup
 
-- name: Ensure the trove admin user exists
+    - name: Add service project
-  keystone:
+      os_project:
-    command: "ensure_user"
+        cloud: default
-    endpoint: "{{ keystone_service_adminurl }}"
+        state: present
-    login_user: "{{ keystone_admin_user_name }}"
+        name: "{{ trove_service_project_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        description: "{{ trove_service_description }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        endpoint_type: admin
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    user_name: "{{ trove_admin_user_name }}"
+      register: add_service
-    tenant_name: "{{ trove_service_tenant_name }}"
+      until: add_service is success
+      retries: 5
+      delay: 10
+
+    - name: Add service user
+      os_user:
+        cloud: default
+        state: present
+        name: "{{ trove_admin_user_name }}"
         password: "{{ trove_service_password }}"
-    project_name: "{{ trove_service_project_name }}"
+        domain: default
-  register: add_trove_admin_user
+        default_project: "{{ trove_service_project_name }}"
-  until: add_trove_admin_user  is success
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
       retries: 5
-  delay: 2
+      delay: 10
       no_log: True
-  tags:
-    - trove-api-setup
-    - trove-service-add
-    - trove-user-add
-    - trove-setup
 
-- name: Ensure the trove admin user has the admin role
+    - name: Add service user to admin role
-  keystone:
+      os_user_role:
-    command: "ensure_user_role"
+        cloud: default
-    endpoint: "{{ keystone_service_adminurl }}"
+        state: present
-    login_user: "{{ keystone_admin_user_name }}"
+        user: "{{ trove_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        role: "{{ item }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        project: "{{ trove_service_project_name }}"
-    user_name: "{{ trove_admin_user_name }}"
+        endpoint_type: admin
-    tenant_name: "{{ trove_service_tenant_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    role_name: "{{ item }}"
+      register: add_service
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+      until: add_service is success
-    project_name: "{{ trove_service_project_name }}"
-  register: ensure_trove_admin_roles
-  until: ensure_trove_admin_roles  is success
       retries: 5
-  delay: 2
+      delay: 10
       with_items: "{{ trove_service_admin_role_names }}"
-  no_log: True
 
-- name: Ensure the trove endpoint is registered
+    - name: Add endpoints to keystone endpoint catalog
-  keystone:
+      os_keystone_endpoint:
-    command: "ensure_endpoint"
+        cloud: default
-    endpoint: "{{ keystone_service_adminurl }}"
+        state: present
-    login_user: "{{ keystone_admin_user_name }}"
+        service: "{{ trove_service_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        endpoint_interface: "{{ item.interface }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        url: "{{ item.url }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+        region: "{{ trove_service_region }}"
-    region_name: "{{ trove_service_region }}"
+        endpoint_type: admin
-    service_name: "{{ trove_service_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    service_type: "{{ trove_service_type }}"
+      register: add_service
-    endpoint_list:
+      until: add_service is success
-      - url: "{{ trove_service_publicurl }}"
-        interface: "public"
-      - url: "{{ trove_service_internalurl }}"
-        interface: "internal"
-      - url: "{{ trove_service_adminurl }}"
-        interface: "admin"
-  register: add_trove_endpoints
-  until: add_trove_endpoints  is success
       retries: 5
-  delay: 2
+      delay: 10
-  no_log: True
+      with_items:
+        - interface: "public"
+          url: "{{ trove_service_publicurl }}"
+        - interface: "internal"
+          url: "{{ trove_service_internalurl }}"
+        - interface: "admin"
+          url: "{{ trove_service_adminurl }}"
+

tests/host_vars/localhost.yml

@@ -15,5 +15,3 @@
 
 bridges:
   - "br-mgmt"
-
-ansible_python_interpreter: "/usr/bin/python2"