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

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.
+cloudkitty_service_setup_host: "{{ openstack_service_setup_host | default('localhost') }}"
+
 # Set the package install state for distribution and pip packages
 # Options are 'present' and 'latest'
 cloudkitty_package_state: "latest"
@@ -57,7 +62,6 @@ cloudkitty_service_project_domain_id: default
 cloudkitty_service_project_name: "service"
 cloudkitty_service_user_domain_id: default
 
-cloudkitty_user_domain_name: Default
 cloudkitty_keystone_auth_plugin: password
 cloudkitty_output_backend: cloudkitty.backend.file.FileBackend
 cloudkitty_output_pipeline: osrf
@@ -113,11 +117,6 @@ cloudkitty_pip_packages:
   - SQLAlchemy>=1.0.10
   - tooz
 
-cloudkitty_requires_pip_packages:
-  - virtualenv
-  - python-keystoneclient
-  - httplib2
-
 # This variable is used by the repo_build process to determine
 # which host group to check for members of before building the
 # pip packages required by this role. The value is picked up

meta/main.yml

@@ -36,4 +36,3 @@ galaxy_info:
 dependencies:
   - apt_package_pinning
   - galera_client
-  - openstack_openrc

releasenotes/notes/cloudkitty-service-setup-host-9bd1d7372c501606.yaml

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

tasks/cloudkitty_domain_setup.yml

@@ -1,110 +0,0 @@
----
-# Copyright 2016, Rackspace US, Inc.
-#
-# (C) 2016 Michael Rice <michael.rice@rackspace.com>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-- name: Ensure cloudkitty rating role
-  keystone:
-    command: "ensure_role"
-    role_name: "rating"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    endpoint: "{{ keystone_service_adminurl }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-  no_log: True
-  tags:
-    - cloudkitty-domain
-    - cloudkitty-domain-role
-    - cloudkitty-domain-setup
-    - cloudkitty-config
-
-- name: Ensure cloudkitty user
-  keystone:
-    command: "ensure_user"
-    endpoint: "{{ keystone_service_adminurl }}"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    user_name: "{{ cloudkitty_service_user_name }}"
-    domain_name: "{{ cloudkitty_user_domain_name }}"
-    password: "{{ cloudkitty_service_password }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-  no_log: True
-  tags:
-    - cloudkitty-domain
-    - cloudkitty-domain-setup
-    - cloudkitty-config
-    - cloudkitty-command-bin
-
-- name: Add cloudkitty user to service admin role
-  keystone:
-    command: "ensure_user_role"
-    user_name: "{{ cloudkitty_service_user_name }}"
-    project_name: "service"
-    role_name: "admin"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    endpoint: "{{ keystone_service_adminurl }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-  no_log: True
-  tags:
-    - cloudkitty-domain
-    - cloudkitty-domain-setup
-    - cloudkitty-config
-    - cloudkitty-command-bin
-
-- name: Ensure cloudkitty service
-  keystone:
-    command: "ensure_service"
-    service_name: "cloudkitty"
-    service_type: "rating"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    endpoint: "{{ keystone_service_adminurl }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-  no_log: True
-  tags:
-    - cloudkitty-domain
-    - cloudkitty-domain-setup
-    - cloudkitty-config
-    - cloudkitty-command-bin
-
-- name: Ensure cloudkitty endpoints
-  keystone:
-    command: "ensure_endpoint"
-    service_name: "cloudkitty"
-    service_type: "rating"
-    region_name: "{{ cloudkitty_service_region }}"
-    endpoint_list:
-          - url: "{{ cloudkitty_service_publicurl }}"
-            interface: "public"
-          - url: "{{ cloudkitty_service_internalurl }}"
-            interface: "internal"
-          - url: "{{ cloudkitty_service_adminurl }}"
-            interface: "admin"
-    login_user: "{{ keystone_admin_user_name }}"
-    login_password: "{{ keystone_auth_admin_password }}"
-    login_project_name: "{{ keystone_admin_tenant_name }}"
-    endpoint: "{{ keystone_service_adminurl }}"
-    insecure: "{{ keystone_service_adminuri_insecure }}"
-  no_log: True
-  tags:
-    - cloudkitty-domain
-    - cloudkitty-domain-setup
-    - cloudkitty-config
-    - cloudkitty-command-bin

