diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 0000000..757cb2c --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,9 @@ +skip_list: + - 'yaml' + - 'risky-shell-pipe' + - 'role-name' + +kinds: + - meta: "**/meta/main.yml" + - tasks: "**/tasks/*.yml" + - vars: "**/vars/*.yml" \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fb88c3a --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*.retry +*/__pycache__ +*.pyc +.cache +.venv \ No newline at end of file diff --git a/README.md b/README.md index 225dd44..8121289 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,90 @@ Role Name ========= -A brief description of the role goes here. +**cloudflare-ddns** - Install cloudflare DDNS docker image. -Requirements ------------- - -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +This role helps you push your public IP address on Cloudflare DNS, so your self-hosted sites can be accessed. Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +This role uses the variables listed below, along with default values (see defaults/main.yml). + +You can specify the docker container name and the image version to be used. You can also specify the docker volume where the container should store its relevant data + +```yml +dns_container_name: "cloudflare-dns" +dns_image_version: "latest" +dns_volume_config: "/tmp" +``` + +The `dns_domains` variable contains credentials and domain definitions. Credentials are specified like so: + +```yaml +dns_domains: + auth: + scopedToken: QPExdfoNLwndJPDbt4nK1-yF1z_srC8D0m6-Gv_h +``` +This role allows you to set up DDNS for multiple domains: + +```yaml +dns_domains: + domains: + - name: foo.example.com + type: A + proxied: true + create: true + zoneId: JBFRZWzhTKtRFWgu3X7f3YLX + - name: bar.example.com + type: A + proxied: true + create: true + zoneId: JBFRZWzhTKtRFWgu3X7f3YLY +``` + +All items declared into `dns_domains` are converted to the necessary configuration file via the *config.yaml.j2* template. + +If you want more details on which parameters you can add to `dns_domains`, please see the [container's documentation](https://hub.docker.com/r/oznu/cloudflare-ddns/#!) -Dependencies ------------- -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: +You can see a full example (with dummy vars too!) below. It configures two sub-domains as A records: + +```yaml +- hosts: servers + vars: + dns_container_name: "cloudflare-dns" + dns_image_version: "latest" + dns_volume_config: "/tmp" + dns_domains: + auth: + scopedToken: QPExdfoNLwndJPDbt4nK1-yF1z_srC8D0m6-Gv_h + domains: + - name: foo.example.com + type: A + proxied: true + create: true + zoneId: JBFRZWzhTKtRFWgu3X7f3YLX + - name: bar.example.com + type: A + proxied: true + create: true + zoneId: JBFRZWzhTKtRFWgu3X7f3YLY + + roles: + - 'laurivan.cloudflare_ddns' +``` - - hosts: servers - roles: - - { role: username.rolename, x: 42 } License ------- -BSD +MIT Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +This role was created in 2022 by [Laur Ivan](https://www.laurivan.com). diff --git a/meta/main.yml b/meta/main.yml index e7c34d9..b7e3793 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -1,53 +1,33 @@ -galaxy_info: - author: your name - namespace: ilaur - description: your role description - company: your company (optional) - - # If the issue tracker for your role is not on github, uncomment the - # next line and provide a value - # issue_tracker_url: http://example.com/issue/tracker - - # Choose a valid license ID from https://spdx.org - some suggested licenses: - # - BSD-3-Clause (default) - # - MIT - # - GPL-2.0-or-later - # - GPL-3.0-only - # - Apache-2.0 - # - CC-BY-4.0 - license: license (GPL-2.0-or-later, MIT, etc) - - min_ansible_version: 2.1 - - # If this a Container Enabled role, provide the minimum Ansible Container version. - # min_ansible_container_version: - - # - # Provide a list of supported platforms, and for each platform a list of versions. - # If you don't wish to enumerate all versions for a particular platform, use 'all'. - # To view available platforms and versions (or releases), visit: - # https://galaxy.ansible.com/api/v1/platforms/ - # - # platforms: - # - name: Fedora - # versions: - # - all - # - 25 - # - name: SomePlatform - # versions: - # - all - # - 1.0 - # - 7 - # - 99.99 - - galaxy_tags: [] - # List tags for your role here, one per line. A tag is a keyword that describes - # and categorizes the role. Users find roles by searching for tags. Be sure to - # remove the '[]' above, if you add tags to this list. - # - # NOTE: A tag is limited to a single word comprised of alphanumeric characters. - # Maximum 20 tags per role. - dependencies: [] - # List your role dependencies here, one per line. Be sure to remove the '[]' above, - # if you add dependencies to this list. + +galaxy_info: + author: "Laur Ivan" + role_name: cloudflare_ddns + namespace: laurivan + description: Install cloudflare DDNS in docker + license: license (MIT, BSD) + + min_ansible_version: "2.4" + min_ansible_container_version: "2.4" + + platforms: + - name: Debian + versions: + - buster + - bullseye + - name: Ubuntu + versions: + - bionic + - focal + - jammy + - name: Alpine + version: + - all + - name: ArchLinux + versions: + - all + galaxy_tags: + - cloudflare + - dns + - ddns + - docker diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml index 6da5a04..532467b 100644 --- a/molecule/default/converge.yml +++ b/molecule/default/converge.yml @@ -1,7 +1,34 @@ --- - name: Converge hosts: all - tasks: - - name: "Include ilaur.cloudflare_ddns" - include_role: - name: "ilaur.cloudflare_ddns" + become: true + vars: + dns_container_name: "cloudflare-dns" + dns_image_version: "latest" + dns_volume_config: "/tmp" + dns_domains: + auth: + scopedToken: ${MOLECULE_CF_TOKEN:-} + domains: + - name: foo.example.com + type: A + proxied: true + create: true + zoneId: ${MOLECULE_CF_ZONEID:-} + pre_tasks: + - name: create default directory + file: + path: "{{ swag_data }}/nginx/site-confs" + state: directory + - name: Update apt cache. + apt: update_cache=yes cache_valid_time=600 + when: ansible_os_family == 'Debian' + - name: Install python requests + pip: + name: + - requests + - name: debug + debug: + msg: "{{ hostvars }}" + roles: + - role: laurivan.cloudflare_ddns diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml index b5d8023..291dc02 100644 --- a/molecule/default/molecule.yml +++ b/molecule/default/molecule.yml @@ -1,13 +1,25 @@ --- +role_name_check: 1 dependency: name: galaxy driver: name: docker platforms: - name: instance - image: quay.io/centos/centos:stream8 + image: "geerlingguy/docker-${MOLECULE_DISTRO:-centos7}-ansible:latest" + command: ${MOLECULE_DOCKER_COMMAND:-""} + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:ro + - /var/run/docker.sock:/tmp/docker.sock + privileged: true pre_build_image: true provisioner: name: ansible + playbooks: + converge: ${MOLECULE_PLAYBOOK:-converge.yml} verifier: name: ansible +lint: | + set -e + yamllint . + ansible-lint . \ No newline at end of file diff --git a/molecule/default/prepare.yml b/molecule/default/prepare.yml new file mode 100644 index 0000000..d20b500 --- /dev/null +++ b/molecule/default/prepare.yml @@ -0,0 +1,12 @@ +--- +- name: Setup the intragate machine + hosts: instance + tasks: + - name: create docker.sock + raw: touch /var/run/docker.sock + become: true + changed_when: false + - name: move docker.sock from tmp + raw: mount --move /tmp/docker.sock /var/run/docker.sock + become: true + changed_when: false