new modules for managing exoscale DNS (#2788)

lib/ansible/modules/extras/network/exoscale/exo_dns_domain.py

@@ -0,0 +1,255 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2016, René Moser <mail@renemoser.net>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: exo_dns_domain
+short_description: Manages domain records on Exoscale DNS API.
+description:
+    - Create and remove domain records.
+version_added: "2.2"
+author: "René Moser (@resmo)"
+options:
+  name:
+    description:
+      - Name of the record.
+    required: true
+  state:
+    description:
+      - State of the resource.
+    required: false
+    default: 'present'
+    choices: [ 'present', 'absent' ]
+  api_key:
+    description:
+      - API key of the Exoscale DNS API.
+    required: false
+    default: null
+  api_secret:
+    description:
+      - Secret key of the Exoscale DNS API.
+    required: false
+    default: null
+  api_timeout:
+    description:
+      - HTTP timeout to Exoscale DNS API.
+    required: false
+    default: 10
+  api_region:
+    description:
+      - Name of the ini section in the C(cloustack.ini) file.
+    required: false
+    default: cloudstack
+  validate_certs:
+    description:
+      - Validate SSL certs of the Exoscale DNS API.
+    required: false
+    default: true
+requirements:
+  - "python >= 2.6"
+notes:
+  - As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack.
+    The config is read from several locations, in the following order.
+    The C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) environment variables.
+    A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file,
+    A C(cloudstack.ini) file in the current working directory.
+    A C(.cloudstack.ini) file in the users home directory.
+    Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini).
+    Use the argument C(api_region) to select the section name, default section is C(cloudstack).
+  - This module does not support multiple A records and will complain properly if you try.
+  - More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/.
+  - This module supports check mode and diff.
+'''
+
+EXAMPLES = '''
+# Create a domain.
+- local_action:
+    module: exo_dns_domain
+    name: example.com
+
+# Remove a domain.
+- local_action:
+    module: exo_dns_domain
+    name: example.com
+    state: absent
+'''
+
+RETURN = '''
+---
+exo_dns_domain:
+    description: API domain results
+    returned: success
+    type: dictionary
+    contains:
+        account_id:
+            description: Your account ID
+            returned: success
+            type: int
+            sample: 34569
+        auto_renew:
+            description: Whether domain is auto renewed or not
+            returned: success
+            type: bool
+            sample: false
+        created_at:
+            description: When the domain was created
+            returned: success
+            type: string
+            sample: "2016-08-12T15:24:23.989Z"
+        expires_on:
+            description: When the domain expires
+            returned: success
+            type: string
+            sample: "2016-08-12T15:24:23.989Z"
+        id:
+            description: ID of the domain
+            returned: success
+            type: int
+            sample: "2016-08-12T15:24:23.989Z"
+        lockable:
+            description: Whether the domain is lockable or not
+            returned: success
+            type: bool
+            sample: true
+        name:
+            description: Domain name
+            returned: success
+            type: string
+            sample: example.com
+        record_count:
+            description: Number of records related to this domain
+            returned: success
+            type: int
+            sample: 5
+        registrant_id:
+            description: ID of the registrant
+            returned: success
+            type: int
+            sample: null
+        service_count:
+            description: Number of services
+            returned: success
+            type: int
+            sample: 0
+        state:
+            description: State of the domain
+            returned: success
+            type: string
+            sample: "hosted"
+        token:
+            description: Token
+            returned: success
+            type: string
+            sample: "r4NzTRp6opIeFKfaFYvOd6MlhGyD07jl"
+        unicode_name:
+            description: Domain name as unicode
+            returned: success
+            type: string
+            sample: "example.com"
+        updated_at:
+            description: When the domain was updated last.
+            returned: success
+            type: string
+            sample: "2016-08-12T15:24:23.989Z"
+        user_id:
+            description: ID of the user
+            returned: success
+            type: int
+            sample: null
+        whois_protected:
+            description: Wheter the whois is protected or not
+            returned: success
+            type: bool
+            sample: false
+'''
+
+# import exoscale common
+from ansible.module_utils.exoscale import *
+
+
+class ExoDnsDomain(ExoDns):
+
+    def __init__(self, module):
+        super(ExoDnsDomain, self).__init__(module)
+        self.name = self.module.params.get('name').lower()
+
+    def get_domain(self):
+        domains = self.api_query("/domains", "GET")
+        for z in domains:
+            if z['domain']['name'].lower() == self.name:
+                return z
+        return None
+
+    def present_domain(self):
+        domain = self.get_domain()
+        data = {
+            'domain': {
+                'name': self.name,
+            }
+        }
+        if not domain:
+            self.result['diff']['after'] = data['domain']
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                domain = self.api_query("/domains", "POST", data)
+        return domain
+
+    def absent_domain(self):
+        domain = self.get_domain()
+        if domain:
+            self.result['diff']['before'] = domain
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                self.api_query("/domains/%s" % domain['domain']['name'], "DELETE")
+        return domain
+
+    def get_result(self, resource):
+        if resource:
+            self.result['exo_dns_domain'] = resource['domain']
+        return self.result
+
+
+def main():
+    argument_spec = exo_dns_argument_spec()
+    argument_spec.update(dict(
+        name=dict(required=True),
+        state=dict(choices=['present', 'absent'], default='present'),
+    ))
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        required_together=exo_dns_required_together(),
+        supports_check_mode=True
+    )
+
+    exo_dns_domain = ExoDnsDomain(module)
+    if module.params.get('state') == "present":
+        resource = exo_dns_domain.present_domain()
+    else:
+        resource = exo_dns_domain.absent_domain()
+    result = exo_dns_domain.get_result(resource)
+
+    module.exit_json(**result)
+
+# import module snippets
+from ansible.module_utils.basic import *
+
+if __name__ == '__main__':
+    main()

lib/ansible/modules/extras/network/exoscale/exo_dns_record.py

@@ -0,0 +1,391 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2016, René Moser <mail@renemoser.net>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: exo_dns_record
+short_description: Manages DNS records on Exoscale DNS.
+description:
+    - Create, update and delete records.
+version_added: "2.2"
+author: "René Moser (@resmo)"
+options:
+  name:
+    description:
+      - Name of the record.
+    required: false
+    default: ""
+  domain:
+    description:
+      - Domain the record is related to.
+    required: true
+  record_type:
+    description:
+      - Type of the record.
+    required: false
+    default: A
+    choices: ['A', 'ALIAS', 'CNAME', 'MX', 'SPF', 'URL', 'TXT', 'NS', 'SRV', 'NAPTR', 'PTR', 'AAAA', 'SSHFP', 'HINFO', 'POOL']
+    aliases: ['rtype', 'type']
+  content:
+    description:
+      - Content of the record.
+      - Required if C(state=present) or C(name="")
+    required: false
+    default: null
+    aliases: ['value', 'address']
+  ttl:
+    description:
+      - TTL of the record in seconds.
+    required: false
+    default: 3600
+  prio:
+    description:
+      - Priority of the record.
+    required: false
+    default: null
+    aliases: ['priority']
+  multiple:
+    description:
+      - Whether there are more than one records with similar C(name).
+      - Only allowed with C(record_type=A).
+      - C(content) will not be updated as it is used as key to find the record.
+    required: false
+    default: null
+    aliases: ['priority']
+  state:
+    description:
+      - State of the record.
+    required: false
+    default: 'present'
+    choices: [ 'present', 'absent' ]
+  api_key:
+    description:
+      - API key of the Exoscale DNS API.
+    required: false
+    default: null
+  api_secret:
+    description:
+      - Secret key of the Exoscale DNS API.
+    required: false
+    default: null
+  api_timeout:
+    description:
+      - HTTP timeout to Exoscale DNS API.
+    required: false
+    default: 10
+  api_region:
+    description:
+      - Name of the ini section in the C(cloustack.ini) file.
+    required: false
+    default: cloudstack
+  validate_certs:
+    description:
+      - Validate SSL certs of the Exoscale DNS API.
+    required: false
+    default: true
+requirements:
+  - "python >= 2.6"
+notes:
+  - As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack.
+    The config is read from several locations, in the following order.
+    The C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) environment variables.
+    A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file,
+    A C(cloudstack.ini) file in the current working directory.
+    A C(.cloudstack.ini) file in the users home directory.
+    Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini).
+    Use the argument C(api_region) to select the section name, default section is C(cloudstack).
+  - This module does not support multiple A records and will complain properly if you try.
+  - More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/.
+  - This module supports check mode and diff.
+'''
+
+EXAMPLES = '''
+# Create or update an A record.
+- local_action:
+    module: exo_dns_record
+    name: web-vm-1
+    domain: example.com
+    content: 1.2.3.4
+
+# Update an existing A record with a new IP.
+- local_action:
+    module: exo_dns_record
+    name: web-vm-1
+    domain: example.com
+    content: 1.2.3.5
+
+# Create another A record with same name.
+- local_action:
+    module: exo_dns_record
+    name: web-vm-1
+    domain: example.com
+    content: 1.2.3.6
+    multiple: yes
+
+# Create or update a CNAME record.
+- local_action:
+    module: exo_dns_record
+    name: www
+    domain: example.com
+    record_type: CNAME
+    content: web-vm-1
+
+# Create or update a MX record.
+- local_action:
+    module: exo_dns_record
+    domain: example.com
+    record_type: MX
+    content: mx1.example.com
+    prio: 10
+
+# delete a MX record.
+- local_action:
+    module: exo_dns_record
+    domain: example.com
+    record_type: MX
+    content: mx1.example.com
+    state: absent
+
+# Remove a record.
+- local_action:
+    module: exo_dns_record
+    name: www
+    domain: example.com
+    state: absent
+'''
+
+RETURN = '''
+---
+exo_dns_record:
+    description: API record results
+    returned: success
+    type: dictionary
+    contains:
+        content:
+            description: value of the record
+            returned: success
+            type: string
+            sample: 1.2.3.4
+        created_at:
+            description: When the record was created
+            returned: success
+            type: string
+            sample: "2016-08-12T15:24:23.989Z"
+        domain:
+            description: Name of the domain
+            returned: success
+            type: string
+            sample: example.com
+        domain_id:
+            description: ID of the domain
+            returned: success
+            type: int
+            sample: 254324
+        id:
+            description: ID of the record
+            returned: success
+            type: int
+            sample: 254324
+        name:
+            description: name of the record
+            returned: success
+            type: string
+            sample: www
+        parent_id:
+            description: ID of the parent
+            returned: success
+            type: int
+            sample: null
+        prio:
+            description: Priority of the record
+            returned: success
+            type: int
+            sample: 10
+        record_type:
+            description: Priority of the record
+            returned: success
+            type: string
+            sample: A
+        system_record:
+            description: Whether the record is a system record or not
+            returned: success
+            type: bool
+            sample: false
+        ttl:
+            description: Time to live of the record
+            returned: success
+            type: int
+            sample: 3600
+        updated_at:
+            description: When the record was updated
+            returned: success
+            type: string
+            sample: "2016-08-12T15:24:23.989Z"
+'''
+
+# import exoscale common
+from ansible.module_utils.exoscale import *
+
+
+class ExoDnsRecord(ExoDns):
+
+    def __init__(self, module):
+        super(ExoDnsRecord, self).__init__(module)
+
+        self.content = self.module.params.get('content')
+        if self.content:
+            self.content = self.content.lower()
+
+        self.domain = self.module.params.get('domain').lower()
+        self.name = self.module.params.get('name').lower()
+        if self.name == self.domain:
+            self.name = ""
+
+        self.multiple = self.module.params.get('multiple')
+        self.record_type = self.module.params.get('record_type')
+        if self.multiple and self.record_type != 'A':
+            self.module.fail_json("Multiple is only usable with record_type A")
+
+
+    def _create_record(self, record):
+        self.result['changed'] = True
+        data = {
+            'record': {
+                'name': self.name,
+                'record_type': self.record_type,
+                'content': self.content,
+                'ttl': self.module.params.get('ttl'),
+                'prio': self.module.params.get('prio'),
+            }
+        }
+        self.result['diff']['after'] = data['record']
+        if not self.module.check_mode:
+            record = self.api_query("/domains/%s/records" % self.domain, "POST", data)
+        return record
+
+    def _update_record(self, record):
+        data = {
+            'record': {
+                'name': self.name,
+                'content': self.content,
+                'ttl': self.module.params.get('ttl'),
+                'prio': self.module.params.get('prio'),
+            }
+        }
+        if self.has_changed(data['record'], record['record']):
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                record = self.api_query("/domains/%s/records/%s" % (self.domain, record['record']['id']), "PUT", data)
+        return record
+
+    def get_record(self):
+        domain = self.module.params.get('domain')
+        records = self.api_query("/domains/%s/records" % domain, "GET")
+
+        record = None
+        for r in records:
+            found_record = None
+            if r['record']['record_type'] == self.record_type:
+                r_name = r['record']['name'].lower()
+                r_content = r['record']['content'].lower()
+
+                # there are multiple A records but we found an exact match
+                if self.multiple and self.name == r_name and self.content == r_content:
+                    record = r
+                    break
+
+                # We do not expect to found more then one record with that content
+                if not self.multiple and not self.name and self.content == r_content:
+                    found_record = r
+
+                # We do not expect to found more then one record with that name
+                elif not self.multiple and self.name and self.name == r_name:
+                    found_record = r
+
+                if record and found_record:
+                    self.module.fail_json(msg="More than one record with your params. Use multiple=yes for more than one A record.")
+                if found_record:
+                    record = found_record
+        return record
+
+    def present_record(self):
+        record = self.get_record()
+        if not record:
+            record = self._create_record(record);
+        else:
+            record = self._update_record(record);
+        return record
+
+    def absent_record(self):
+        record = self.get_record()
+        if record:
+            self.result['diff']['before'] = record
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                 self.api_query("/domains/%s/records/%s" % (self.domain, record['record']['id']), "DELETE")
+        return record
+
+    def get_result(self, resource):
+        if resource:
+            self.result['exo_dns_record'] = resource['record']
+            self.result['exo_dns_record']['domain'] = self.domain
+        return self.result
+
+
+def main():
+    argument_spec = exo_dns_argument_spec()
+    argument_spec.update(dict(
+        name=dict(default=""),
+        record_type=dict(choices=['A', 'ALIAS', 'CNAME', 'MX', 'SPF', 'URL', 'TXT', 'NS', 'SRV', 'NAPTR', 'PTR', 'AAAA', 'SSHFP', 'HINFO', 'POOL'], aliases=['rtype', 'type'], default='A'),
+        content=dict(aliases=['value', 'address']),
+        multiple=(dict(type='bool', default=False)),
+        ttl=dict(type='int', default=3600),
+        prio=dict(type='int', aliases=['priority']),
+        domain=dict(required=True),
+        state=dict(choices=['present', 'absent'], default='present'),
+    ))
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        required_together=exo_dns_required_together(),
+        required_if=[
+            ['state', 'present', ['content']],
+            ['name', '', ['content']],
+        ],
+        required_one_of=[
+            ['content', 'name'],
+        ],
+        supports_check_mode=True,
+    )
+
+    exo_dns_record = ExoDnsRecord(module)
+    if module.params.get('state') == "present":
+        resource = exo_dns_record.present_record()
+    else:
+        resource = exo_dns_record.absent_record()
+
+    result = exo_dns_record.get_result(resource)
+    module.exit_json(**result)
+
+# import module snippets
+from ansible.module_utils.basic import *
+
+if __name__ == '__main__':
+    main()