Relocate Postgres, Traefik and Woodpecker CI roles to the MASH organi…

…zation
mother-of-all-self-hosting · Sep 27, 2024 · 3dd4b89 · 3dd4b89
1 parent 0d28058
commit 3dd4b89
Show file tree

Hide file tree

Showing 13 changed files with 548 additions and 458 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,20 @@
+# 2024-09-27
+
+## (BC Break) Postgres, Traefik & Woodpecker CI roles have been relocated and variable names need adjustments
+
+Various roles have been relocated from the [devture](https://github.com/devture) organization to the [mother-of-all-self-hosting](https://github.com/mother-of-all-self-hosting) organization.
+
+Along with the relocation, the `devture_` prefix was dropped from their variable names, so you need to adjust your `vars.yml` configuration.
+
+You need to do the following replacements:
+
+- `devture_postgres_` -> `postgres_`
+- `devture_traefik_` -> `traefik_`
+- `devture_woodpecker_ci_` -> `woodpecker_ci_`
+
+As always, the playbook would let you know about this and point out any variables you may have missed.
+
+
 # 2024-07-06
 
 ## Traefik v3 and HTTP/3 are here now
@@ -18,7 +35,7 @@ If you're using the playbook's Traefik instance to reverse-proxy to some other s
 
 If you've tweaked any of this playbook's `_path_prefix` variables and made them use a regular expression, you will now need to make additional adjustments. The playbook makes extensive use of `PathPrefix()` matchers in Traefik rules and `PathPrefix` does not support regular expressions anymore. To work around it, you may now need to override a whole `_traefik_rule` variable and switch it from [`PathPrefix` to `PathRegexp`](https://doc.traefik.io/traefik/routing/routers/#path-pathprefix-and-pathregexp).
 
-You **may potentially downgrade to Traefik v2** (if necessary) by adding `devture_traefik_verison: v2.11.4` to your configuration.
+You **may potentially downgrade to Traefik v2** (if necessary) by adding `traefik_verison: v2.11.4` to your configuration.
 
 
 ### HTTP/3 is enabled by default
@@ -35,7 +52,7 @@ Still, if HTTP/3 cannot function correctly in your setup, it's best to disable a
 To **disable HTTP/3**, you can use the following configuration:
 
 ```yml
-devture_traefik_config_entrypoint_web_secure_http3_enabled: false
+traefik_config_entrypoint_web_secure_http3_enabled: false
 ```
 
 

diff --git a/docs/developer-documentation.md b/docs/developer-documentation.md
@@ -94,7 +94,7 @@ mash_playbook_devture_systemd_service_manager_services_list_auto_itemized:
 ########################################################################
 [...]
 
-mash_playbook_devture_postgres_managed_databases_auto_itemized:
+mash_playbook_postgres_managed_databases_auto_itemized:
   [...]
   # role-specific:YOUR-SERVICE
   - |-
@@ -106,7 +106,7 @@ mash_playbook_devture_postgres_managed_databases_auto_itemized:
       } if gYOUR-SERVICE_enabled else omit)
     }}
   # /role-specific:YOUR-SERVICE
-  
+
   [...]
 ########################################################################
 #                                                                      #
@@ -127,17 +127,17 @@ mash_playbook_devture_postgres_managed_databases_auto_itemized:
 [...]
 
 # role-specific:postgres
-YOUR-SERVICE_database_hostname: "{{ devture_postgres_identifier if devture_postgres_enabled else '' }}"
-YOUR-SERVICE_database_port: "{{ '5432' if devture_postgres_enabled else '' }}"
+YOUR-SERVICE_database_hostname: "{{ postgres_identifier if postgres_enabled else '' }}"
+YOUR-SERVICE_database_port: "{{ '5432' if postgres_enabled else '' }}"
 YOUR-SERVICE_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'db.authentik', rounds=655555) | to_uuid }}"
 YOUR-SERVICE_database_username: "{{ authentik_identifier }}"
 # /role-specific:postgres
 
 YOUR-SERVICE_container_additional_networks_auto: |
   {{
-    ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled and YOUR-SERVICE_database_hostname == devture_postgres_identifier else [])
+    ([postgres_identifier ~ '.service'] if postgres_enabled and YOUR-SERVICE_database_hostname == postgres_identifier else [])
   }}
-  
+
 ########################################################################
 #                                                                      #
 # /YOUR-SERVICE                                                        #
@@ -175,7 +175,7 @@ YOUR-SERVICE_config_mailer_smtp_port: 8025
 YOUR-SERVICE_config_mailer_from: "{{ exim_relay_sender_address if exim_relay_enabled else '' }}"
 YOUR-SERVICE_config_mailer_protocol: "{{ 'smtp' if exim_relay_enabled else '' }}"
 # /role-specific:exim_relay
-  
+
 ########################################################################
 #                                                                      #
 # /YOUR-SERVICE                                                        #

