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: I81bb3f872dc93e54861cb720e3b37ab7660a074a

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.
+searchlight_service_setup_host: "{{ openstack_service_setup_host | default('localhost') }}"
+
 # Set the package install state for distribution and pip packages
 # Options are 'present' and 'latest'
 searchlight_package_state: "latest"
@@ -61,13 +66,6 @@ searchlight_system_shell: /bin/false
 searchlight_system_comment: searchlight system user
 searchlight_system_user_home: "/var/lib/{{ searchlight_system_user_name }}"
 
-#: searchlight packages that must be installed before anything else
-searchlight_required_pip_packages:
-  - virtualenv
-  - python-keystoneclient # Keystoneclient needed for OSA keystone lib
-  - httplib2 # so we can use the uri module
-  - python-searchlightclient
-
 #: Common pip packages
 searchlight_pip_packages:
   - cryptography

meta/main.yml

@@ -18,4 +18,3 @@ dependencies:
   - role: apt_package_pinning
     when:
       - ansible_pkg_mgr == 'apt'
-  - openstack_openrc

tasks/searchlight_install.yml

@@ -37,19 +37,6 @@
   when:
     - searchlight_developer_mode | bool
 
-- name: Install required pip packages
-  pip:
-    name: "{{ searchlight_required_pip_packages | join(' ') }}"
-    state: "{{ searchlight_pip_package_state }}"
-    extra_args: >-
-      {{ searchlight_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: Attempt venv download
   get_url:
     url: "{{ searchlight_venv_download_url }}"

tasks/searchlight_service_setup.yml

@@ -13,100 +13,96 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Create a service
+# We set the python interpreter to the ansible runtime venv if
-- name: Ensure Searchlight service
+# the delegation is to localhost so that we get access to the
-  keystone:
+# appropriate python libraries in that venv. If the delegation
-    command: "ensure_service"
+# is to another host, we assume that it is accessible by the
-    endpoint: "{{ keystone_service_adminurl }}"
+# system python instead.
-    login_user: "{{ keystone_admin_user_name }}"
+- name: Setup the service
-    login_password: "{{ keystone_auth_admin_password }}"
+  delegate_to: "{{ searchlight_service_setup_host }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+  vars:
-    service_name: "{{ searchlight_service_name }}"
+    ansible_python_interpreter: >-
-    service_type: "{{ searchlight_service_type }}"
+      {{ (searchlight_service_setup_host == 'localhost') | ternary(ansible_playbook_python, ansible_python['executable']) }}
-    description: "{{ searchlight_service_description }}"
+  block:
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+    - name: Add service to the keystone service catalog
-  register: add_service
+      os_keystone_service:
-  until: add_service is success
+        cloud: default
-  retries: 5
+        state: present
-  delay: 2
+        name: "{{ searchlight_service_name }}"
-  no_log: True
+        service_type: "{{ searchlight_service_type }}"
+        description: "{{ searchlight_service_description }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
 
-# Create the project if needed, assumed to be in default domain.
+    # Create the project if needed, assumed to be in default domain.
-# In many cases this will be present but under some circumstances the project
+    # In many cases this will be present but under some circumstances the project
-# may be unique to Searchlight, esp. when Swift is used for storage.
+    # may be unique to Searchlight, esp. when Swift is used for storage.
-- name: Ensure Searchlight project
+    - name: Add service project
-  keystone:
+      os_project:
-    command: ensure_project
+        cloud: default
-    project_name: "{{ searchlight_service_project_name }}"
+        state: present
-    endpoint: "{{ keystone_service_adminurl }}"
+        name: "{{ searchlight_service_project_name }}"
-    login_user: "{{ keystone_admin_user_name }}"
+        description: "{{ searchlight_service_project_description }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        domain: "Default"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        endpoint_type: admin
-    description: "{{ searchlight_service_project_description }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+      register: add_service
-  register: add_project
+      until: add_service is success
-  until: add_project is success
+      retries: 5
-  retries: 5
+      delay: 10
-  delay: 10
-  no_log: True
 
-# Create an admin user
+    - name: Add service user
-- name: Ensure Searchlight user
+      os_user:
-  keystone:
+        cloud: default
-    command: "ensure_user"
+        state: present
-    endpoint: "{{ keystone_service_adminurl }}"
+        name: "{{ searchlight_service_user_name }}"
-    login_user: "{{ keystone_admin_user_name }}"
+        password: "{{ searchlight_service_password }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        domain: default
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        default_project: "{{ searchlight_service_project_name }}"
-    user_name: "{{ searchlight_service_user_name }}"
+        endpoint_type: admin
-    tenant_name: "{{ searchlight_service_project_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    password: "{{ searchlight_service_password }}"
+      register: add_service
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+      until: add_service is success
-  register: add_user
+      retries: 5
-  until: add_user is success
+      delay: 10
-  retries: 5
+      no_log: True
-  delay: 10
-  no_log: True
 
-# Add a role to the user
+    - name: Add service user to admin role
-- name: Ensure Searchlight user maps to admin role
+      os_user_role:
-  keystone:
+        cloud: default
-    command: "ensure_user_role"
+        state: present
-    endpoint: "{{ keystone_service_adminurl }}"
+        user: "{{ searchlight_service_user_name }}"
-    login_user: "{{ keystone_admin_user_name }}"
+        role: "{{ searchlight_role_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
+        project: "{{ searchlight_service_project_name }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
+        endpoint_type: admin
-    user_name: "{{ searchlight_service_user_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    tenant_name: "{{ searchlight_service_project_name }}"
+      register: add_service
-    role_name: "{{ searchlight_role_name }}"
+      until: add_service is success
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+      retries: 5
-  register: add_admin_role
+      delay: 10
-  until: add_admin_role is success
-  retries: 5
-  delay: 10
-  no_log: True
 
-# Create an endpoint
+    - name: Add endpoints to keystone endpoint catalog
-- name: Ensure Searchlight endpoint
+      os_keystone_endpoint:
-  keystone:
+        cloud: default
-    command: "ensure_endpoint"
+        state: present
-    endpoint: "{{ keystone_service_adminurl }}"
+        service: "{{ searchlight_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: "{{ searchlight_service_region }}"
-    region_name: "{{ searchlight_service_region }}"
+        endpoint_type: admin
-    service_name: "{{ searchlight_service_name }}"
+        verify: "{{ not keystone_service_adminuri_insecure }}"
-    service_type: "{{ searchlight_service_type }}"
+      register: add_service
-    insecure: "{{ keystone_service_adminuri_insecure }}"
+      until: add_service is success
-    endpoint_list:
+      retries: 5
-      - url: "{{ searchlight_service_publicurl }}"
+      delay: 10
-        interface: "public"
+      with_items:
-      - url: "{{ searchlight_service_internalurl }}"
+        - interface: "public"
-        interface: "internal"
+          url: "{{ searchlight_service_publicurl }}"
-      - url: "{{ searchlight_service_adminurl }}"
+        - interface: "internal"
-        interface: "admin"
+          url: "{{ searchlight_service_internalurl }}"
-  register: add_endpoint
+        - interface: "admin"
-  until: add_endpoint is success
+          url: "{{ searchlight_service_adminurl }}"
-  retries: 5
-  delay: 10
-  no_log: True

tests/host_vars/localhost.yml

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

tests/test-install-searchlight.yml

@@ -17,15 +17,15 @@
   hosts: searchlight_all
   user: root
   gather_facts: true
+  vars_files:
+    - common/test-vars.yml
+  vars:
+    elasticsearch_apt_java_package: openjdk-8-jre
   pre_tasks:
     - include: common/ensure-rabbitmq.yml
       vhost_name: "{{ searchlight_rabbitmq_vhost }}"
       user_name: "{{ searchlight_rabbitmq_userid }}"
       user_password: "{{ searchlight_rabbitmq_password }}"
       when: groups['rabbitmq_all'] is defined
-  vars:
-    elasticsearch_apt_java_package: openjdk-8-jre
   roles:
     - role: "os_searchlight"
-  vars_files:
-    - common/test-vars.yml