From 3cbefaafa2fafa2d3cd3bb3addeea1279401c34b Mon Sep 17 00:00:00 2001 From: Nis Wechselberg Date: Thu, 27 Jun 2024 22:18:51 +0200 Subject: [PATCH] Initial version of woodpecker collection Signed-off-by: Nis Wechselberg --- CHANGELOG.md | 5 ++ README.md | 13 +++++ galaxy.yml | 67 +++++++++++++++++++++++ meta/runtime.yml | 52 ++++++++++++++++++ playbooks/deploy.yml | 5 ++ plugins/README.md | 31 +++++++++++ roles/woodpecker/defaults/main.yml | 9 ++++ roles/woodpecker/handlers/main.yml | 52 ++++++++++++++++++ roles/woodpecker/tasks/main.yml | 87 ++++++++++++++++++++++++++++++ 9 files changed, 321 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 README.md create mode 100644 galaxy.yml create mode 100644 meta/runtime.yml create mode 100644 playbooks/deploy.yml create mode 100644 plugins/README.md create mode 100644 roles/woodpecker/defaults/main.yml create mode 100644 roles/woodpecker/handlers/main.yml create mode 100644 roles/woodpecker/tasks/main.yml diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fac1c60 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 1.0.0 + +* Initial Release \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..11a116a --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Ansible Collection - enbewe.woodpecker + +Collecion to deploy woodpecker build server. + +## Playbooks + +### enbewe.woodpecker.deploy +Deploys the role `enbewe.woodpecker.woodpecker` to all hosts of the group `woodpecker`. + +## Roles +Installs the [Woodpecker CI](https://woodpecker-ci.org/) server as well as a runner as docker containers on the machine. + +The software is deployed as containers in podman. diff --git a/galaxy.yml b/galaxy.yml new file mode 100644 index 0000000..36d71df --- /dev/null +++ b/galaxy.yml @@ -0,0 +1,67 @@ +--- +### 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: 'enbewe' + +# The name of the collection. Has the same character restrictions as 'namespace' +name: 'woodpecker' + +# 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 (url) +# @nicks:irc/im.site#channel' +authors: + - 'Nis Wechselberg ' + + +### OPTIONAL but strongly recommended +# A short summary description of the collection +description: 'Deployment tools for woodpecker build server' + +# 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: + - 'MIT' + +# 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: + - 'linux' + +# 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: + containers.podman: '>=1.13.0' + +# The URL of the originating SCM repository +repository: 'https://git.enbewe.de/Coding/ansible-collection-woodpecker' + +# The URL to any online docs +# documentation: http://docs.example.com + +# The URL to the homepage of the collection/project +# homepage: http://example.com + +# The URL to the collection issue tracker +# issues: http://example.com/issue/tracker + +# 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 diff --git a/meta/runtime.yml b/meta/runtime.yml new file mode 100644 index 0000000..d6c6f44 --- /dev/null +++ b/meta/runtime.yml @@ -0,0 +1,52 @@ +--- +# Collections must specify a minimum required ansible version to upload +# to galaxy +requires_ansible: '>=2.17.0' + +# 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 diff --git a/playbooks/deploy.yml b/playbooks/deploy.yml new file mode 100644 index 0000000..f8f666e --- /dev/null +++ b/playbooks/deploy.yml @@ -0,0 +1,5 @@ +--- +- name: 'Deploy woodpecker role to host group' + hosts: 'woodpecker' + roles: + - 'enbewe.woodpecker.woodpecker' diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 0000000..269a4c2 --- /dev/null +++ b/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.17/plugins/plugins.html). diff --git a/roles/woodpecker/defaults/main.yml b/roles/woodpecker/defaults/main.yml new file mode 100644 index 0000000..e7c96a4 --- /dev/null +++ b/roles/woodpecker/defaults/main.yml @@ -0,0 +1,9 @@ +--- +woodpecker_podman_network: 'woodpecker' + +woodpecker_server_image_name: 'docker.io/woodpeckerci/woodpecker-server' +woodpecker_server_image_tag: 'latest-alpine' +woodpecker_agent_image_name: 'docker.io/woodpeckerci/woodpecker-agent' +woodpecker_agent_image_tag: 'latest-alpine' + +woodpecker_server_container_name: 'woodpecker-server' diff --git a/roles/woodpecker/handlers/main.yml b/roles/woodpecker/handlers/main.yml new file mode 100644 index 0000000..1ea8b99 --- /dev/null +++ b/roles/woodpecker/handlers/main.yml @@ -0,0 +1,52 @@ +--- +- name: 'Reload woodpecker services' + become: true + ansible.builtin.service: + daemon_reload: true + +- name: 'Restart woodpecker network' + become: true + ansible.builtin.service: + name: '{{ woodpecker_podman_network }}-network' + state: 'restarted' + notify: + - 'Restart woodpecker-server' + - 'Restart woodpecker-agent' + +- name: 'Restart woodpecker volumes' + become: true + ansible.builtin.service: + name: '{{ item }}' + state: 'restarted' + loop: + - '{{ woodpecker_server_data_volume }}-volume' + - '{{ woodpecker_agent_config_volume }}-volume' + notify: + - 'Restart woodpecker-server' + - 'Restart woodpecker-agent' + +- name: 'Restart woodpecker images' + become: true + ansible.builtin.service: + name: '' + state: 'restarted' + loop: + - 'woodpecker-server-image' + - 'woodpecker-agent-image' + notify: + - 'Restart woodpecker-server' + - 'Restart woodpecker-agent' + +- name: 'Restart woodpecker-server' + become: true + ansible.builtin.service: + name: 'woodpecker-server' + state: 'restarted' + +- name: 'Restart woodpecker-agent' + become: true + ansible.builtin.service: + name: 'woodpecker-agent' + state: 'restarted' + + diff --git a/roles/woodpecker/tasks/main.yml b/roles/woodpecker/tasks/main.yml new file mode 100644 index 0000000..1abd7bf --- /dev/null +++ b/roles/woodpecker/tasks/main.yml @@ -0,0 +1,87 @@ +--- +- name: 'Install required software' + become: true + ansible.builtin.apt: + name: 'podman' + state: 'present' + +- name: 'Prepare network' + become: true + containers.podman.podman_network: + name: '{{ woodpecker_podman_network }}' + state: 'quadlet' + notify: + - 'Reload woodpecker services' + - 'Restart woodpecker network' + +- name: 'Create woodpecker volumes' + become: true + containers.podman.podman_volume: + name: '{{ item }}' + state: 'quadlet' + loop: + - '{{ woodpecker_server_data_volume }}' + - '{{ woodpecker_agent_config_volume }}' + notify: + - 'Reload woodpecker services' + - 'Restart woodpecker volumes' + +- name: 'Define woodpecker images' + become: true + containers.podman.podman_image: + name: '{{ item.image }}' + quadlet_filename: '{{ item.quadlet_name }}' + state: 'quadlet' + loop: + - image: '{{ woodpecker_server_image_name }}:{{ woodpecker_server_image_tag }}' + quadlet_name: 'woodpecker-server' + - image: '{{ woodpecker_agent_image_name }}:{{ woodpecker_agent_image_tag }}' + quadlet_name: 'woodpecker-agent' + notify: + - 'Reload woodpecker services' + - 'Restart woodpecker images' + +- name: 'Create woodpecker-server container' + become: true + containers.podman.podman_container: + name: '{{ woodpecker_server_container_name }}' + image: 'woodpecker-server.image' + network: '{{ woodpecker_podman_network }}.network' + state: 'quadlet' + volume: + - '{{ woodpecker_server_data_volume }}.volume:/var/lib/woodpecker' + env: '{{ woodpecker_server_environments }}' + quadlet_options: | + [Install] + WantedBy=default.target + [Unit] + Requires={{ woodpecker_podman_network }}-network.service + Requires={{ woodpecker_server_data_volume }}-volume.service + After={{ woodpecker_podman_network }}-network.service + After={{ woodpecker_server_data_volume }}-volume.service + notify: + - 'Reload woodpecker services' + - 'Restart woodpecker-server' + +- name: 'Create woodpecker-agent container' + become: true + containers.podman.podman_container: + name: 'woodpecker-agent' + image: 'woodpecker-agent.image' + network: '{{ woodpecker_podman_network }}.network' + state: 'quadlet' + volume: + - '{{ woodpecker_agent_config_volume }}.volume:/etc/woodpecker' + - '/var/run/podman/podman.sock:/var/run/docker.sock' + env: '{{ woodpecker_agent_environments }}' + quadlet_options: | + [Install] + WantedBy=default.target + [Unit] + Requires={{ woodpecker_podman_network }}-network.service + Requires={{ woodpecker_server_data_volume }}-volume.service + After={{ woodpecker_podman_network }}-network.service + After={{ woodpecker_server_data_volume }}-volume.service + notify: + - 'Reload woodpecker services' + - 'Restart woodpecker-agent'