Repository: ansible/ansible

Issue:
OpenStack Octavia module
<!---
Verify first that your issue/request is not already reported on GitHub.
THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED.
Also test if the latest release, and devel branch are affected too.
ALWAYS add information AFTER (OUTSIDE) these html comments.
Otherwise it may end up being automatically closed by our bot. -->

##### SUMMARY
Support to operate openstack octavia resources in ansible

##### ISSUE TYPE
 - Feature Idea

##### COMPONENT NAME
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature.
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->

- [x] os_loadbalanacer
- [x] os_listener
- [x] os_pool
- [x] os_member

##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below -->
```
ansible 2.5.0
```

##### CONFIGURATION
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed"
Otherwise, mention any settings you have changed/added/removed in ansible.cfg
(or using the ANSIBLE_* environment variables).-->
N/A

##### OS / ENVIRONMENT
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.-->
N/A

##### STEPS TO REPRODUCE
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case.
For new features, show how the feature would be used. -->

<!--- Paste example playbooks or commands between quotes below -->
N/A

<!--- You can also paste gist.github.com links for larger files -->

##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? -->
Octavia related modules could be available in ansible.

##### ACTUAL RESULTS
<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->

<!--- Paste verbatim command output between quotes below -->
There isn't any module related to openstack octavia.



Discussion:
Files identified in the description:
* [lib/ansible/modules/cloud/openstack/os_port.py](https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/openstack/os_port.py)

If these files are inaccurate, please update the `component name` section of the description or use the `!component` bot command.

