Move MQ vhost/user creation into role

There is no record for why we implement the MQ vhost/user creation
outside of the role in the playbook, when we could do it inside the
role.

Implementing it inside the role allows us to reduce the quantity of
group_vars duplicated from the role, and allows us to better document
the required variables in the role. The delegation can still be done
as it is done in the playbook too.

In this patch we implement two new variables:
- zun_oslomsg_rpc_setup_host
- zun_oslomsg_notify_setup_host

These are used in the role to allow delegation of the MQ vhost/user
setup for each type to any host, but they default to using the first
member of the applicable oslomsg host group.

We also adjust some of the defaults to automatically inherit existing
vars set in group_vars form the integrated build so that we do not
need to do the wiring in the integrated build's group vars. We still
default them in the role too for independent role usage.

Finally, we remove the test mq setup tasks and clean up any unused
or unnecessary variables configured in tests.

Change-Id: I639a3fa3e138b1ae190325b9794969820267ec23

defaults/main.yml

@@ -123,18 +123,22 @@ zun_rpc_response_timeout: 60
 ## Oslo Messaging info
 
 # RPC
-zun_oslomsg_rpc_transport: rabbit
+zun_oslomsg_rpc_host_group: "{{ oslomsg_rpc_host_group | default('rabbitmq_all') }}"
-zun_oslomsg_rpc_servers: 127.0.0.1
+zun_oslomsg_rpc_setup_host: "{{ (zun_oslomsg_rpc_host_group in groups) | ternary(groups[zun_oslomsg_rpc_host_group][0], 'localhost') }}"
-zun_oslomsg_rpc_port: 5672
+zun_oslomsg_rpc_transport: "{{ oslomsg_rpc_transport | default('rabbit') }}"
-zun_oslomsg_rpc_use_ssl: False
+zun_oslomsg_rpc_servers: "{{ oslomsg_rpc_servers | default('127.0.0.1') }}"
+zun_oslomsg_rpc_port: "{{ oslomsg_rpc_port | default('5672') }}"
+zun_oslomsg_rpc_use_ssl: "{{ oslomsg_rpc_use_ssl | default(False) }}"
 zun_oslomsg_rpc_userid: zun
 zun_oslomsg_rpc_vhost: /zun
 
 # Notify
-zun_oslomsg_notify_transport: rabbit
+zun_oslomsg_notify_host_group: "{{ oslomsg_notify_host_group | default('rabbitmq_all') }}"
-zun_oslomsg_notify_servers: 127.0.0.1
+zun_oslomsg_notify_setup_host: "{{ (zun_oslomsg_notify_host_group in groups) | ternary(groups[zun_oslomsg_notify_host_group][0], 'localhost') }}"
-zun_oslomsg_notify_port: 5672
+zun_oslomsg_notify_transport: "{{ oslomsg_notify_transport | default('rabbit') }}"
-zun_oslomsg_notify_use_ssl: False
+zun_oslomsg_notify_servers: "{{ oslomsg_notify_servers | default('127.0.0.1') }}"
+zun_oslomsg_notify_port: "{{ oslomsg_notify_port | default('5672') }}"
+zun_oslomsg_notify_use_ssl: "{{ oslomsg_notify_use_ssl | default(False) }}"
 zun_oslomsg_notify_userid: "{{ zun_oslomsg_rpc_userid }}"
 zun_oslomsg_notify_password: "{{ zun_oslomsg_rpc_password }}"
 zun_oslomsg_notify_vhost: "{{ zun_oslomsg_rpc_vhost }}"

tasks/main.yml

@@ -36,30 +36,42 @@
   tags:
     - zun-install
 
-- include_tasks: zun_db_setup.yml
+- include_tasks: mq_setup.yml
   when:
-    - zun_services['zun-api']['group'] in group_names
+    - "zun_services['zun-api']['group'] in group_names"
-    - inventory_hostname == ((groups['zun_api'] | intersect(ansible_play_hosts)) | list)[0]
+    - "inventory_hostname == ((groups[zun_services['zun-api']['group']] | intersect(ansible_play_hosts)) | list)[0]"
+  with_items:
+    - oslomsg_setup_host: "{{ zun_oslomsg_rpc_setup_host }}"
+      oslomsg_userid: "{{ zun_oslomsg_rpc_userid }}"
+      oslomsg_password: "{{ zun_oslomsg_rpc_password }}"
+      oslomsg_vhost: "{{ zun_oslomsg_rpc_vhost }}"
+      oslomsg_transport: "{{ zun_oslomsg_rpc_transport }}"
+    - oslomsg_setup_host: "{{ zun_oslomsg_notify_setup_host }}"
+      oslomsg_userid: "{{ zun_oslomsg_notify_userid }}"
+      oslomsg_password: "{{ zun_oslomsg_notify_password }}"
+      oslomsg_vhost: "{{ zun_oslomsg_notify_vhost }}"
+      oslomsg_transport: "{{ zun_oslomsg_notify_transport }}"
+  no_log: true
   tags:
     - zun-config
 
