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.

With the dependent patches, the openstack_openrc role is now executed once
on the designated host, so it is no longer required as a meta-dependency for
the role.

Depends-On: https://review.openstack.org/579233
Depends-On: https://review.openstack.org/579959
Change-Id: I155b5036dd98f80a0d31d8bb691beae147a97bc3

defaults/main.yml

@@ -16,6 +16,11 @@
 ## Verbosity Options
 debug: False
 
+# Set the host which will execute the shade modules
+# for the service setup. The host must already have
+# clouds.yaml properly configured.
+designate_service_setup_host: "{{ openstack_service_setup_host | default('localhost') }}"
+
 # Set the package install state for distribution packages
 # Options are 'present' and 'latest'
 designate_package_state: "latest"
@@ -162,12 +167,6 @@ designate_service_adminuri: "{{ (designate_service_adminurl | default('http://lo
 
 designate_service_in_ldap: False
 
-# designate packages that must be installed before anything else
-designate_requires_pip_packages:
-  - virtualenv
-  - python-keystoneclient # Keystoneclient needed by OSA keystone lib
-  - httplib2
-
 # Common pip packages
 designate_pip_packages:
   - cryptography

meta/main.yml

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

releasenotes/notes/designate-service-setup-host-78466665a752dadd.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    The service setup in keystone for designate will now be executed
+    through delegation to the ``designate_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
+
+      designate_service_setup_host: "{{ groups['utility_all'][0] }}"
+
+deprecations:
+  - |
+    The variable ``designate_requires_pip_packages`` is no longer required
+    and has therefore been removed.

tasks/designate_install_source.yml

@@ -22,19 +22,6 @@
       {% endfor %}
   when: designate_developer_mode | bool
 
-- name: Install requires pip packages
-  pip:
-    name: "{{ designate_requires_pip_packages }}"
-    state: "{{ designate_pip_package_state }}"
-    extra_args: >-
-      {{ designate_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|success
-  retries: 5
-  delay: 2
-
 - name: Retrieve checksum for venv download
   uri:
     url: "{{ designate_venv_download_url | replace('tgz', 'checksum') }}"

tasks/designate_service_setup.yml

@@ -1,5 +1,5 @@
 ---
-# Copyright 2016, Tata Consultancy Services
+# Copyright 2016, Rackspace US, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,80 +13,81 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-- name: Ensure designate service
+# 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: "{{ designate_service_setup_host }}"
-    service_name: "{{ designate_service_name }}"
+  vars:
+    ansible_python_interpreter: >-
+      {{ (designate_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: "{{ designate_service_name }}"
         service_type: "{{ designate_service_type }}"
         description: "{{ designate_service_description }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
       register: add_service
-  until: add_service|success
+      until: add_service is success
       retries: 5
-  delay: 2
+      delay: 10
-  no_log: True
 
-- name: Ensure designate user
+    - name: Add service user
-  keystone:
+      os_user:
-    command: "ensure_user"
+        cloud: default
-    endpoint: "{{ keystone_service_adminurl }}"
+        state: present
-    login_user: "{{ keystone_admin_user_name }}"
+        name: "{{ designate_service_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    user_name: "{{ designate_service_user_name }}"
-    tenant_name: "{{ designate_service_project_name }}"
         password: "{{ designate_service_password }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+        domain: default
+        default_project: "{{ designate_service_project_name }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
       register: add_service
       when: not designate_service_in_ldap | bool
-  until: add_service|success
+      until: add_service is success
       retries: 5
       delay: 10
       no_log: True
 
-- name: Ensure designate user to 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: "{{ designate_service_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        role: "{{ designate_role_name }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        project: "{{ designate_service_project_name }}"
-    user_name: "{{ designate_service_user_name }}"
+        endpoint_type: admin
-    tenant_name: "{{ designate_service_project_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    role_name: "{{ designate_role_name }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
       register: add_service
       when: not designate_service_in_ldap | bool
-  until: add_service|success
+      until: add_service is success
       retries: 5
       delay: 10
-  no_log: True
 
-# Create an endpoint
+    - name: Add endpoints to keystone endpoint catalog
-- name: Ensure designate endpoint
+      os_keystone_endpoint:
-  keystone:
+        cloud: default
-    command: "ensure_endpoint"
+        state: present
-    endpoint: "{{ keystone_service_adminurl }}"
+        service: "{{ designate_service_name }}"
-    login_user: "{{ keystone_admin_user_name }}"
+        endpoint_interface: "{{ item.interface }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        url: "{{ item.url }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        region: "{{ designate_service_region }}"
-    region_name: "{{ designate_service_region }}"
+        endpoint_type: admin
-    service_name: "{{ designate_service_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    service_type: "{{ designate_service_type }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-    endpoint_list:
-      - url: "{{ designate_service_publicuri }}"
-        interface: "public"
-      - url: "{{ designate_service_adminuri }}"
-        interface: "admin"
-      - url: "{{ designate_service_internaluri }}"
-        interface: "internal"
       register: add_service
-  until: add_service|success
+      until: add_service is success
       retries: 5
       delay: 10
-  no_log: True
+      with_items:
+        - interface: "public"
+          url: "{{ designate_service_publicuri }}"
+        - interface: "internal"
+          url: "{{ designate_service_internaluri }}"
+        - interface: "admin"
+          url: "{{ designate_service_adminuri }}"

tests/host_vars/localhost.yml

@@ -16,5 +16,3 @@
 bridges:
   - name: "br-mgmt"
     ip_addr: "10.1.1.1"
-
-ansible_python_interpreter: "/usr/bin/python2"

tests/test-install-designate.yml

@@ -15,7 +15,7 @@
 
 - name: Playbook for deploying designate
   hosts: designate_all
-  user: root
+  remote_user: root
   gather_facts: true
   pre_tasks:
     - include: common/ensure-oslomsg.yml