Merge pull request #339 from jacobdotcosta/godaddy3

feat: collection to manage GoDaddy API

ansible/README.adoc

@@ -1,9 +1,12 @@
 = Ansible
 Snowdrop Team (Antonio costa)
+Snowdrop Team (Antonio costa)
 :icons: font
 :revdate: {docdate}
+:revdate: {docdate}
 :toc: left
 :toclevels: 3
+:toclevels: 3
 :description: This document introduces some of the key concepts that you should be aware when you play with Ansible in order to configure the environment to let Ansible to access the different machines.
 ifdef::env-github[]
 :tip-caption: :bulb:
@@ -12,6 +15,13 @@ ifdef::env-github[]
 :caution-caption: :fire:
 :warning-caption: :warning:
 endif::[]
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
 
 == Conventions
 
@@ -359,6 +369,22 @@ link:playbook/README.adoc[Ansible Playbooks]: `playbook`
 
 link:roles[Ansible Roles]: `roles`
 
+== Collections
+
+Build a collection
+
+[source,bash]
+----
+ansible-galaxy collection build ansible/ansible_collections/snowdrop/godaddy --output build/ --force
+----
+
+Install a collection
+
+[source,bash]
+----
+ansible-galaxy collection install build/snowdrop-godaddy-$(yq -r .version ansible/ansible_collections/snowdrop/godaddy/galaxy.yml).tar.gz --upgrade
+----
+
 == Development Guide
 
 === Testing

ansible/ansible_collections/snowdrop/godaddy/README.md

@@ -0,0 +1,4 @@
+# Ansible Collection - snowdrop.godaddy
+
+Collection for managing GoDaddy API functions.
+

ansible/ansible_collections/snowdrop/godaddy/galaxy.yml

@@ -0,0 +1,71 @@
+### REQUIRED
+# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
+# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
+# underscores or numbers and cannot contain consecutive underscores
+namespace: snowdrop
+
+# The name of the collection. Has the same character restrictions as 'namespace'
+name: godaddy
+
+# The version of the collection. Must be compatible with semantic versioning
+version: 1.0.0
+
+# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
+readme: README.md
+
+# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
+# @nicks:irc/im.site#channel'
+authors:
+- Snowdrop (Antonio Costa) <[email protected]>
+
+### OPTIONAL but strongly recommended
+# A short summary description of the collection
+description: Godaddy API access
+
+# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
+# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
+license:
+- GPL-2.0-or-later
+
+# The path to the license file for the collection. This path is relative to the root of the collection. This key is
+# mutually exclusive with 'license'
+license_file: ''
+
+# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
+# requirements as 'namespace' and 'name'
+tags: 
+  - dns
+  - godaddy
+  - api
+
+# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
+# collection label 'namespace.name'. The value is a version range
+# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
+# range specifiers can be set and are separated by ','
+dependencies: {}
+
+# The URL of the originating SCM repository
+repository: https://github.com/snowdrop/k8s-infra
+
+# The URL to any online docs
+documentation: https://github.com/snowdrop/k8s-infra
+
+# The URL to the homepage of the collection/project
+homepage: https://github.com/snowdrop/k8s-infra
+
+# The URL to the collection issue tracker
+issues: https://github.com/snowdrop/k8s-infra/issues
+
+# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
+# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
+# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
+# and '.git' are always filtered. Mutually exclusive with 'manifest'
+build_ignore: []
+
+# A dict controlling use of manifest directives used in building the collection artifact. The key 'directives' is a
+# list of MANIFEST.in style
+# L(directives,https://packaging.python.org/en/latest/guides/using-manifest-in/#manifest-in-commands). The key
+# 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive
+# with 'build_ignore'
+# manifest: null
+

ansible/ansible_collections/snowdrop/godaddy/meta/runtime.yml

@@ -0,0 +1,52 @@
+---
+# Collections must specify a minimum required ansible version to upload
+# to galaxy
+requires_ansible: '>=2.9.10'
+
+# Content that Ansible needs to load from another location or that has
+# been deprecated/removed
+# plugin_routing:
+#   action:
+#     redirected_plugin_name:
+#       redirect: ns.col.new_location
+#     deprecated_plugin_name:
+#       deprecation:
+#         removal_version: "4.0.0"
+#         warning_text: |
+#           See the porting guide on how to update your playbook to
+#           use ns.col.another_plugin instead.
+#     removed_plugin_name:
+#       tombstone:
+#         removal_version: "2.0.0"
+#         warning_text: |
+#           See the porting guide on how to update your playbook to
+#           use ns.col.another_plugin instead.
+#   become:
+#   cache:
+#   callback:
+#   cliconf:
+#   connection:
+#   doc_fragments:
+#   filter:
+#   httpapi:
+#   inventory:
+#   lookup:
+#   module_utils:
+#   modules:
+#   netconf:
+#   shell:
+#   strategy:
+#   terminal:
+#   test:
+#   vars:
+
+# Python import statements that Ansible needs to load from another location
+# import_redirection:
+#   ansible_collections.ns.col.plugins.module_utils.old_location:
+#     redirect: ansible_collections.ns.col.plugins.module_utils.new_location
+
+# Groups of actions/modules that take a common set of options
+# action_groups:
+#   group_name:
+#     - module1
+#     - module2

ansible/ansible_collections/snowdrop/godaddy/plugins/README.md

@@ -0,0 +1,31 @@
+# Collections Plugins Directory
+
+This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
+is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
+would contain module utils and modules respectively.
+
+Here is an example directory of the majority of plugins currently supported by Ansible:
+
+```
+└── plugins
+    ├── action
+    ├── become
+    ├── cache
+    ├── callback
+    ├── cliconf
+    ├── connection
+    ├── filter
+    ├── httpapi
+    ├── inventory
+    ├── lookup
+    ├── module_utils
+    ├── modules
+    ├── netconf
+    ├── shell
+    ├── strategy
+    ├── terminal
+    ├── test
+    └── vars
+```
+
+A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.15/plugins/plugins.html).

