From e6ca28b900faeea744b0513e8daaa18f3f92d323 Mon Sep 17 00:00:00 2001
From: Brad Cowie <brad@wand.net.nz>
Date: Sun, 6 Oct 2024 17:35:19 +1300
Subject: [PATCH] Release role
---
.github/FUNDING.yml | 3 +
.github/dependabot.yml | 7 ++
.github/workflows/lint.yml | 32 ++++++
.github/workflows/test.yml | 39 +++++++
LICENSE | 202 +++++++++++++++++++++++++++++++++
README.md | 114 +++++++++++++++++++
meta/argument_specs.yml | 66 +++++++++++
meta/main.yml | 25 ++++
molecule/default/Dockerfile.j2 | 20 ++++
molecule/default/converge.yml | 38 +++++++
molecule/default/molecule.yml | 19 ++++
test-requirements.txt | 3 +
12 files changed, 568 insertions(+)
create mode 100644 .github/FUNDING.yml
create mode 100644 .github/dependabot.yml
create mode 100644 .github/workflows/lint.yml
create mode 100644 .github/workflows/test.yml
create mode 100644 LICENSE
create mode 100644 README.md
create mode 100644 meta/argument_specs.yml
create mode 100644 meta/main.yml
create mode 100644 molecule/default/Dockerfile.j2
create mode 100644 molecule/default/converge.yml
create mode 100644 molecule/default/molecule.yml
create mode 100644 test-requirements.txt
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..5739302
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+---
+github:
+ - gizmoguy
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..23c4cb3
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,7 @@
+---
+version: 2
+updates:
+ - package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "weekly"
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
new file mode 100644
index 0000000..c07813f
--- /dev/null
+++ b/.github/workflows/lint.yml
@@ -0,0 +1,32 @@
+---
+name: Lint
+
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ ansible-lint:
+ name: Ansible Lint
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - name: Lint ansible
+ uses: wandansible/action-ansible-lint@v1
+
+ jinja2-lint:
+ name: Jinja2 Lint
+ runs-on: ubuntu-latest
+ env:
+ J2LINT_FILES_REGEX: '^templates/.+$'
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - name: Lint jinja2 files
+ uses: wandansible/action-j2lint@v1
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..b487499
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,39 @@
+---
+name: Tests
+
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ generate-matrix:
+ name: Generate matrix
+ runs-on: ubuntu-latest
+ outputs:
+ matrix: ${{ steps.generate-matrix.outputs.matrix }}
+ steps:
+ - name: Generate matrix
+ id: generate-matrix
+ uses: wandnz/action-supported-distro-releases@v1
+
+ molecule:
+ name: Molecule
+ runs-on: ubuntu-latest
+ needs: generate-matrix
+ strategy:
+ matrix:
+ target: ${{ fromJson(needs.generate-matrix.outputs.matrix) }}
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v4
+ - name: Setup python
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.x'
+ - name: Install test dependencies
+ run: pip3 install -r test-requirements.txt
+ - name: Run molecule
+ run: molecule test
+ env:
+ MOLECULE_DOCKER_IMAGE: ${{ matrix.target }}
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f331e2a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2024 Brad Cowie
+
+ 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94f523e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,114 @@
+Ansible role: caddy
+===================
+
+Installs the caddy webserver along with any non-standard caddy plugins required.
+
+Allows for caddy to be configured by adding one or more Caddyfiles.
+
+Role Variables
+--------------
+
+```
+ENTRY POINT: main - Install and configure caddy webserver
+
+ Installs the caddy webserver and non-standard caddy plugins.
+ Allows for configuration of caddy through adding one or more
+ Caddyfiles.
+
+Options (red indicates it is required):
+
+ caddy_apt_key_fingerprint Fingerprint for caddy apt repo GPG key
+ default: 65760C51EDEA2017CEA2CA15155B6D79CA56EA34
+ type: str
+
+ caddy_apt_key_url URL for caddy apt repo GPG key
+ default: https://dl.cloudsmith.io/public/caddy/stable/gpg.key
+ type: str
+
+ caddy_apt_packages List of packages to install
+ default: [caddy]
+ elements: str
+ type: list
+
+ caddy_apt_repo Entry for caddy apt repo in sources.list file
+ default: https://dl.cloudsmith.io/public/caddy/stable/deb/debian any-version main
+ type: str
+
+ caddy_dpkg_hook_script Path to where dpkg hook for caddy should be installed
+ default: /usr/local/bin/caddy-upgrade
+ type: str
+
+ caddy_file Contents of the /etc/caddy/Caddyfile configuration file, or empty
+ string to leave file as is
+ default: ''
+ type: str
+
+ caddy_files List of additional Caddyfiles to create
+ default: []
+ elements: dict
+ type: list
+ options:
+
+ config Contents of the Caddyfile
+ type: str
+
+ dir Directory for the Caddyfile
+ default: null
+ type: str
+
+ name Name of the Caddyfile
+ type: str
+
+ caddy_packages List of non-standard caddy packages to install
+ default: []
+ elements: str
+ type: list
+```
+
+Installation
+------------
+
+This role can either be installed manually with the ansible-galaxy CLI tool:
+
+ ansible-galaxy install git+https://github.com/wandansible/caddy,main,wandansible.caddy
+
+Or, by adding the following to `requirements.yml`:
+
+ roles:
+ - name: wandansible.caddy
+ src: https://github.com/wandansible/caddy
+
+Roles listed in `requirements.yml` can be installed with the following ansible-galaxy command:
+
+ ansible-galaxy install -r requirements.yml
+
+Example Playbook
+----------------
+
+ - hosts: all
+ roles:
+ - role: wandansible.caddy
+ become: true
+ vars:
+ caddy_packages:
+ - github.com/mholt/caddy-webdav
+
+ caddy_file: |
+ import sites-enabled/*.Caddyfile
+
+ caddy_files:
+ - name: website1.Caddyfile
+ dir: sites-enabled
+ config: |
+ website1.example.org {
+ root * /var/www/website1
+ file_server
+ }
+
+ - name: website2.Caddyfile
+ dir: sites-enabled
+ config: |
+ website2.example.org {
+ root * /var/www/website2
+ file_server
+ }
diff --git a/meta/argument_specs.yml b/meta/argument_specs.yml
new file mode 100644
index 0000000..99bc366
--- /dev/null
+++ b/meta/argument_specs.yml
@@ -0,0 +1,66 @@
+---
+argument_specs:
+ main:
+ short_description: Install and configure caddy webserver
+ description: |
+ Installs the caddy webserver along with any non-standard caddy plugins required.
+ Allows for caddy to be configured by adding one or more Caddyfiles.
+ options:
+ caddy_apt_key_fingerprint:
+ description: Fingerprint for caddy apt repo GPG key
+ type: str
+ default: "65760C51EDEA2017CEA2CA15155B6D79CA56EA34"
+
+ caddy_apt_key_url:
+ description: URL for caddy apt repo GPG key
+ type: str
+ default: "https://dl.cloudsmith.io/public/caddy/stable/gpg.key"
+
+ caddy_apt_repo:
+ description: Entry for caddy apt repo in sources.list file
+ type: str
+ default: "https://dl.cloudsmith.io/public/caddy/stable/deb/debian any-version main"
+
+ caddy_apt_packages:
+ description: List of packages to install
+ type: list
+ elements: str
+ default:
+ - caddy
+
+ caddy_packages:
+ description: List of non-standard caddy packages to install
+ type: list
+ elements: str
+ default: []
+
+ caddy_dpkg_hook_script:
+ description: Path to where dpkg hook for caddy should be installed
+ type: str
+ default: "/usr/local/bin/caddy-upgrade"
+
+ caddy_file:
+ description: |
+ Contents of the /etc/caddy/Caddyfile configuration file,
+ or empty string to leave file as is
+ type: str
+ default: ""
+
+ caddy_files:
+ description: |
+ List of additional Caddyfiles to create
+ type: list
+ elements: dict
+ default: []
+ options:
+ name:
+ description: Name of the Caddyfile
+ type: str
+ required: true
+ dir:
+ description: Directory for the Caddyfile
+ type: str
+ config:
+ description: Contents of the Caddyfile
+ type: str
+ required: true
diff --git a/meta/main.yml b/meta/main.yml
new file mode 100644
index 0000000..e78fa42
--- /dev/null
+++ b/meta/main.yml
@@ -0,0 +1,25 @@
+---
+galaxy_info:
+ namespace: wandansible
+ role_name: caddy
+ author: WAND Network Research Group
+ description: Install and configure caddy webserver
+
+ license: Apache-2.0
+
+ min_ansible_version: "2.10"
+
+ platforms:
+ - name: Debian
+ versions:
+ - bullseye
+ - bookworm
+ - trixie
+ - name: Ubuntu
+ versions:
+ - jammy
+ - noble
+
+ galaxy_tags: []
+
+dependencies: []
diff --git a/molecule/default/Dockerfile.j2 b/molecule/default/Dockerfile.j2
new file mode 100644
index 0000000..6d84a42
--- /dev/null
+++ b/molecule/default/Dockerfile.j2
@@ -0,0 +1,20 @@
+{% if item.registry is defined and '/' not in item.image %}
+FROM {{ item.registry.url }}/{{ item.image }}
+{% else %}
+FROM {{ item.image }}
+{% endif %}
+
+{% if item.env is defined %}
+{% for var, value in item.env.items() %}
+{% if value %}
+ENV {{ var }} {{ value }}
+{% endif %}
+{% endfor %}
+{% endif %}
+
+RUN export DEBIAN_FRONTEND=noninteractive \
+ && apt-get update \
+ && apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd gnupg \
+ && apt-get clean
+
+CMD ["/lib/systemd/systemd"]
diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml
new file mode 100644
index 0000000..2647a6c
--- /dev/null
+++ b/molecule/default/converge.yml
@@ -0,0 +1,38 @@
+---
+- name: Converge
+ hosts: all
+ tasks:
+ - name: "Include wandansible.caddy"
+ ansible.builtin.include_role:
+ name: "wandansible.caddy"
+ vars:
+ caddy_packages:
+ - github.com/mholt/caddy-webdav
+
+ caddy_file: |
+ import test.Caddyfile
+ import sites-enabled/*.Caddyfile
+
+ caddy_files:
+ - name: test.Caddyfile
+ config: |
+ :80 {
+ root * /var/www/
+ file_server
+ }
+
+ - name: website1.Caddyfile
+ dir: sites-enabled
+ config: |
+ website1.example.org {
+ root * /var/www/website1
+ file_server
+ }
+
+ - name: website2.Caddyfile
+ dir: sites-enabled
+ config: |
+ website2.example.org {
+ root * /var/www/website2
+ file_server
+ }
diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml
new file mode 100644
index 0000000..d96c253
--- /dev/null
+++ b/molecule/default/molecule.yml
@@ -0,0 +1,19 @@
+---
+dependency:
+ name: galaxy
+driver:
+ name: docker
+platforms:
+ - name: instance
+ image: ${MOLECULE_DOCKER_IMAGE:-ubuntu:latest}
+ pre_build_image: false
+ override_command: false
+ privileged: true
+ volumes:
+ - /sys/fs/cgroup:/sys/fs/cgroup:rw
+ cgroupns_mode: host
+provisioner:
+ name: ansible
+ log: true
+verifier:
+ name: ansible
diff --git a/test-requirements.txt b/test-requirements.txt
new file mode 100644
index 0000000..39779a8
--- /dev/null
+++ b/test-requirements.txt
@@ -0,0 +1,3 @@
+ansible
+molecule
+molecule-plugins[docker]