From 798b37d2fe0967065c9cc64f99a5c2816cf93925 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sun, 26 Mar 2023 14:13:14 +0300 Subject: [PATCH 01/20] Remove shell configuration for better compatibility --- justfile | 1 - 1 file changed, 1 deletion(-) diff --git a/justfile b/justfile index bf4b02c..1cbbf60 100644 --- a/justfile +++ b/justfile @@ -5,7 +5,6 @@ default: # Pulls external Ansible roles roles: #!/usr/bin/env sh - set -euo pipefail if [ -x "$(command -v agru)" ]; then agru else From 651c2705e933c91eb0d147a5683bdc3f3d946c27 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sun, 26 Mar 2023 15:51:44 +0300 Subject: [PATCH 02/20] Upgrade PeerTube (v5.1.0-0 -> v5.1.0-1) --- group_vars/mash_servers | 6 ++---- requirements.yml | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/group_vars/mash_servers b/group_vars/mash_servers index be647f6..efba2f6 100644 --- a/group_vars/mash_servers +++ b/group_vars/mash_servers @@ -777,7 +777,7 @@ peertube_base_path: "{{ mash_playbook_base_path }}/{{ mash_playbook_service_base peertube_uid: "{{ mash_playbook_uid }}" peertube_gid: "{{ mash_playbook_gid }}" -peertube_container_additional_networks: | +peertube_container_additional_networks_auto: | {{ ( ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else []) @@ -800,10 +800,8 @@ peertube_config_database_password: "{{ '%s' | format(mash_playbook_generic_secre peertube_config_redis_hostname: "{{ redis_identifier if redis_enabled else '' }}" -peertube_systemd_required_services_list: | +peertube_systemd_required_services_list_auto: | {{ - (['docker.service']) - + ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled and peertube_config_database_hostname == devture_postgres_identifier else []) + ([redis_identifier ~ '.service'] if redis_enabled and peertube_config_redis_hostname == redis_identifier else []) diff --git a/requirements.yml b/requirements.yml index b9fe7a6..67828fd 100644 --- a/requirements.yml +++ b/requirements.yml @@ -77,7 +77,7 @@ version: v26.0.0-0 name: nextcloud - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-peertube.git - version: v5.1.0-0 + version: v5.1.0-1 name: peertube - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-prometheus.git version: v2.43.0-0 From 330baf8993eb7e56c38b56700a841cba3a2841e9 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sun, 26 Mar 2023 17:13:57 +0300 Subject: [PATCH 03/20] Add NetBox service and redo Redis integration for PeerTube --- CHANGELOG.md | 11 ++ docs/running-multiple-instances.md | 210 ++++++++++++++++++++++++++++ docs/services/netbox.md | 211 +++++++++++++++++++++++++++++ docs/services/peertube.md | 147 +++++++++++++++++++- docs/services/redis.md | 13 +- docs/supported-services.md | 1 + group_vars/mash_servers | 64 ++++++++- requirements.yml | 3 + setup.yml | 2 + 9 files changed, 653 insertions(+), 9 deletions(-) create mode 100644 docs/running-multiple-instances.md create mode 100644 docs/services/netbox.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2077f45..6a668a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,14 @@ +# 2023-03-26 + +## (Backward Compatibility Break) PeerTube is no longer wired to Redis automatically + +As described in our [Redis](docs/services/redis.md) services docs, running a single instance of Redis to be used by multiple services is not a good practice. + +For this reason, we're no longer auto-wiring PeerTube to Redis. If you're running other services (which may require Redis in the future) on the same host, it's recommended that you follow the [Creating a Redis instance dedicated to PeerTube](docs/services/peertube.md#creating-a-redis-instance-dedicated-to-peertube) documentation. + +If you're only running PeerTube on a dedicated server (no other services that may need Redis) or you'd like to stick to what you've used until now (a single shared Redis instance), follow the [Using the shared Redis instance for PeerTube](docs/services/peertube.md#using-the-shared-redis-instance-for-peertube) documentation. + + # 2023-03-25 ## (Backward Compatibility Break) Docker no longer installed by default diff --git a/docs/running-multiple-instances.md b/docs/running-multiple-instances.md new file mode 100644 index 0000000..294bbd7 --- /dev/null +++ b/docs/running-multiple-instances.md @@ -0,0 +1,210 @@ +## Running multiple instances of the same service on the same host + +The way this playbook is structured, each Ansible role can only be invoked once and made to install one instance of the service it's responsible for. + +If you need multiple instances (of whichever service), you'll need some workarounds as described below. + +The example below focuses on hosting multiple [Redis](services/redis.md) instances, but you can apply it to hosting multiple instances or whole stacks of any kind. + +Let's say you're managing a host called `mash.example.com` which installs both [PeerTube](services/peertube.md) and [NetBox](services/netbox.md). Both of these services require a [Redis](services/redis.md) instance. If you simply add `redis_enabled: true` to your `mash.example.com` host's `vars.yml` file, you'd get a Redis instance (`mash-redis`), but it's just one instance. As described in our [Redis](services/redis.md) documentation, this is a security problem and potentially fragile as both services may try to read/write the same data and get in conflict with one another. + +We propose that you **don't** add `redis_enabled: true` to your main `mash.example.com` file, but do the following: + +## Re-do your inventory to add supplementary hosts + +Create multiple hosts in your inventory (`inventory/hosts`) which target the same server, like this: + +```ini +[mash_servers] +[mash_servers:children] +mash_example_com + +[mash_example_com] +mash.example.com-netbox-deps ansible_host=1.2.3.4 +mash.example.com-peertube-deps ansible_host=1.2.3.4 +mash.example.com ansible_host=1.2.3.4 +``` + +This creates a new group (called `mash_example_com`) which groups all 3 hosts: + +- (**new**) `mash.example.com-netbox-deps` - a new host, for your [NetBox](services/netbox.md) dependencies +- (**new**) `mash.example.com-peertube-deps` - a new host, for your [PeerTube](services/peertube.md) dependencies +- (old) `mash.example.com` - your regular inventory host + +When running Ansible commands later on, you can use the `-l` flag to limit which host to run them against. Here are a few examples: + +- `just install-all` - runs the [installation](installing.md) process on all hosts (3 hosts in this case) +- `just install-all -l mash_example_com` - runs the installation process on all hosts in the `mash_example_com` group (same 3 hosts as `just install-all` in this case) +- `just install-all -l mash.example.com-netbox-deps` - runs the installation process on the `mash.example.com-netbox-deps` host + + +## Adjust the configuration of the supplementary hosts to use a new "namespace" + +Multiple hosts targetting the same server as described above still causes conflicts, because services will use the same paths (e.g. `/mash/redis`) and service/container names (`mash-redis`) everywhere. + +To avoid conflicts, adjust the `vars.yml` file for the new hosts (`mash.example.com-netbox-deps` and `mash.example.com-peertube-deps`) +and set non-default and unique values in the `mash_playbook_service_identifier_prefix` and `mash_playbook_service_base_directory_name_prefix` variables. Examples below: + +`inventory/host_vars/mash.example.com-netbox-deps/vars.yml`: + +```yaml +--- + +######################################################################## +# # +# Playbook # +# # +######################################################################## + +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way +# Various other secrets will be derived from this secret automatically. +mash_playbook_generic_secret_key: '' + +# Override service names and directory path prefixes +mash_playbook_service_identifier_prefix: 'mash-netbox-' +mash_playbook_service_base_directory_name_prefix: 'netbox-' + +######################################################################## +# # +# /Playbook # +# # +######################################################################## + + +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## +``` + +`inventory/host_vars/mash.example.com-peertube-deps/vars.yml`: + +```yaml +--- + +######################################################################## +# # +# Playbook # +# # +######################################################################## + +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way +# Various other secrets will be derived from this secret automatically. +mash_playbook_generic_secret_key: '' + +# Override service names and directory path prefixes +mash_playbook_service_identifier_prefix: 'mash-peertube-' +mash_playbook_service_base_directory_name_prefix: 'peertube-' + +######################################################################## +# # +# /Playbook # +# # +######################################################################## + + +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## +``` + +The above configuration will create **2** Redis instances: + +- `mash-netbox-redis` with its base data path in `/mash/netbox-redis` +- `mash-peertube-redis` with its base data path in `/mash/peertube-redis` + +These instances reuse the `mash` user and group and the `/mash` data path, but are not in conflict with each other. + + +## Adjust the configuration of the base host + +Now that we've created separate Redis instances for both PeerTube and NetBox, we need to put them to use by editing the `vars.yml` file of the main host (the one that installs PeerTbue and NetBox) to wire them to their Redis instances. + +You'll need configuration (`inventory/host_vars/mash.example.com/vars.yml`) like this: + +```yaml +######################################################################## +# # +# netbox # +# # +######################################################################## + +netbox_enabled: true + +# Other NetBox configuration here + +# Point NetBox to its dedicated Redis instance +netbox_environment_variable_redis_host: mash-netbox-redis +netbox_environment_variable_redis_cache_host: mash-netbox-redis + +# Make sure the NetBox service (mash-netbox.service) starts after its dedicated Redis service (mash-netbox-redis.service) +netbox_systemd_required_services_list_custom: + - mash-netbox-redis.service + +# Make sure the NetBox container is connected to the container network of its dedicated Redis service (mash-netbox-redis) +netbox_container_additional_networks_custom: + - mash-netbox-redis + +######################################################################## +# # +# /netbox # +# # +######################################################################## + + + +######################################################################## +# # +# peertube # +# # +######################################################################## + +# Other PeerTube configuration here + +# Point PeerTube to its dedicated Redis instance +peertube_config_redis_hostname: mash-peertube-redis + +# Make sure the PeerTube service (mash-peertube.service) starts after its dedicated Redis service (mash-peertube-redis.service) +peertube_systemd_required_services_list_custom: + - "mash-peertube-redis.service" + +# Make sure the PeerTube container is connected to the container network of its dedicated Redis service (mash-peertube-redis) +peertube_container_additional_networks_custom: + - "mash-peertube-redis" + +######################################################################## +# # +# /peertube # +# # +######################################################################## +``` + + +## Questions & Answers + +**Can't I just use the same Redis instance for multiple services?** + +> You may or you may not. See the [Redis](services/redis.md) documentation for why you shouldn't do this. + +**Can't I just create one host and a separate stack for each service** (e.g. Nextcloud + all dependencies on one inventory host; PeerTube + all dependencies on another inventory host; with both inventory hosts targetting the same server)? + +> That's a possibility which is somewhat clean. The downside is that each "full stack" comes with its own Postgres database which needs to be maintained and upgraded separately. diff --git a/docs/services/netbox.md b/docs/services/netbox.md new file mode 100644 index 0000000..d023d81 --- /dev/null +++ b/docs/services/netbox.md @@ -0,0 +1,211 @@ +# NetBox + +[NetBox](https://docs.netbox.dev/en/stable/) is an open-source web application that provides [IP address management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) and [data center infrastructure management (DCIM)](https://en.wikipedia.org/wiki/Data_center_management#Data_center_infrastructure_management) functionality. + + +## Dependencies + +This service requires the following other services: + +- a [Postgres](postgres.md) database +- a [Redis](redis.md) data-store, installation details [below](#redis) +- a [Traefik](traefik.md) reverse-proxy server + + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +```yaml +######################################################################## +# # +# netbox # +# # +######################################################################## + +netbox_enabled: true + +netbox_hostname: mash.example.com +netbox_path_prefix: /netbox + +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way +netbox_environment_variable_secret_key: '' + +# The following superuser will be created upon launch. +netbox_environment_variable_superuser_name: your_username_here +netbox_environment_variable_superuser_email: your.email@example.com +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way. +# Changing the password subsequently will not affect the user's password. +netbox_environment_variable_superuser_password: '' + +# Redis configuration, as described below + +######################################################################## +# # +# /netbox # +# # +######################################################################## +``` + +### URL + +In the example configuration above, we configure the service to be hosted at `https://mash.example.com/netbox`. + +You can remove the `netbox_path_prefix` variable definition, to make it default to `/`, so that the service is served at `https://mash.example.com/`. + + +### Authentication + +If `netbox_environment_variable_superuser_*` variables are specified, NetBox will try to create the user (if missing). + + +### Redis + +As described on the [Redis](redis.md) documentation page, if you're hosting additional services which require Redis on the same server, you'd better go for installing a separate Redis instance for each service. See [Creating a Redis instance dedicated to NetBox](#creating-a-redis-instance-dedicated-to-netbox). + +If you're only running NetBox on this server and don't need to use Redis for anything else, you can [use a single Redis instance](#using-the-shared-redis-instance-for-netbox). + +#### Using the shared Redis instance for NetBox + +To install a single (non-dedicated) Redis instance (`mash-redis`) and hook NetBox to it, add the following **additional** configuration: + +```yaml +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## + + +######################################################################## +# # +# netbox # +# # +######################################################################## + +# Base configuration as shown above + +# Point NetBox to the shared Redis instance +netbox_config_redis_hostname: "{{ redis_identifier }}" + +# Make sure the NetBox service (mash-netbox.service) starts after the shared Redis service (mash-redis.service) +netbox_systemd_required_services_list_custom: + - "{{ redis_identifier }}.service" + +# Make sure the NetBox container is connected to the container network of the shared Redis service (mash-redis) +netbox_container_additional_networks_custom: + - "{{ redis_identifier }}" + +######################################################################## +# # +# /netbox # +# # +######################################################################## +``` + +This will create a `mash-redis` Redis instance on this host. + +This is only recommended if you won't be installing other services which require Redis. Alternatively, go for [Creating a Redis instance dedicated to NetBox](#creating-a-redis-instance-dedicated-to-netbox). + + +#### Creating a Redis instance dedicated to NetBox + +The following instructions are based on the [Running multiple instances of the same service on the same host](../running-multiple-instances.md) documentation. + +Adjust your `inventory/hosts` file as described in [Re-do your inventory to add supplementary hosts](../running-multiple-instances.md#re-do-your-inventory-to-add-supplementary-hosts), adding a new supplementary host (e.g. if `netbox.example.com` is your main one, create `netbox.example.com-deps`). + +Then, create a new `vars.yml` file for the + +`inventory/host_vars/netbox.example.com-deps/vars.yml`: + +```yaml +--- + +######################################################################## +# # +# Playbook # +# # +######################################################################## + +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way +# Various other secrets will be derived from this secret automatically. +mash_playbook_generic_secret_key: '' + +# Override service names and directory path prefixes +mash_playbook_service_identifier_prefix: 'mash-netbox-' +mash_playbook_service_base_directory_name_prefix: 'netbox-' + +######################################################################## +# # +# /Playbook # +# # +######################################################################## + + +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## +``` + +This will create a `mash-netbox-redis` instance on this host with its data in `/mash/netbox-redis`. + +Then, adjust your main inventory host's variables file (`inventory/host_vars/netbox.example.com/vars.yml`) like this: + +```yaml +######################################################################## +# # +# netbox # +# # +######################################################################## + +# Base configuration as shown above + + +# Point NetBox to its dedicated Redis instance +netbox_environment_variable_redis_host: mash-netbox-redis +netbox_environment_variable_redis_cache_host: mash-netbox-redis + +# Make sure the NetBox service (mash-netbox.service) starts after its dedicated Redis service (mash-netbox-redis.service) +netbox_systemd_required_services_list_custom: + - "mash-netbox-redis.service" + +# Make sure the NetBox container is connected to the container network of its dedicated Redis service (mash-netbox-redis) +netbox_container_additional_networks_custom: + - "mash-netbox-redis" + +######################################################################## +# # +# /netbox # +# # +######################################################################## +``` + + +## Installation + +If you've decided to install a dedicated Redis instance for NetBox, make sure to first do [installation](../installing.md) for the supplementary inventory host (e.g. `netbox.example.com-deps`), before running installation for the main one (e.g. `netbox.example.com`). + + +## Usage + +After installation, you can go to the NetBox URL, as defined in `netbox_hostname` and `netbox_path_prefix`. + +You can log in with the **username** (**not** email) and password specified in the `netbox_environment_variable_superuser*` variables. diff --git a/docs/services/peertube.md b/docs/services/peertube.md index b7c0963..0d530c5 100644 --- a/docs/services/peertube.md +++ b/docs/services/peertube.md @@ -8,7 +8,7 @@ This service requires the following other services: - a [Postgres](postgres.md) database -- a [Redis](redis.md) data-store +- a [Redis](redis.md) data-store, installation details [below](#redis) - a [Traefik](traefik.md) reverse-proxy server @@ -47,6 +47,8 @@ peertube_config_root_user_initial_password: '' # Then, replace the example IP range below, and re-run the playbook. # peertube_trusted_proxies_values_custom: ["172.21.0.0/16"] +# Redis configuration, as described below + ######################################################################## # # # /peertube # @@ -58,6 +60,148 @@ In the example configuration above, we configure the service to be hosted at `ht Hosting PeerTube under a subpath (by configuring the `peertube_path_prefix` variable) does not seem to be possible right now, due to PeerTube limitations. +### Redis + +As described on the [Redis](redis.md) documentation page, if you're hosting additional services which require Redis on the same server, you'd better go for installing a separate Redis instance for each service. See [Creating a Redis instance dedicated to PeerTube](#creating-a-redis-instance-dedicated-to-peertube). + +If you're only running PeerTube on this server and don't need to use Redis for anything else, you can [use a single Redis instance](#using-the-shared-redis-instance-for-peertube). + +#### Using the shared Redis instance for PeerTube + +To install a single (non-dedicated) Redis instance (`mash-redis`) and hook PeerTube to it, add the following **additional** configuration: + +```yaml +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## + + +######################################################################## +# # +# peertube # +# # +######################################################################## + +# Base configuration as shown above + +# Point PeerTube to the shared Redis instance +peertube_config_redis_hostname: "{{ redis_identifier }}" + +# Make sure the PeerTube service (mash-peertube.service) starts after the shared Redis service (mash-redis.service) +peertube_systemd_required_services_list_custom: + - "{{ redis_identifier }}.service" + +# Make sure the PeerTube container is connected to the container network of the shared Redis service (mash-redis) +peertube_container_additional_networks_custom: + - "{{ redis_identifier }}" + +######################################################################## +# # +# /peertube # +# # +######################################################################## +``` + +This will create a `mash-redis` Redis instance on this host. + +This is only recommended if you won't be installing other services which require Redis. Alternatively, go for [Creating a Redis instance dedicated to PeerTube](#creating-a-redis-instance-dedicated-to-peertube). + + +#### Creating a Redis instance dedicated to PeerTube + +The following instructions are based on the [Running multiple instances of the same service on the same host](../running-multiple-instances.md) documentation. + +Adjust your `inventory/hosts` file as described in [Re-do your inventory to add supplementary hosts](../running-multiple-instances.md#re-do-your-inventory-to-add-supplementary-hosts), adding a new supplementary host (e.g. if `peertube.example.com` is your main one, create `peertube.example.com-deps`). + +Then, create a new `vars.yml` file for the + +`inventory/host_vars/peertube.example.com-deps/vars.yml`: + +```yaml +--- + +######################################################################## +# # +# Playbook # +# # +######################################################################## + +# Put a strong secret below, generated with `pwgen -s 64 1` or in another way +# Various other secrets will be derived from this secret automatically. +mash_playbook_generic_secret_key: '' + +# Override service names and directory path prefixes +mash_playbook_service_identifier_prefix: 'mash-peertube-' +mash_playbook_service_base_directory_name_prefix: 'peertube-' + +######################################################################## +# # +# /Playbook # +# # +######################################################################## + + +######################################################################## +# # +# redis # +# # +######################################################################## + +redis_enabled: true + +######################################################################## +# # +# /redis # +# # +######################################################################## +``` + +This will create a `mash-peertube-redis` instance on this host with its data in `/mash/peertube-redis`. + +Then, adjust your main inventory host's variables file (`inventory/host_vars/peertube.example.com/vars.yml`) like this: + +```yaml +######################################################################## +# # +# peertube # +# # +######################################################################## + +# Base configuration as shown above + +# Point PeerTube to its dedicated Redis instance +peertube_config_redis_hostname: mash-peertube-redis + +# Make sure the PeerTube service (mash-peertube.service) starts after its dedicated Redis service (mash-peertube-redis.service) +peertube_systemd_required_services_list_custom: + - "mash-peertube-redis.service" + +# Make sure the PeerTube container is connected to the container network of its dedicated Redis service (mash-peertube-redis) +peertube_container_additional_networks_custom: + - "mash-peertube-redis" + +######################################################################## +# # +# /peertube # +# # +######################################################################## +``` + + +## Installation + +If you've decided to install a dedicated Redis instance for PeerTube, make sure to first do [installation](../installing.md) for the supplementary inventory host (e.g. `peertube.example.com-deps`), before running installation for the main one (e.g. `peertube.example.com`). + ## Usage @@ -68,6 +212,7 @@ You should then be able to log in with: - username: `root` - password: the password you've set in `peertube_config_root_user_initial_password` in `vars.yml` + ## Adjusting the trusted reverse-proxy networks If you go to **Administration** -> **System** -> **Debug** (`/admin/system/debug`), you'll notice that PeerTube reports some local IP instead of your own IP address. diff --git a/docs/services/redis.md b/docs/services/redis.md index 2f7ebd0..9249ac9 100644 --- a/docs/services/redis.md +++ b/docs/services/redis.md @@ -4,12 +4,19 @@ Some of the services installed by this playbook require a Redis data store. -Enabling the Redis database service will automatically wire all other services to use it. +**Warning**: Because Redis is not as flexible as [Postgres](postgres.md) when it comes to authentication and data separation, it's **recommended that you run separate Redis instances** (one for each service). Redis supports multiple database and a [SELECT](https://redis.io/commands/select/) command for switching between them. However, **reusing the same Redis instance is not good enough** because: + +- if all services use the same Redis instance and database (id = 0), services may conflict with one another +- the number of databases is limited to [16 by default](https://github.com/redis/redis/blob/aa2403ca98f6a39b6acd8373f8de1a7ba75162d5/redis.conf#L376-L379), which may or may not be enough. With configuration changes, this is solveable. +- some services do not support switching the Redis database and always insist on using the default one (id = 0) +- Redis [does not support different authentication credentials for its different databases](https://stackoverflow.com/a/37262596), so each service can potentially read and modify other services' data + +If you're only hosting a single service (like [PeerTube](peertube.md) or [NetBox](netbox.md)) on your server, you can get away with running a single instance. If you're hosting multiple services, you should prepare separate instances for each service. ## Configuration -To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process to **host a single instance of the Redis service**: ```yaml ######################################################################## @@ -26,3 +33,5 @@ redis_enabled: true # # ######################################################################## ``` + +To **host multiple instances of the Redis service**, follow the [Running multiple instances of the same service on the same host](../running-multiple-instances.md) documentation or the **Redis** section (if available) of the service you're installing. diff --git a/docs/supported-services.md b/docs/supported-services.md index d677479..a9f95a4 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -15,6 +15,7 @@ | [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) | | [Hubsite](https://github.com/moan0s/hubsite) | A simple, static site that shows an overview of the available services | [Link](services/hubsite.md) | | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) | +| [NetBox](https://docs.netbox.dev/en/stable/) | Web application that provides [IP address management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) and [data center infrastructure management (DCIM)](https://en.wikipedia.org/wiki/Data_center_management#Data_center_infrastructure_management) functionality | [Link](services/netbox.md) | | [Nextcloud](https://nextcloud.com/) | The most popular self-hosted collaboration solution for tens of millions of users at thousands of organizations across the globe. | [Link](services/nextcloud.md) | | [PeerTube](https://joinpeertube.org/) | A tool for sharing online videos | [Link](services/peertube.md) | | [Postgres](https://www.postgresql.org) | A powerful, open source object-relational database system | [Link](services/postgres.md) | diff --git a/group_vars/mash_servers b/group_vars/mash_servers index efba2f6..0e628c9 100644 --- a/group_vars/mash_servers +++ b/group_vars/mash_servers @@ -95,6 +95,12 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': (grafana_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'grafana']}] if grafana_enabled else []) + + ([{'name': (netbox_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'netbox', 'netbox-server']}] if netbox_enabled else []) + + + ([{'name': (netbox_identifier + '-worker.service'), 'priority': 2500, 'groups': ['mash', 'netbox', 'netbox-worker']}] if netbox_enabled else []) + + + ([{'name': (netbox_identifier + '-housekeeping.service'), 'priority': 2500, 'groups': ['mash', 'netbox', 'netbox-housekeeping']}] if netbox_enabled else []) + + ([{'name': (nextcloud_identifier + '-server.service'), 'priority': 2000, 'groups': ['mash', 'nextcloud', 'nextcloud-server']}] if nextcloud_enabled else []) + ([{'name': (nextcloud_identifier + '-cron.timer'), 'priority': 2500, 'groups': ['mash', 'nextcloud', 'nextcloud-cron']}] if nextcloud_enabled else []) @@ -188,6 +194,12 @@ devture_postgres_managed_databases_auto: | 'password': redmine_database_password, }] if redmine_enabled else []) + + ([{ + 'name': netbox_database_name, + 'username': netbox_database_username, + 'password': netbox_database_password, + }] if netbox_enabled else []) + + ([{ 'name': nextcloud_database_name, 'username': nextcloud_database_username, @@ -762,6 +774,52 @@ nextcloud_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) +######################################################################## +# # +# netbox # +# # +######################################################################## + +netbox_enabled: false + +netbox_identifier: "{{ mash_playbook_service_identifier_prefix }}netbox" + +netbox_uid: "{{ mash_playbook_uid }}" +netbox_gid: "{{ mash_playbook_gid }}" + +netbox_base_path: "{{ mash_playbook_base_path }}/{{ mash_playbook_service_base_directory_name_prefix }}netbox" + +netbox_systemd_required_services_list_auto: | + {{ + ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled and nextcloud_database_hostname == devture_postgres_identifier else []) + }} + +netbox_container_additional_networks_auto: | + {{ + ( + ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else []) + + + ([devture_postgres_container_network] if devture_postgres_enabled and netbox_database_hostname == devture_postgres_identifier and netbox_container_network != devture_postgres_container_network else []) + ) | unique + }} + +netbox_container_labels_traefik_enabled: "{{ mash_playbook_traefik_labels_enabled }}" +netbox_container_labels_traefik_docker_network: "{{ mash_playbook_reverse_proxyable_services_additional_network }}" +netbox_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" +netbox_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" + +netbox_database_hostname: "{{ devture_postgres_identifier if devture_postgres_enabled else '' }}" +netbox_database_port: "{{ '5432' if devture_postgres_enabled else '' }}" +netbox_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'db.netbox', rounds=655555) | to_uuid }}" + +######################################################################## +# # +# /netbox # +# # +######################################################################## + + + ######################################################################## # # # peertube # @@ -783,8 +841,6 @@ peertube_container_additional_networks_auto: | ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else []) + ([devture_postgres_container_network] if devture_postgres_enabled and peertube_config_database_hostname == devture_postgres_identifier and peertube_container_network != devture_postgres_container_network else []) - + - ([redis_container_network] if peertube_config_redis_hostname == redis_identifier else []) ) | unique }} @@ -798,13 +854,9 @@ peertube_config_database_port: "{{ '5432' if devture_postgres_enabled else '' }} peertube_config_database_username: peertube peertube_config_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'db.peertube', rounds=655555) | to_uuid }}" -peertube_config_redis_hostname: "{{ redis_identifier if redis_enabled else '' }}" - peertube_systemd_required_services_list_auto: | {{ ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled and peertube_config_database_hostname == devture_postgres_identifier else []) - + - ([redis_identifier ~ '.service'] if redis_enabled and peertube_config_redis_hostname == redis_identifier else []) }} ######################################################################## diff --git a/requirements.yml b/requirements.yml index 67828fd..e4e6196 100644 --- a/requirements.yml +++ b/requirements.yml @@ -73,6 +73,9 @@ - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-gitea.git version: v1.19.0-0 name: gitea +- src: git+https://github.com/mother-of-all-self-hosting/ansible-role-netbox.git + version: v3.4.6-2.5.1-0 + name: netbox - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-nextcloud.git version: v26.0.0-0 name: nextcloud diff --git a/setup.yml b/setup.yml index 4638758..273ed24 100644 --- a/setup.yml +++ b/setup.yml @@ -74,6 +74,8 @@ - role: galaxy/hubsite + - role: galaxy/netbox + - role: galaxy/nextcloud - role: galaxy/peertube From 433df3cfffa5107ba25685cf772f8d054ef4a470 Mon Sep 17 00:00:00 2001 From: Aine Date: Mon, 27 Mar 2023 17:13:45 +0300 Subject: [PATCH 04/20] update uptime-kuma 1.21.0 -> 1.21.1 --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index e4e6196..299acf8 100644 --- a/requirements.yml +++ b/requirements.yml @@ -40,7 +40,7 @@ - src: git+https://gitlab.com/etke.cc/roles/radicale.git version: v3.1.8.1-2 - src: git+https://gitlab.com/etke.cc/roles/uptime_kuma.git - version: v1.21.0-0 + version: v1.21.1-0 - src: git+https://gitlab.com/etke.cc/roles/redis.git version: v7.0.10-0 - src: git+https://gitlab.com/etke.cc/roles/prometheus_node_exporter.git From 2d69737ebd764d26f137906988e0c27abe0d8f93 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 09:20:07 +0300 Subject: [PATCH 05/20] Upgrade PeerTube (v5.1.0-1 -> v5.1.0-2) This main adds support for installing plugins via the web UI. --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index 299acf8..0743398 100644 --- a/requirements.yml +++ b/requirements.yml @@ -80,7 +80,7 @@ version: v26.0.0-0 name: nextcloud - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-peertube.git - version: v5.1.0-1 + version: v5.1.0-2 name: peertube - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-prometheus.git version: v2.43.0-0 From c85146ba788718b7581d907e45d69deaf0aafb27 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 10:27:36 +0300 Subject: [PATCH 06/20] Add Keycloak service --- docs/services/keycloak.md | 61 ++++++++++++++++++++++++++++++++++++++ docs/supported-services.md | 1 + group_vars/mash_servers | 56 ++++++++++++++++++++++++++++++++-- requirements.yml | 3 ++ setup.yml | 2 ++ 5 files changed, 121 insertions(+), 2 deletions(-) create mode 100644 docs/services/keycloak.md diff --git a/docs/services/keycloak.md b/docs/services/keycloak.md new file mode 100644 index 0000000..7e5e235 --- /dev/null +++ b/docs/services/keycloak.md @@ -0,0 +1,61 @@ +# Keycloak + +[Keycloak](https://keycloak.net/) is an open source identity and access management solution. + +**Warning**: this service is a new addition to the playbook. It may not fully work or be configured in a suboptimal manner. + + +## Dependencies + +This service requires the following other services: + +- a [Postgres](postgres.md) database +- a [Traefik](traefik.md) reverse-proxy server + + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +```yaml +######################################################################## +# # +# keycloak # +# # +######################################################################## + +keycloak_enabled: true + +keycloak_hostname: mash.example.com +keycloak_path_prefix: /keycloak + +keycloak_environment_variable_keycloak_admin: your_username_here +# Generating a strong password (e.g. `pwgen -s 64 1`) is recommended +keycloak_environment_variable_keycloak_admin_password: '' + +######################################################################## +# # +# /keycloak # +# # +######################################################################## +``` + +### URL + +In the example configuration above, we configure the service to be hosted at `https://mash.example.com/keycloak`. + +You can remove the `keycloak_path_prefix` variable definition, to make it default to `/`, so that the service is served at `https://mash.example.com/`. + +### Authentication + +On first start, the admin user account will be created as defined with the `keycloak_environment_variable_keycloak_admin` and `keycloak_environment_variable_keycloak_admin_password` variables. + +On each start after that, Keycloak will attempt to create the user again and report a non-fatal error (Keycloak will continue running). + +Subsequent changes to the password will not affect an existing user's password. + +## Usage + +After installation, you can go to the Keycloak URL, as defined in `keycloak_hostname` and `keycloak_path_prefix` and log in as described in [Authentication](#authentication). + +Follow the [Keycloak documentation](https://www.keycloak.org/documentation) or other guides for learning how to use Keycloak. diff --git a/docs/supported-services.md b/docs/supported-services.md index a9f95a4..1a36de1 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -14,6 +14,7 @@ | [Gitea](https://gitea.io/) | A painless self-hosted Git service. | [Link](services/gitea.md) | | [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) | | [Hubsite](https://github.com/moan0s/hubsite) | A simple, static site that shows an overview of the available services | [Link](services/hubsite.md) | +| [Keycloak](https://keycloak.net/) | An open source identity and access management solution. | [Link](services/keycloak.md) | | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) | | [NetBox](https://docs.netbox.dev/en/stable/) | Web application that provides [IP address management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) and [data center infrastructure management (DCIM)](https://en.wikipedia.org/wiki/Data_center_management#Data_center_infrastructure_management) functionality | [Link](services/netbox.md) | | [Nextcloud](https://nextcloud.com/) | The most popular self-hosted collaboration solution for tens of millions of users at thousands of organizations across the globe. | [Link](services/nextcloud.md) | diff --git a/group_vars/mash_servers b/group_vars/mash_servers index 0e628c9..2490530 100644 --- a/group_vars/mash_servers +++ b/group_vars/mash_servers @@ -95,6 +95,10 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': (grafana_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'grafana']}] if grafana_enabled else []) + + ([{'name': (keycloak_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'keycloak']}] if keycloak_enabled else []) + + + ([{'name': (miniflux_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'miniflux']}] if miniflux_enabled else []) + + ([{'name': (netbox_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'netbox', 'netbox-server']}] if netbox_enabled else []) + ([{'name': (netbox_identifier + '-worker.service'), 'priority': 2500, 'groups': ['mash', 'netbox', 'netbox-worker']}] if netbox_enabled else []) @@ -105,8 +109,6 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': (nextcloud_identifier + '-cron.timer'), 'priority': 2500, 'groups': ['mash', 'nextcloud', 'nextcloud-cron']}] if nextcloud_enabled else []) + - ([{'name': (miniflux_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'miniflux']}] if miniflux_enabled else []) - + ([{'name': (peertube_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'peertube']}] if peertube_enabled else []) + ([{'name': (prometheus_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'metrics', 'prometheus']}] if prometheus_enabled else []) @@ -182,6 +184,12 @@ devture_postgres_managed_databases_auto: | 'password': devture_woodpecker_ci_server_database_datasource_password, }] if devture_woodpecker_ci_server_enabled else []) + + ([{ + 'name': keycloak_database_name, + 'username': keycloak_database_username, + 'password': keycloak_database_password, + }] if keycloak_enabled and keycloak_database_type == 'postgres' and keycloak_database_hostname == devture_postgres_identifier else []) + + ([{ 'name': miniflux_database_name, 'username': miniflux_database_username, @@ -682,6 +690,50 @@ grafana_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResol +######################################################################## +# # +# keycloak # +# # +######################################################################## + +keycloak_enabled: false + +keycloak_identifier: "{{ mash_playbook_service_identifier_prefix }}keycloak" + +keycloak_uid: "{{ mash_playbook_uid }}" +keycloak_gid: "{{ mash_playbook_gid }}" + +keycloak_base_path: "{{ mash_playbook_base_path }}/{{ mash_playbook_service_base_directory_name_prefix }}keycloak" + +keycloak_systemd_required_systemd_services_list_auto: | + {{ + ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled and keycloak_database_hostname == devture_postgres_identifier else []) + }} + +keycloak_container_additional_networks_auto: | + {{ + ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else []) + + + ([devture_postgres_container_network] if devture_postgres_enabled and keycloak_database_hostname == devture_postgres_identifier and keycloak_container_network != devture_postgres_container_network else []) + }} + +keycloak_container_labels_traefik_enabled: "{{ mash_playbook_traefik_labels_enabled }}" +keycloak_container_labels_traefik_docker_network: "{{ mash_playbook_reverse_proxyable_services_additional_network }}" +keycloak_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" +keycloak_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" + +keycloak_database_hostname: "{{ devture_postgres_identifier if devture_postgres_enabled else '' }}" +keycloak_database_port: "{{ '5432' if devture_postgres_enabled else '' }}" +keycloak_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'db.keycloak', rounds=655555) | to_uuid }}" + +######################################################################## +# # +# /keycloak # +# # +######################################################################## + + + ######################################################################## # # # miniflux # diff --git a/requirements.yml b/requirements.yml index 0743398..2762faa 100644 --- a/requirements.yml +++ b/requirements.yml @@ -73,6 +73,9 @@ - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-gitea.git version: v1.19.0-0 name: gitea +- src: git+https://github.com/mother-of-all-self-hosting/ansible-role-keycloak.git + version: v21.0.1-0 + name: keycloak - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-netbox.git version: v3.4.6-2.5.1-0 name: netbox diff --git a/setup.yml b/setup.yml index 273ed24..78904fe 100644 --- a/setup.yml +++ b/setup.yml @@ -70,6 +70,8 @@ - role: galaxy/grafana + - role: galaxy/keycloak + - role: galaxy/miniflux - role: galaxy/hubsite From 28d15a6af306cd8294bea46f7664f2f2ae4cbd7f Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 10:29:41 +0300 Subject: [PATCH 07/20] Upgrade Keycloak (v21.0.1-0 -> v21.0.1-1) and fix URLs --- docs/services/keycloak.md | 2 +- docs/supported-services.md | 2 +- requirements.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/services/keycloak.md b/docs/services/keycloak.md index 7e5e235..3d29ee5 100644 --- a/docs/services/keycloak.md +++ b/docs/services/keycloak.md @@ -1,6 +1,6 @@ # Keycloak -[Keycloak](https://keycloak.net/) is an open source identity and access management solution. +[Keycloak](https://www.keycloak.org/) is an open source identity and access management solution. **Warning**: this service is a new addition to the playbook. It may not fully work or be configured in a suboptimal manner. diff --git a/docs/supported-services.md b/docs/supported-services.md index 1a36de1..5b173b8 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -14,7 +14,7 @@ | [Gitea](https://gitea.io/) | A painless self-hosted Git service. | [Link](services/gitea.md) | | [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) | | [Hubsite](https://github.com/moan0s/hubsite) | A simple, static site that shows an overview of the available services | [Link](services/hubsite.md) | -| [Keycloak](https://keycloak.net/) | An open source identity and access management solution. | [Link](services/keycloak.md) | +| [Keycloak](https://www.keycloak.org/) | An open source identity and access management solution. | [Link](services/keycloak.md) | | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) | | [NetBox](https://docs.netbox.dev/en/stable/) | Web application that provides [IP address management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) and [data center infrastructure management (DCIM)](https://en.wikipedia.org/wiki/Data_center_management#Data_center_infrastructure_management) functionality | [Link](services/netbox.md) | | [Nextcloud](https://nextcloud.com/) | The most popular self-hosted collaboration solution for tens of millions of users at thousands of organizations across the globe. | [Link](services/nextcloud.md) | diff --git a/requirements.yml b/requirements.yml index 2762faa..f5fa1e0 100644 --- a/requirements.yml +++ b/requirements.yml @@ -74,7 +74,7 @@ version: v1.19.0-0 name: gitea - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-keycloak.git - version: v21.0.1-0 + version: v21.0.1-1 name: keycloak - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-netbox.git version: v3.4.6-2.5.1-0 From 2d94dc1e00db93aa1e60db814f93dd98b6038ddd Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 10:52:00 +0300 Subject: [PATCH 08/20] Upgrade com.devture.ansible.role.systemd_service_manager --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index f5fa1e0..2a8715a 100644 --- a/requirements.yml +++ b/requirements.yml @@ -26,7 +26,7 @@ - src: git+https://github.com/devture/com.devture.ansible.role.traefik.git version: v2.9.9-0 - src: git+https://github.com/devture/com.devture.ansible.role.systemd_service_manager.git - version: 6ccb88ac5fc27e1e70afcd48278ade4b564a9096 + version: v1.0.0-0 - src: git+https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages.git version: 9b4b088c62b528b73a9a7c93d3109b091dd42ec6 - src: git+https://github.com/devture/com.devture.ansible.role.woodpecker_ci_server.git From dbf84d1249d94d8009063edf16f56ad28c794315 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 10:52:48 +0300 Subject: [PATCH 09/20] Always restart services one by one when doing install-service This way, something like `just install-service postgres` will definitely do a `restart` and not a `stop` + `start` (which may leave dependant services stopped). This has potentially been addressed by https://github.com/devture/com.devture.ansible.role.systemd_service_manager/commit/7acb5f4b85de1a7009b149f5b6ee3a6eef203047 as well. --- justfile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/justfile b/justfile index 1cbbf60..74f4d33 100644 --- a/justfile +++ b/justfile @@ -25,7 +25,10 @@ install-all *extra_args: (run-tags "install-all,start" extra_args) # Runs installation tasks for a single service install-service service *extra_args: - just --justfile {{ justfile() }} run --tags=install-{{ service }},start-group --extra-vars=group={{ service }} {{ extra_args }} + just --justfile {{ justfile() }} run \ + --tags=install-{{ service }},start-group \ + --extra-vars=group={{ service }} \ + --extra-vars=devture_systemd_service_manager_service_restart_mode=one-by-one {{ extra_args }} # Runs the playbook with --tags=setup-all,start and optional arguments setup-all *extra_args: (run-tags "setup-all,start" extra_args) From de10454359d7c25ea454ef06700e0efcdfd9db25 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 10:54:18 +0300 Subject: [PATCH 10/20] Add justfile to .editorconfig --- .editorconfig | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.editorconfig b/.editorconfig index de8516e..cc806b2 100644 --- a/.editorconfig +++ b/.editorconfig @@ -23,6 +23,10 @@ indent_size = 2 indent_style = space indent_size = 2 +[justfile] +indent_style = space +indent_size = 4 + # Markdown Files # # Two spaces at the end of a line in Markdown mean "new line", From a900cfd650d4d98bf361bd95c220f0efc29f3670 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 12:24:00 +0300 Subject: [PATCH 11/20] Upgrade Grafana (v9.4.7-0 -> v9.4.7-1) --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index 2a8715a..69408f3 100644 --- a/requirements.yml +++ b/requirements.yml @@ -36,7 +36,7 @@ - src: git+https://gitlab.com/etke.cc/roles/miniflux.git version: v2.0.43-2 - src: git+https://gitlab.com/etke.cc/roles/grafana.git - version: v9.4.7-0 + version: v9.4.7-1 - src: git+https://gitlab.com/etke.cc/roles/radicale.git version: v3.1.8.1-2 - src: git+https://gitlab.com/etke.cc/roles/uptime_kuma.git From 9c0edad5b94559ae962c6159d5f2943fa6ed0f55 Mon Sep 17 00:00:00 2001 From: Aine Date: Tue, 28 Mar 2023 16:02:22 +0300 Subject: [PATCH 12/20] add Soft Serve --- docs/services/soft-serve.md | 30 ++++++++++++++++++++++++++++++ docs/supported-services.md | 1 + group_vars/mash_servers | 26 ++++++++++++++++++++++++++ requirements.yml | 2 ++ setup.yml | 2 ++ 5 files changed, 61 insertions(+) create mode 100644 docs/services/soft-serve.md diff --git a/docs/services/soft-serve.md b/docs/services/soft-serve.md new file mode 100644 index 0000000..2838361 --- /dev/null +++ b/docs/services/soft-serve.md @@ -0,0 +1,30 @@ +# Soft Serve + +This playbook can configure [Soft Serve](https://github.com/charmbracelet/soft-serve). + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +```yaml +######################################################################## +# # +# soft-serve # +# # +######################################################################## + +soft_serve_enabled: true +soft_serve_hostname: mash.example.com # an URL Soft Serve will advertise +soft_serve_container_bind_port: 2222 # Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 +soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE + +######################################################################## +# # +# /soft-serve # +# # +######################################################################## +``` + +## Usage + +After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the ssh key you defined in `soft_serve_initial_admin_key` to see TUI and follow the instructions to configure Soft Serve further. diff --git a/docs/supported-services.md b/docs/supported-services.md index 5b173b8..381a0d7 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -27,6 +27,7 @@ | [Radicale](https://radicale.org/) | A Free and Open-Source CalDAV and CardDAV Server (solution for hosting contacts and calendars) | [Link](services/radicale.md) | | [Redmine](https://redmine.org/) | A flexible project management web application. | [Link](services/redmine.md) | | [Redis](https://redis.io/) | An in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker. | [Link](services/redis.md) | +| [Soft Serve](https://github.com/charmbracelet/soft-serve) | A tasty, self-hostable Git server for the command line | [Link](services/soft-serve.md) | | [Syncthing](https://syncthing.net/) | A continuous file synchronization program which synchronizes files between two or more computers in real time | [Link](services/syncthing.md) | | [Traefik](https://doc.traefik.io/traefik/) | A container-aware reverse-proxy server | [Link](services/traefik.md) | | [Vaultwarden](https://github.com/dani-garcia/vaultwarden) | A lightweight unofficial and compatible implementation of the [Bitwarden](https://bitwarden.com/) password manager | [Link](services/vaultwarden.md) | diff --git a/group_vars/mash_servers b/group_vars/mash_servers index 2490530..18de9c8 100644 --- a/group_vars/mash_servers +++ b/group_vars/mash_servers @@ -123,6 +123,8 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': (redis_identifier + '.service'), 'priority': 750, 'groups': ['mash', 'redis']}] if redis_enabled else []) + + ([{'name': (soft_serve_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'soft-serve']}] if soft_serve_enabled else []) + + ([{'name': (syncthing_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'syncthing']}] if syncthing_enabled else []) + ([{'name': (vaultwarden_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'vaultwarden', 'vaultwarden-server']}] if vaultwarden_enabled else []) @@ -1133,6 +1135,30 @@ redis_gid: "{{ mash_playbook_gid }}" + +######################################################################## +# # +# soft-serve # +# # +######################################################################## + +soft_serve_enabled: false + +soft_serve_identifier: "{{ mash_playbook_service_identifier_prefix }}soft-serve" + +soft_serve_uid: "{{ mash_playbook_uid }}" +soft_serve_gid: "{{ mash_playbook_gid }}" + +soft_serve_base_path: "{{ mash_playbook_base_path }}/{{ mash_playbook_service_base_directory_name_prefix }}soft-serve" + +######################################################################## +# # +# /soft-serve # +# # +######################################################################## + + + ######################################################################## # # # syncthing # diff --git a/requirements.yml b/requirements.yml index 69408f3..1ba4214 100644 --- a/requirements.yml +++ b/requirements.yml @@ -49,6 +49,8 @@ version: v0.23.0-3 - src: git+https://gitlab.com/etke.cc/roles/redmine.git version: v5.0.5-1 +- src: git+https://gitlab.com/etke.cc/roles/soft_serve.git + version: v0.4.6-0 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-adguard-home.git version: v0.107.26-0 name: adguard_home diff --git a/setup.yml b/setup.yml index 78904fe..f35d358 100644 --- a/setup.yml +++ b/setup.yml @@ -92,6 +92,8 @@ - role: galaxy/redis + - role: galaxy/soft_serve + - role: galaxy/syncthing - role: galaxy/vaultwarden From a30c09ada19b172f016c5865c1666ce05468b7e2 Mon Sep 17 00:00:00 2001 From: Aine Date: Tue, 28 Mar 2023 16:11:58 +0300 Subject: [PATCH 13/20] soft-serve: fix comments --- docs/services/soft-serve.md | 4 +++- requirements.yml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/services/soft-serve.md b/docs/services/soft-serve.md index 2838361..fa29b02 100644 --- a/docs/services/soft-serve.md +++ b/docs/services/soft-serve.md @@ -14,7 +14,9 @@ To enable this service, add the following configuration to your `vars.yml` file ######################################################################## soft_serve_enabled: true -soft_serve_hostname: mash.example.com # an URL Soft Serve will advertise +# The hostname of this system. +# It will be used for generating git clone URLs (e.g. ssh://mash.example.com/repository.git) +soft_serve_hostname: mash.example.com soft_serve_container_bind_port: 2222 # Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE diff --git a/requirements.yml b/requirements.yml index 1ba4214..c9a6946 100644 --- a/requirements.yml +++ b/requirements.yml @@ -50,7 +50,7 @@ - src: git+https://gitlab.com/etke.cc/roles/redmine.git version: v5.0.5-1 - src: git+https://gitlab.com/etke.cc/roles/soft_serve.git - version: v0.4.6-0 + version: v0.4.6-1 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-adguard-home.git version: v0.107.26-0 name: adguard_home From 5b9800e70ba5440d5b1c9b918bd42112d26142dd Mon Sep 17 00:00:00 2001 From: Aine Date: Tue, 28 Mar 2023 16:40:35 +0300 Subject: [PATCH 14/20] soft-serve: add note --- docs/services/soft-serve.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/services/soft-serve.md b/docs/services/soft-serve.md index fa29b02..bfb6467 100644 --- a/docs/services/soft-serve.md +++ b/docs/services/soft-serve.md @@ -18,7 +18,7 @@ soft_serve_enabled: true # It will be used for generating git clone URLs (e.g. ssh://mash.example.com/repository.git) soft_serve_hostname: mash.example.com soft_serve_container_bind_port: 2222 # Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 -soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE +soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE # This key will be able to authenticate with ANY user until you configure Soft Serve ######################################################################## # # @@ -30,3 +30,5 @@ soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE ## Usage After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the ssh key you defined in `soft_serve_initial_admin_key` to see TUI and follow the instructions to configure Soft Serve further. + +Note that you have to [finish the configuration yourself](https://github.com/charmbracelet/soft-serve#configuration), otherwise any user with `soft_serve_initial_admin_key` will work as admin. From a513f0421554a83ad043a918a2530ef8c4b0ee12 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 16:47:07 +0300 Subject: [PATCH 15/20] Update soft-serve.md --- docs/services/soft-serve.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/services/soft-serve.md b/docs/services/soft-serve.md index bfb6467..117e0a5 100644 --- a/docs/services/soft-serve.md +++ b/docs/services/soft-serve.md @@ -1,6 +1,6 @@ # Soft Serve -This playbook can configure [Soft Serve](https://github.com/charmbracelet/soft-serve). +[Soft Serve](https://github.com/charmbracelet/soft-serve) is a tasty, self-hostable [Git](https://git-scm.com/) server for the command line. ## Configuration @@ -14,11 +14,16 @@ To enable this service, add the following configuration to your `vars.yml` file ######################################################################## soft_serve_enabled: true + # The hostname of this system. # It will be used for generating git clone URLs (e.g. ssh://mash.example.com/repository.git) soft_serve_hostname: mash.example.com -soft_serve_container_bind_port: 2222 # Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 -soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE # This key will be able to authenticate with ANY user until you configure Soft Serve + +# Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 +soft_serve_container_bind_port: 2222 + +# This key will be able to authenticate with ANY user until you configure Soft Serve +soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE ######################################################################## # # @@ -29,6 +34,6 @@ soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE # This key will be able t ## Usage -After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the ssh key you defined in `soft_serve_initial_admin_key` to see TUI and follow the instructions to configure Soft Serve further. +After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the SSH key defined in `soft_serve_initial_admin_key` to see its [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) and follow the instructions to configure Soft Serve further. -Note that you have to [finish the configuration yourself](https://github.com/charmbracelet/soft-serve#configuration), otherwise any user with `soft_serve_initial_admin_key` will work as admin. +Note that you have to [finish the configuration yourself](https://github.com/charmbracelet/soft-serve#configuration), otherwise any user with `soft_serve_initial_admin_key` will work as an admin. From cf5019aac34da0e01734d284acca34c7b228c0d8 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 16:48:03 +0300 Subject: [PATCH 16/20] Update supported-services.md --- docs/supported-services.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/supported-services.md b/docs/supported-services.md index 381a0d7..c80d2ea 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -11,7 +11,7 @@ | [Docker Registry Purger](https://github.com/devture/docker-registry-purger) | A small tool used for purging a private Docker Registry's old tags | [Link](services/docker-registry-purger.md) | | [Focalboard](https://www.focalboard.com/) | An open source, self-hosted alternative to [Trello](https://trello.com/), [Notion](https://www.notion.so/), and [Asana](https://asana.com/). | [Link](services/focalboard.md) | | [Firezone](https://www.firezone.dev/) | A self-hosted VPN server (based on [WireGuard](https://en.wikipedia.org/wiki/WireGuard)) with a Web UI | [Link](services/firezone.md) | -| [Gitea](https://gitea.io/) | A painless self-hosted Git service. | [Link](services/gitea.md) | +| [Gitea](https://gitea.io/) | A painless self-hosted [Git](https://git-scm.com/) service. | [Link](services/gitea.md) | | [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) | | [Hubsite](https://github.com/moan0s/hubsite) | A simple, static site that shows an overview of the available services | [Link](services/hubsite.md) | | [Keycloak](https://www.keycloak.org/) | An open source identity and access management solution. | [Link](services/keycloak.md) | @@ -27,7 +27,7 @@ | [Radicale](https://radicale.org/) | A Free and Open-Source CalDAV and CardDAV Server (solution for hosting contacts and calendars) | [Link](services/radicale.md) | | [Redmine](https://redmine.org/) | A flexible project management web application. | [Link](services/redmine.md) | | [Redis](https://redis.io/) | An in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker. | [Link](services/redis.md) | -| [Soft Serve](https://github.com/charmbracelet/soft-serve) | A tasty, self-hostable Git server for the command line | [Link](services/soft-serve.md) | +| [Soft Serve](https://github.com/charmbracelet/soft-serve) | A tasty, self-hostable [Git](https://git-scm.com/) server for the command line | [Link](services/soft-serve.md) | | [Syncthing](https://syncthing.net/) | A continuous file synchronization program which synchronizes files between two or more computers in real time | [Link](services/syncthing.md) | | [Traefik](https://doc.traefik.io/traefik/) | A container-aware reverse-proxy server | [Link](services/traefik.md) | | [Vaultwarden](https://github.com/dani-garcia/vaultwarden) | A lightweight unofficial and compatible implementation of the [Bitwarden](https://bitwarden.com/) password manager | [Link](services/vaultwarden.md) | From 19cca0e840454d48a1b58b733d1c7fc08b601391 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 19:40:15 +0300 Subject: [PATCH 17/20] Fix alignment --- group_vars/mash_servers | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/group_vars/mash_servers b/group_vars/mash_servers index 18de9c8..22eb40c 100644 --- a/group_vars/mash_servers +++ b/group_vars/mash_servers @@ -775,7 +775,7 @@ miniflux_database_password: "{{ '%s' | format(mash_playbook_generic_secret_key) ######################################################################## # # -# /miniflux # +# /miniflux # # # ######################################################################## From 3330f6cfd601daa0c2e4c737d9260b0ede86fc99 Mon Sep 17 00:00:00 2001 From: Aine Date: Tue, 28 Mar 2023 20:11:55 +0300 Subject: [PATCH 18/20] update soft-serve 0.4.6 -> 0.4.7 --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index c9a6946..7b58b8e 100644 --- a/requirements.yml +++ b/requirements.yml @@ -50,7 +50,7 @@ - src: git+https://gitlab.com/etke.cc/roles/redmine.git version: v5.0.5-1 - src: git+https://gitlab.com/etke.cc/roles/soft_serve.git - version: v0.4.6-1 + version: v0.4.7-0 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-adguard-home.git version: v0.107.26-0 name: adguard_home From daebb695d5bbd622e7faf21521cc88a756c017bd Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Wed, 29 Mar 2023 09:22:40 +0300 Subject: [PATCH 19/20] Upgrade Vaultwarden (v1.27.0-2 -> v1.28.0-0) Fixes https://github.com/mother-of-all-self-hosting/mash-playbook/issues/25 --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index 7b58b8e..87d4d8a 100644 --- a/requirements.yml +++ b/requirements.yml @@ -94,7 +94,7 @@ version: v1.23.2-0 name: syncthing - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-vaultwarden.git - version: v1.27.0-2 + version: v1.28.0-0 name: vaultwarden - src: git+https://github.com/moan0s/hubsite.git version: 6b20c472d36ce5765dc44675d42cce74cbcbd0fe From e5ab7b671629b9fa9bc4da1199ae3ad24a19b57a Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Wed, 29 Mar 2023 10:22:20 +0300 Subject: [PATCH 20/20] Upgrade Syncthing (v1.23.2-0 -> v1.23.2-1) --- requirements.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.yml b/requirements.yml index 87d4d8a..d492f67 100644 --- a/requirements.yml +++ b/requirements.yml @@ -91,7 +91,7 @@ version: v2.43.0-0 name: prometheus - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-syncthing.git - version: v1.23.2-0 + version: v1.23.2-1 name: syncthing - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-vaultwarden.git version: v1.28.0-0