tasks/cloudkitty_install.yml

@@ -38,22 +38,6 @@
     - cloudkitty-install
     - cloudkitty-pip-packages
 
-- name: Install requires pip packages
-  pip:
-    name: "{{ cloudkitty_requires_pip_packages }}"
-    state: "{{ cloudkitty_pip_package_state }}"
-    extra_args: >-
-      {{ cloudkitty_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
-  tags:
-    - cloudkitty-install
-    - cloudkitty-pip-packages
-
 - name: Retrieve checksum for venv download
   uri:
     url: "{{ cloudkitty_venv_download_url | replace('tgz', 'checksum') }}"

tasks/cloudkitty_service_setup.yml

@@ -0,0 +1,108 @@
+---
+# Copyright 2016, Rackspace US, Inc.
+#
+# (C) 2016 Michael Rice <michael.rice@rackspace.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# We set the python interpreter to the ansible runtime venv if
+# the delegation is to localhost so that we get access to the
+# appropriate python libraries in that venv. If the delegation
+# is to another host, we assume that it is accessible by the
+# system python instead.
+- name: Setup the service
+  delegate_to: "{{ cloudkitty_service_setup_host }}"
+  vars:
+    ansible_python_interpreter: >-
+      {{ (cloudkitty_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: "{{ cloudkitty_service_name }}"
+        service_type: "rating"
+        description: "OpenStack Rating Service"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
+
+    - name: Add rating role
+      os_keystone_role:
+        cloud: default
+        state: present
+        name: "rating"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
+
+    - name: Add service user
+      os_user:
+        cloud: default
+        state: present
+        name: "{{ cloudkitty_service_user_name }}"
+        password: "{{ cloudkitty_service_password }}"
+        domain: default
+        default_project: "{{ cloudkitty_service_project_name }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
+      no_log: True
+
+    - name: Add service user to roles
+      os_user_role:
+        cloud: default
+        state: present
+        user: "{{ cloudkitty_service_user_name }}"
+        role: "{{ item }}"
+        project: "{{ cloudkitty_service_project_name }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      with_items:
+        - "admin"
+        - "rating"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
+
+    - name: Add endpoints to keystone endpoint catalog
+      os_keystone_endpoint:
+        cloud: default
+        state: present
+        service: "{{ cloudkitty_service_name }}"
+        endpoint_interface: "{{ item.interface }}"
+        url: "{{ item.url }}"
+        region: "{{ cloudkitty_service_region }}"
+        endpoint_type: admin
+        verify: "{{ not keystone_service_adminuri_insecure }}"
+      register: add_service
+      until: add_service is success
+      retries: 5
+      delay: 10
+      with_items:
+        - interface: "public"
+          url: "{{ cloudkitty_service_publicurl }}"
+        - interface: "internal"
+          url: "{{ cloudkitty_service_internalurl }}"
+        - interface: "admin"
+          url: "{{ cloudkitty_service_adminurl }}"

tasks/main.yml

@@ -43,7 +43,7 @@
 - include: cloudkitty_install.yml
 - include: cloudkitty_post_install.yml
 
-- include: cloudkitty_domain_setup.yml
+- include: cloudkitty_service_setup.yml
   when: inventory_hostname == groups['cloudkitty_all'][0]
 
 - include: cloudkitty_db_setup.yml

tests/host_vars/localhost.yml

@@ -16,4 +16,3 @@
 bridges:
   - "br-mgmt"
 
-ansible_python_interpreter: "/usr/bin/python2"

tests/test-install-cloudkitty.yml

@@ -15,8 +15,7 @@
 
 - name: Playbook for role testing
   hosts: cloudkitty_all
-  user: root
-  become: true
+  remote_user: root
   gather_facts: true
   pre_tasks:
     - name: Ensure Rabbitmq vhost