ansible/ansible_collections/snowdrop/godaddy/roles/dns/.yamllint

@@ -0,0 +1,33 @@
+---
+# Based on ansible-lint config
+extends: default
+
+rules:
+  braces:
+    max-spaces-inside: 1
+    level: error
+  brackets:
+    max-spaces-inside: 1
+    level: error
+  colons:
+    max-spaces-after: -1
+    level: error
+  commas:
+    max-spaces-after: -1
+    level: error
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  empty-lines:
+    max: 3
+    level: error
+  hyphens:
+    level: error
+  indentation: disable
+  key-duplicates: enable
+  line-length: disable
+  new-line-at-end-of-file: disable
+  new-lines:
+    type: unix
+  trailing-spaces: disable
+  truthy: disable

ansible/ansible_collections/snowdrop/godaddy/roles/dns/README.md

@@ -0,0 +1,120 @@
+Role Name
+=========
+
+CRUD operations for GoDaddy DNS records.
+
+Requirements
+------------
+
+N/A
+
+Role Variables
+--------------
+
+**Variables** defined at `defaults/main.yml`.
+
+| Variable | Description
+| --- | ---
+| `pro_api_url` | URL for the GoDaddy production API
+| `ote_api_url` | URL for the GoDaddy OTE (Open Transaction Environment) API
+| `domains_folder` | API URI folder for the domains
+| `dns_records_folder` | API URI folder for the DNS records
+
+**Parameters**
+
+| Parameter | DNS Description
+| --- | ---
+| `api_environment`<br/><span style="color:fuchsia">string</span> | GoDaddy API environment to use:<ul><li>_Empty/Default_: OTE</li><li>`production` or `prod`: Production</li></ul>
+| `state`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | State of the record: <ul><li>`present`</li><li>`absent`</li></ul>
+| `domain_name`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | GoDaddy domain to associate the DNS record with. 
+| `record_type`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | DNS type of the record
+| `record_name`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | Name of the DNS record
+| `dns`<br/><span style="color:fuchsia">json</span><br/><span style="color:red">required</span> | DNS data
+
+The contents of the `dns` variables are the following.
+
+```json
+[
+  {
+    "data": "string",
+    "port": 65535,
+    "priority": 0,
+    "protocol": "string",
+    "service": "string",
+    "ttl": 0,
+    "weight": 0
+  }
+]
+```
+
+| Parameter | Description
+| --- | ---
+| `data`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | GoDaddy API environment to use:<ul><li>_Empty/Default_: OTE</li><li>`production` or `prod`: Production</li></ul>
+| `priority`<br/><span style="color:fuchsia">integer</span> | Check the GoDaddy API documentation
+| `priority`<br/><span style="color:fuchsia">integer</span> | Check the GoDaddy API documentation
+| `protocol`<br/><span style="color:fuchsia">string</span> | Check the GoDaddy API documentation
+| `service`<br/><span style="color:fuchsia">string</span> | Check the GoDaddy API documentation
+  `ttl`<br/><span style="color:fuchsia">json</span> | Check the GoDaddy API documentation
+| `weight`<br/><span style="color:fuchsia">integer</span> | Check the GoDaddy API documentation
+  `ttl`<br/><span style="color:fuchsia">integer</span> | Check the GoDaddy API documentation
+
+**Authentication information**
+
+| Parameter | DNS Description
+| --- | ---
+| `api_key`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | GoDaddy API key.
+| `api_secret`<br/><span style="color:fuchsia">string</span><br/><span style="color:red">required</span> | GoDaddy API secretkey.
+The role returns the `godaddy_dns` variable with the results of the process.
+
+Dependencies
+------------
+
+N/A.
+
+Example Playbook
+----------------
+
+Create a DNS record.
+
+```yaml
+- name: "GoDaddy DNS create"
+  hosts: localhost
+  gather_facts: True
+
+  tasks:
+    - name: "Create DNS record"
+      include_role:
+        name: "snowdrop.godaddy.dns"
+      vars: 
+        state: "present"
+```
+
+```bash
+ansible-playbook ansible/playbook/godaddy/godaddy_dns_create_passwordstore.yml \ 
+  -e domain_name="<existing_domain>" \ 
+  -e record_type="<dns_record_type>" \ 
+  -e record_name="<dns_record_name" \ 
+  -e '{"dns": {"data": "<ip_address>"}}' \ 
+  -e api_environment=prod
+```
+
+Example for adding a `A` record for `mydomain` at `snowdrop.dev`.
+
+```bash
+ansible-playbook ansible/playbook/godaddy/godaddy_dns_create_passwordstore.yml \ 
+  -e domain_name="snowdrop.dev" \ 
+  -e record_type="A" \ 
+  -e record_name="mydomain" \ 
+  -e '{"dns": {"data": "127.0.0.1"}}' \ 
+  -e api_environment=prod
+```
+
+License
+-------
+
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+Author Information
+------------------
+
+RedHat Snowdrop team.

ansible/ansible_collections/snowdrop/godaddy/roles/dns/defaults/main.yml

@@ -0,0 +1,8 @@
+---
+# defaults file for dns
+pro_api_url: https://api.godaddy.com/v1
+ote_api_url: https://api.ote-godaddy.com/v1
+
+domains_folder: domains
+dns_records_folder: records
+...

ansible/ansible_collections/snowdrop/godaddy/roles/dns/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for dns