Add module and cli to extract net VIPs

Add a module and cli playbooks to extact network
Virtual IPs info from a deployed overcloud heat stack.

Related: blueprint network-data-v2-ports
Depends-On: https://review.opendev.org/779502
Change-Id: Iff94e95cb7c488112de4b9ac9947e4513ef8449f

tripleo_ansible/ansible_plugins/modules/tripleo_overcloud_network_vip_extract.py

@@ -0,0 +1,182 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat, Inc.
+# All Rights Reserved.
+#
+# 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.
+#
+
+import yaml
+
+try:
+    from ansible.module_utils import network_data_v2 as n_utils
+except ImportError:
+    from tripleo_ansible.ansible_plugins.module_utils import network_data_v2 as n_utils  # noqa
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.openstack import openstack_full_argument_spec
+from ansible.module_utils.openstack import openstack_module_kwargs
+from ansible.module_utils.openstack import openstack_cloud_from_module
+
+
+ANSIBLE_METADATA = {
+    'metadata_version': '1.1',
+    'status': ['preview'],
+    'supported_by': 'community'
+}
+
+DOCUMENTATION = '''
+---
+module: tripleo_overcloud_network_vip_extract
+
+short_description: Extract information on provisioned overcloud Virtual IPs
+
+version_added: "2.8"
+
+description:
+    - Extract information about provisioned network Virtual IP resources in
+      overcloud heat stack.
+
+options:
+  stack_name:
+    description:
+      - Name of the overcloud heat stack
+    type: str
+author:
+    - Harald Jensås <hjensas@redhat.com>
+'''
+
+RETURN = '''
+vip_data:
+- dns_name: overcloud
+  ip_address: 172.19.0.36
+  name: storage_mgmt_virtual_ip
+  network: storage_mgmt
+  subnet: storage_mgmt_subnet
+- dns_name: overcloud
+  ip_address: 172.17.0.167
+  name: internal_api_virtual_ip
+  network: internal_api
+  subnet: internal_api_subnet
+- dns_name: overcloud
+  ip_address: 172.18.0.83
+  name: storage_virtual_ip
+  network: storage
+  subnet: storage_subnet
+- dns_name: overcloud
+  ip_address: 10.0.0.82
+  name: external_virtual_ip
+  network: external
+  subnet: external_subnet
+- dns_name: overcloud
+  ip_address: 192.168.25.13
+  name: control_virtual_ip
+  network: ctlplane
+  subnet: ctlplane-leaf1
+'''
+
+EXAMPLES = '''
+- name: Get Overcloud Virtual IPs data
+  tripleo_overcloud_network_vip_extract:
+    stack_name: overcloud
+  register: overcloud_vip_data
+- name: Write Virtual IPs data to output file
+  copy:
+    content: "{{ overcloud_vip_data.network_data | to_yaml }}"
+    dest: /path/exported-vip-data.yaml
+'''
+
+
+def update_vip_data(conn, network, vip_ports, vip_data):
+    try:
+        vip = next(vip_ports)
+    except StopIteration:
+        return
+
+    if not vip.fixed_ips:
+        return
+
+    subnet = conn.network.get_subnet(vip.fixed_ips[0]['subnet_id'])
+    vip_data.append(dict(name=vip.name,
+                         network=network.name,
+                         subnet=subnet.name,
+                         ip_address=vip.fixed_ips[0]['ip_address'],
+                         dns_name=vip.dns_name))
+
+
+def find_net_vips(conn, net_resrcs, vip_data):
+    for net in net_resrcs:
+        for res in net_resrcs[net]:
+            if not net_resrcs[net][res]['resource_type'] == n_utils.TYPE_NET:
+                continue
+
+            network = conn.network.get_network(
+                net_resrcs[net][res][n_utils.RES_ID])
+            vip_ports = conn.network.ports(
+                network_id=network.id,
+                name='{}{}'.format(network.name, n_utils.NET_VIP_SUFFIX))
+
+            update_vip_data(conn, network, vip_ports, vip_data)
+
+
+def find_ctlplane_vip(conn, vip_data):
+    network = conn.network.find_network('ctlplane')
+    vip_ports = conn.network.ports(
+        network_id=network.id,
+        name='control{}'.format(n_utils.NET_VIP_SUFFIX))
+
+    update_vip_data(conn, network, vip_ports, vip_data)
+
+
+def run_module():
+    result = dict(
+        success=False,
+        changed=False,
+        error="",
+        vip_data=list()
+    )
+
+    argument_spec = openstack_full_argument_spec(
+        **yaml.safe_load(DOCUMENTATION)['options']
+    )
+
+    module = AnsibleModule(
+        argument_spec,
+        supports_check_mode=False,
+        **openstack_module_kwargs()
+    )
+
+    stack = module.params['stack_name']
+
+    try:
+        _, conn = openstack_cloud_from_module(module)
+        net_resources = n_utils.get_overcloud_network_resources(conn, stack)
+        find_net_vips(conn, net_resources, result['vip_data'])
+        find_ctlplane_vip(conn, result['vip_data'])
+
+        result['changed'] = True if result['vip_data'] else False
+        result['success'] = True if result['vip_data'] else False
+        module.exit_json(**result)
+    except Exception as err:
+        result['error'] = str(err)
+        result['msg'] = ("Error getting Virtual IPs data from overcloud stack "
+                         "{stack_name}: %{error}".format(stack_name=stack,
+                                                         error=err))
+        module.fail_json(**result)
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()