diff --git a/docs/services/forgejo.md b/docs/services/forgejo.md
@@ -64,7 +64,7 @@ You may also wish to look into [Woodpecker CI](woodpecker-ci.md) and [Forgejo Ru
 If you want to integrate Forgejo with [Woodpecker CI](woodpecker-ci.md), and if you plan to serve Woodpecker CI under a subpath on the same host as Forgejo (e.g., Forgejo lives at `https://mash.example.com` and Woodpecker CI lives at `https://mash.example.com/ci`), then you need to configure Forgejo to use the host's external IP when invoking webhooks from Woodpecker CI.  You can do it by setting the following variables:
 
 ```yaml
-forgejo_container_add_host_domain_name: "{{ devture_woodpecker_ci_server_hostname }}"
+forgejo_container_add_host_domain_name: "{{ woodpecker_ci_server_hostname }}"
 forgejo_container_add_host_domain_ip_address: "{{ ansible_host }}"
 
 # If ansible_host points to an internal IP address, you may need to allow Forgejo to make requests to it.

diff --git a/docs/services/postgres-backup.md b/docs/services/postgres-backup.md
@@ -12,15 +12,15 @@ To enable this service, add the following configuration to your `vars.yml` file
 ```yaml
 ########################################################################
 #                                                                      #
-# devture-postgres-backup                                              #
+# postgres-backup                                                      #
 #                                                                      #
 ########################################################################
 
-devture_postgres_backup_enabled: true
+postgres_backup_enabled: true
 
 ########################################################################
 #                                                                      #
-# /devture-postgres-backup                                             #
+# /postgres-backup                                                     #
 #                                                                      #
 ########################################################################
 ```
@@ -30,10 +30,10 @@ Refer to the table below for additional configuration variables and their defaul
 
 | Name                              | Default value                | Description                                                      |
 | :-------------------------------- | :--------------------------- | :--------------------------------------------------------------- |
-|`devture_postgres_backup_enabled`|`false`|Set to true to use [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) to create automatic database backups|
-|`devture_postgres_backup_schedule`| `'@daily'` |Cron-schedule specifying the interval between postgres backups.|
-|`devture_postgres_backup_keep_days`|`7`|Number of daily backups to keep|
-|`devture_postgres_backup_keep_weeks`|`4`|Number of weekly backups to keep|
-|`devture_postgres_backup_keep_months`|`12`|Number of monthly backups to keep|
-|`devture_postgres_backup_base_path` | `"{{ mash_playbook_base_path }}/postgres-backup"` | Base path for postgres-backup. Also see `devture_postgres_backup_data_path` |
-|`devture_postgres_backup_data_path` | `"{{ devture_postgres_backup_base_path }}/data"` | Storage path for postgres-backup database backups |
+|`postgres_backup_enabled`|`false`|Set to true to use [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) to create automatic database backups|
+|`postgres_backup_schedule`| `'@daily'` |Cron-schedule specifying the interval between postgres backups.|
+|`postgres_backup_keep_days`|`7`|Number of daily backups to keep|
+|`postgres_backup_keep_weeks`|`4`|Number of weekly backups to keep|
+|`postgres_backup_keep_months`|`12`|Number of monthly backups to keep|
+|`postgres_backup_base_path` | `"{{ mash_playbook_base_path }}/postgres-backup"` | Base path for postgres-backup. Also see `postgres_backup_data_path` |
+|`postgres_backup_data_path` | `"{{ postgres_backup_base_path }}/data"` | Storage path for postgres-backup database backups |
diff --git a/docs/services/postgres.md b/docs/services/postgres.md
@@ -14,18 +14,18 @@ To enable this service, add the following configuration to your `vars.yml` file
 ```yaml
 ########################################################################
 #                                                                      #
-# devture-postgres                                                     #
+# postgres                                                             #
 #                                                                      #
 ########################################################################
 
-devture_postgres_enabled: true
+postgres_enabled: true
 
 # Put a strong password below, generated with `pwgen -s 64 1` or in another way
-devture_postgres_connection_password: ''
+postgres_connection_password: ''
 
 ########################################################################
 #                                                                      #
-# /devture-postgres                                                    #
+# /postgres                                                            #
 #                                                                      #
 ########################################################################
 ```
@@ -165,15 +165,15 @@ Example: `--extra-vars="postgres_dump_name=mash-postgres-dump.sql"`
 PostgreSQL can be [tuned](https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server) to make it run faster. This is done by passing extra arguments to the Postgres process.
 
 The [Postgres Ansible role](https://github.com/devture/com.devture.ansible.role.postgres) **already does some tuning by default**, which matches the [tuning logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) done by websites like https://pgtune.leopard.in.ua/.
-You can manually influence some of the tuning variables . These parameters (variables) are injected via the `devture_postgres_postgres_process_extra_arguments_auto` variable.
+You can manually influence some of the tuning variables . These parameters (variables) are injected via the `postgres_postgres_process_extra_arguments_auto` variable.
 
 Most users should be fine with the automatically-done tuning. However, you may wish to:
 
-- **adjust the automatically-deterimned tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/devture/com.devture.ansible.role.postgres/blob/main/defaults/main.yml) (see `devture_postgres_max_connections`, `devture_postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `devture_postgres_postgres_process_extra_arguments_auto` variable
+- **adjust the automatically-deterimned tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/devture/com.devture.ansible.role.postgres/blob/main/defaults/main.yml) (see `postgres_max_connections`, `postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `postgres_postgres_process_extra_arguments_auto` variable
 
-- **turn automatically-performed tuning off**: override it like this: `devture_postgres_postgres_process_extra_arguments_auto: []`
+- **turn automatically-performed tuning off**: override it like this: `postgres_postgres_process_extra_arguments_auto: []`
 
-- **add additional tuning parameters**: define your additional Postgres configuration parameters in `devture_postgres_postgres_process_extra_arguments_custom`. See `devture_postgres_postgres_process_extra_arguments_auto` defined in the Postgres role's [default configuration file](https://github.com/devture/com.devture.ansible.role.postgres/blob/main/defaults/main.yml) for inspiration
+- **add additional tuning parameters**: define your additional Postgres configuration parameters in `postgres_postgres_process_extra_arguments_custom`. See `postgres_postgres_process_extra_arguments_auto` defined in the Postgres role's [default configuration file](https://github.com/devture/com.devture.ansible.role.postgres/blob/main/defaults/main.yml) for inspiration
 
 
 ## Recommended other services

diff --git a/docs/services/traefik.md b/docs/services/traefik.md
@@ -14,14 +14,14 @@ To enable this service, add the following configuration to your `vars.yml` file
 ```yaml
 ########################################################################
 #                                                                      #
-# devture-traefik                                                      #
+# traefik                                                              #
 #                                                                      #
 ########################################################################
 
 mash_playbook_reverse_proxy_type: playbook-managed-traefik
 
 # The email address that Traefik will pass to Let's Encrypt when obtaining SSL certificates
-devture_traefik_config_certificatesResolvers_acme_email: [email protected]
+traefik_config_certificatesResolvers_acme_email: [email protected]
 
 # Or, if you'd like to install Traefik yourself:
 #
@@ -30,7 +30,7 @@ devture_traefik_config_certificatesResolvers_acme_email: [email protected]
 
 ########################################################################
 #                                                                      #
-# /devture-traefik                                                     #
+# /traefik                                                             #
 #                                                                      #
 ########################################################################
 ```
@@ -61,39 +61,39 @@ mash_playbook_reverse_proxyable_services_additional_network: traefik
 ## Increase logging verbosity
 
 ```yaml
-devture_traefik_config_log_level: DEBUG
+traefik_config_log_level: DEBUG
 ```
 
 ## Disable access logs
 
 This will disable access logging.
 
 ```yaml
-devture_traefik_config_accessLog_enabled: false
+traefik_config_accessLog_enabled: false
 ```
 
 ## Enable Traefik Dashboard
 
 This will enable a Traefik [Dashboard](https://doc.traefik.io/traefik/operations/dashboard/) UI at `https://traefik.mash.example.com/dashboard/` (note the trailing `/`).
 
 ```yaml
-devture_traefik_dashboard_enabled: true
-devture_traefik_dashboard_hostname: traefik.mash.example.com
-devture_traefik_dashboard_basicauth_enabled: true
-devture_traefik_dashboard_basicauth_user: YOUR_USERNAME_HERE
-devture_traefik_dashboard_basicauth_password: YOUR_PASSWORD_HERE
+traefik_dashboard_enabled: true
+traefik_dashboard_hostname: traefik.mash.example.com
+traefik_dashboard_basicauth_enabled: true
+traefik_dashboard_basicauth_user: YOUR_USERNAME_HERE
+traefik_dashboard_basicauth_password: YOUR_PASSWORD_HERE
 ```
 
 **WARNING**: enabling the dashboard on a hostname you use for something else (like `mash.example.com` in the configuration above) may cause conflicts. Enabling the Traefik Dashboard makes Traefik capture all `/dashboard` and `/api` requests and forward them to itself. If any of the services hosted on the same hostname requires any of these 2 URL prefixes, you will experience problems.
 
 ## Additional configuration
 
-Use the `devture_traefik_configuration_extension_yaml` variable provided by the Traefik Ansible role to override or inject additional settings, even when no dedicated variable exists.
+Use the `traefik_configuration_extension_yaml` variable provided by the Traefik Ansible role to override or inject additional settings, even when no dedicated variable exists.
 
 ```yaml
 # This is a contrived example.
 # You can enable and secure the Dashboard using dedicated variables. See above.
-devture_traefik_configuration_extension_yaml: |
+traefik_configuration_extension_yaml: |
   api:
     dashboard: true
 ```