-- include_tasks: zun_amqp_setup.yml
+- include_tasks: zun_db_setup.yml
   when:
-    - zun_services['zun-api']['group'] in group_names
+    - "zun_services['zun-api']['group'] in group_names"
-    - inventory_hostname == ((groups['zun_api'] | intersect(ansible_play_hosts)) | list)[0]
+    - "inventory_hostname == ((groups['zun_api'] | intersect(ansible_play_hosts)) | list)[0]"
   tags:
     - zun-config
 
 - include_tasks: zun_service_setup.yml
   when:
-    - zun_services['zun-api']['group'] in group_names
+    - "zun_services['zun-api']['group'] in group_names"
-    - inventory_hostname == ((groups['zun_api'] | intersect(ansible_play_hosts)) | list)[0]
+    - "inventory_hostname == ((groups['zun_api'] | intersect(ansible_play_hosts)) | list)[0]"
   tags:
     - zun-config
 
 - include_tasks: zun_compute.yml
   when:
-    - zun_services['zun-compute']['group'] in group_names
+    - "zun_services['zun-compute']['group'] in group_names"
   tags:
     - zun-compute
 

tasks/mq_setup.yml

@@ -0,0 +1,45 @@
+---
+# Copyright 2018, 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.
+# 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.
+
+# WARNING:
+# This file is maintained in the openstack-ansible-tests repository.
+# https://git.openstack.org/cgit/openstack/openstack-ansible-tests/tree/sync/mq_setup.yml
+# If you need to modify this file, update the one in the openstack-ansible-tests
+# repository. Once it merges there, the changes will automatically be proposed to
+# all the repositories which use it.
+
+- name: Setup MQ Service (RabbitMQ)
+  delegate_to: "{{ item.oslomsg_setup_host }}"
+  when:
+    - "item.oslomsg_transport == 'rabbit'"
+  block:
+    - name: Add RabbitMQ vhost
+      rabbitmq_vhost:
+        name: "{{ item.oslomsg_vhost }}"
+        state: "present"
+
+    - name: Add RabbitMQ user
+      rabbitmq_user:
+        user: "{{ item.oslomsg_userid }}"
+        password: "{{ item.oslomsg_password }}"
+        vhost: "{{ item.oslomsg_vhost }}"
+        configure_priv: ".*"
+        read_priv: ".*"
+        write_priv: ".*"
+        state: "present"
+        force: true
+      no_log: true
+
+# Note: Add the tasks for additional MQ servers here

tasks/zun_amqp_setup.yml

@@ -1,33 +0,0 @@
----
-# Copyright 2018, 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.
-# 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.
-
-# TODO(ansmith): change to common messaging setup
-- name: Ensure Rabbitmq vhost
-  rabbitmq_vhost:
-    name: "{{ zun_oslomsg_rpc_vhost }}"
-    state: "present"
-  delegate_to: "{{ groups['oslomsg_rpc_all'][0] }}"
-
-- name: Ensure rabbitmq user
-  rabbitmq_user:
-    user: "{{ zun_oslomsg_rpc_userid }}"
-    password: "{{ zun_oslomsg_rpc_password }}"
-    vhost: "{{ zun_oslomsg_rpc_vhost }}"
-    configure_priv: ".*"
-    read_priv: ".*"
-    write_priv: ".*"
-    state: "present"
-  delegate_to: "{{ groups['oslomsg_rpc_all'][0] }}"
-  no_log: true

tests/test-install-zun.yml

@@ -23,13 +23,10 @@
   roles:
     - role: "os_zun"
       zun_oslomsg_rpc_password: secrete
-      zun_oslomsg_notify_password: "{{ zun_oslomsg_rpc_password }}"
       zun_galera_password: secrete
       zun_service_password: secrete
       zun_kuryr_service_password: secrete
       zun_developer_mode: true
-      zun_oslomsg_rpc_servers: "{{ hostvars[groups['oslomsg_rpc_all'][0]]['ansible_host'] }}"
-      zun_oslomsg_notify_servers: "{{ hostvars[groups['oslomsg_notify_all'][0]]['ansible_host'] }}"
       zun_service_publicuri: "http://{{ hostvars[groups['keystone_all'][0]]['ansible_host'] }}:9517"
       zun_service_adminuri: "http://{{ hostvars[groups['keystone_all'][0]]['ansible_host'] }}:9517"
       zun_service_internaluri: "http://{{ hostvars[groups['keystone_all'][0]]['ansible_host'] }}:9517"