[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: components_banner --->
cc @dagnello @emonty @juliakreger @omgjlk @rcarrillocruz @shrews @thingee
[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: notify --->
needs_contributor
@Shrews can I raise my hand? I am also contributor in OpenStack Octavia project and it's our customer's requirement for the module.
Can anybody please review this PR?
@lingxiankong Sorry for the delay. They look great, and thanks for contributing.

Resolving patch:
diff --git a/lib/ansible/modules/cloud/openstack/os_member.py b/lib/ansible/modules/cloud/openstack/os_member.py
new file mode 100644
--- /dev/null
+++ b/lib/ansible/modules/cloud/openstack/os_member.py
@@ -0,0 +1,227 @@
+#!/usr/bin/python
+
+# Copyright (c) 2018 Catalyst Cloud Ltd.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: os_member
+short_description: Add/Delete a member for a pool in load balancer from OpenStack Cloud
+extends_documentation_fragment: openstack
+version_added: "2.7"
+author: "Lingxian Kong (@lingxiankong)"
+description:
+   - Add or Remove a member for a pool from the OpenStack load-balancer service.
+options:
+   name:
+     description:
+        - Name that has to be given to the member
+     required: true
+   state:
+     description:
+       - Should the resource be present or absent.
+     choices: [present, absent]
+     default: present
+   pool:
+     description:
+        - The name or id of the pool that this member belongs to.
+     required: true
+   protocol_port:
+     description:
+        - The protocol port number for the member.
+     default: 80
+   address:
+     description:
+        - The IP address of the member.
+   subnet_id:
+     description:
+        - The subnet ID the member service is accessible from.
+   wait:
+     description:
+        - If the module should wait for the load balancer to be ACTIVE.
+     type: bool
+     default: 'yes'
+   timeout:
+     description:
+        - The amount of time the module should wait for the load balancer to get
+          into ACTIVE state.
+     default: 180
+   availability_zone:
+     description:
+       - Ignored. Present for backwards compatibility
+requirements: ["openstacksdk"]
+'''
+
+RETURN = '''
+id:
+    description: The member UUID.
+    returned: On success when I(state) is 'present'
+    type: string
+    sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
+member:
+    description: Dictionary describing the member.
+    returned: On success when I(state) is 'present'
+    type: complex
+    contains:
+        id:
+            description: Unique UUID.
+            type: string
+            sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
+        name:
+            description: Name given to the member.
+            type: string
+            sample: "test"
+        description:
+            description: The member description.
+            type: string
+            sample: "description"
+        provisioning_status:
+            description: The provisioning status of the member.
+            type: string
+            sample: "ACTIVE"
+        operating_status:
+            description: The operating status of the member.
+            type: string
+            sample: "ONLINE"
+        is_admin_state_up:
+            description: The administrative state of the member.
+            type: bool
+            sample: true
+        protocol_port:
+            description: The protocol port number for the member.
+            type: int
+            sample: 80
+        subnet_id:
+            description: The subnet ID the member service is accessible from.
+            type: string
+            sample: "489247fa-9c25-11e8-9679-00224d6b7bc1"
+        address:
+            description: The IP address of the backend member server.
+            type: string
+            sample: "192.168.2.10"
+'''
+
+EXAMPLES = '''
+# Create a member, wait for the member to be created.
+- os_member:
+    cloud: mycloud
+    endpoint_type: admin
+    state: present
+    name: test-member
+    pool: test-pool
+    address: 192.168.10.3
+    protocol_port: 8080
+
+# Delete a listener
+- os_member:
+    cloud: mycloud
+    endpoint_type: admin
+    state: absent
+    name: test-member
+    pool: test-pool
+'''
+
+import time
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.openstack import openstack_full_argument_spec, \
+    openstack_module_kwargs, openstack_cloud_from_module
+
+
+def _wait_for_member_status(module, cloud, pool_id, member_id, status,
+                            failures, interval=5):
+    timeout = module.params['timeout']
+
+    total_sleep = 0
+    if failures is None:
+        failures = []
+
+    while total_sleep < timeout:
+        member = cloud.load_balancer.get_member(member_id, pool_id)
+        provisioning_status = member.provisioning_status
+        if provisioning_status == status:
+            return member
+        if provisioning_status in failures:
+            module.fail_json(
+                msg="Member %s transitioned to failure state %s" %
+                    (member_id, provisioning_status)
+            )
+
+        time.sleep(interval)
+        total_sleep += interval
+
+    module.fail_json(
+        msg="Timeout waiting for member %s to transition to %s" %
+            (member_id, status)
+    )
+
+
+def main():
+    argument_spec = openstack_full_argument_spec(
+        name=dict(required=True),
+        state=dict(default='present', choices=['absent', 'present']),
+        pool=dict(required=True),
+        address=dict(default=None),
+        protocol_port=dict(default=80, type='int'),
+        subnet_id=dict(default=None),
+    )
+    module_kwargs = openstack_module_kwargs()
+    module = AnsibleModule(argument_spec, **module_kwargs)
+    sdk, cloud = openstack_cloud_from_module(module)
+    name = module.params['name']
+    pool = module.params['pool']
+
+    try:
+        changed = False
+
+        pool_ret = cloud.load_balancer.find_pool(name_or_id=pool)
+        if not pool_ret:
+            module.fail_json(msg='pool %s is not found' % pool)
+
+        pool_id = pool_ret.id
+        member = cloud.load_balancer.find_member(name, pool_id)
+
+        if module.params['state'] == 'present':
+            if not member:
+                member = cloud.load_balancer.create_member(
+                    pool_ret,
+                    address=module.params['address'],
+                    name=name,
+                    protocol_port=module.params['protocol_port'],
+                    subnet_id=module.params['subnet_id']
+                )
+                changed = True
+
+                if not module.params['wait']:
+                    module.exit_json(changed=changed,
+                                     member=member.to_dict(),
+                                     id=member.id)
+
+            if module.params['wait']:
+                member = _wait_for_member_status(module, cloud, pool_id,
+                                                 member.id, "ACTIVE",
+                                                 ["ERROR"])
+
+            module.exit_json(changed=changed, member=member.to_dict(),
+                             id=member.id)
+
+        elif module.params['state'] == 'absent':
+            if member:
+                cloud.load_balancer.delete_member(member, pool_ret)
+                changed = True
+
+            module.exit_json(changed=changed)
+    except sdk.exceptions.OpenStackCloudException as e:
+        module.fail_json(msg=str(e), extra_data=e.extra_data)
+
+
+if __name__ == "__main__":
+    main()


Test patch: