First batch of changes for PR #10

ezekieldas · 2024-04-24T01:45:00Z

Hello! I wanted to present these changes before this becomes another project I never finish. Your work has inspired me to get all my *arrs and *arr pipeline automated. This is something I've been meaning to do for well over a year.

There are some significant changes here but they should still (generally) accomodate your original codebase/configuration. I'll summarize:

docker compose template is more jinja. I abstracted a lot of stuff here to be dependent on vars (eg, group_vars, host_vars, etc.)
tasks/main.yml has been given cleaner loops. This too reading more from vars.
And the vars I forgot to add in this commit, but a sample below. I'll include with next along with any other modifications you might suggest.
Testing: I'll do something in the next few days that supports your original configuration.

(afterthought: I could merge these vars into defaults/main.yml, with the elements you originially had in place (ie, transmission, flaresolver, sonarr-hd, etc.))

These are the vars I built on:

##
## This includes variables used with https://github.com/buildarr/ansible-playbooks
##

# docker_host_ip_ports: "0.0.0.0"

arrstack_env_dir: /usr/local/docker/arr
arrstack_data_dir_create: false

##
## network_mode: will take precendence over ports:
##
services:
  - service_name: sonarr
    image: lscr.io/linuxserver/sonarr
    image_tag: version-3.0.10.1567
    container_name: sonarr
    # network_mode: bridge
    port_healthcheck: 8989
    ports:
      - 8989:8989/tcp
    volumes:
      - ./sonarr_config:/config
#    depends_on:
#      - foobar
  - service_name: radarr
    image: lscr.io/linuxserver/radarr
    image_tag: latest
    container_name: radarr
    # network_mode: service:foobar
    port_healthcheck: 7878
    ports:
      - 7878:7878/tcp
    volumes:
      - ./radarr_config:/config
#    depends_on:
#      - foobar
  - service_name: prowlarr
    image: lscr.io/linuxserver/prowlarr
    image_tag: latest
    container_name: prowlarr
    # network_mode: service:foobar
    port_healthcheck: 9696
    ports:
      - 9696:9696/tcp
    volumes:
      - ./prowlarr_config:/config
#    depends_on:
#      - foobar

Callum027 · 2024-04-24T21:31:26Z

Hi there @ezekieldas, thank you for your contribution. This is a really good bit of work.

I've actually been using an Ansible collection I wrote for my own use to deploy my media stack with Buildarr. I've just uploaded it to GitHub as the following repository:

https://github.com/buildarr/ansible-collection-mediastack

It does a bit more than these playbooks, such as setting up FlareSolverr for Prowlarr, Jellyfin and Jellyseerr.

If you don't mind, would you consider proposing your changes against the collection?

It needs some work to update it and add things like Molecule testing, but it'd be great if we could collaborate on making this something that can be released on Ansible Galaxy.

ezekieldas · 2024-04-25T13:50:35Z

Hello! Yes, I'd be happy to collaborate on any/all things buildarr related. At an earlier exchange we had with a buildarr issue, you proposed having a chat on Discord. I'll try to get that setup at some point today so we can look at the details.

I want to offer another PR for this codebase just to get some ideas across. No expectations of merging the PR as it looks like you may abandon this repo (?) but I think it might help illustrate how I'm thinking of the automation pipeline in general.

Again, let's find a greater bandwidth space (Discord) to discuss. I'll see about getting that setup today.

Cheers!

ezekieldas · 2024-04-25T16:19:14Z

A couple of afterthoughts:

I'll message you here once I have the Discord setup
We have some TZ differences. I think you're reading from NZ. I'm in US West coast.

Callum027 · 2024-04-26T11:49:01Z

roles/arrstack/templates/docker-compose.yml.j2

-    image: "{{ arrstack_sonarr_container_uri }}:{{ arrstack_sonarr_container_tag }}"
-    hostname: sonarr-4k
-    restart: always
+{% include 'gluetun.j2' ignore missing %}


Could you please include a way to disable including this using the Ansible inventory?

For example, I host my *Arrs on a NAS in my home, and don't need to setup VPNs to access it (and even then, I actually have a separate setup for all that).

Callum027 · 2024-04-26T11:51:03Z

Apart from the gluetun comment I made (which I'm happy to treat as an optional example for people who need it), it seems reasonable.

I'm not going to put too much work into reviewing this as it's mainly an example of what can be done, more than anything. If we're going to do the collection thing, I'd like to put the work into making it nice and proper over there.

ezekieldas · 2024-04-27T15:36:32Z

I have another PR queued up which potentially replaces this one. I've been using this as a means to test a full, first-time provision of a typical arrstack (ie, prowlarr, sonarr, radarr, flaresolverr + buildarr). There are specifics to my environment and network design which introduce complications in achieving functionality without manual intervention but nonetheless have proven to make this role + a buildarr layout more modular.

And I believe modularity is key here. It's difficult but necessary to try to accomodate as any arrangements as possible. I'll unpack more of that later. So speaking of modularity...

The unconditional include on the gluetun file was a mistake made in haste. However, I think it'd be good to include an example of how a full service configuration can be brought in without definining it as a dictionary. More options for modularity. And extending it in such a way that functionality is the designer's responsibility.

In using and refinining this specific repo I've been forced to 1) review my ansible-fu 2) understand buildarr extensively. I'm hoping this will offer a bit for the collection.

ezekieldas · 2024-04-28T18:51:02Z

@Callum027 Overdue but I finally got my Discord working. My username is same as here. Please add me and/or send your Discord name.

Callum027 · 2024-04-28T23:50:03Z

@Callum027 Overdue but I finally got my Discord working. My username is same as here. Please add me and/or send your Discord name.

Thanks. You can join the Discord server I created for Buildarr using the following invite link.

https://discord.gg/9vkHv2PRuH

Callum027

The comments I made here are simply addressing some things that would probably be transferred when we start working on the collection. I have more to say on how things should be designed, but let's discuss those when we start seriously looking at working on the collection.

For these example playbooks, I think this'll do for now.

Callum027 · 2024-05-04T01:59:52Z

roles/arrstack/templates/buildarr/sonarr.yml.j2

+  protocol: http
+  url_base: null
+  api_key: "{{ arrstack_instance_apikeys['sonarr'] if arrstack_instance_apikeys is defined and 'sonarr' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"
+  version: 3.0.10.1567


You generally don't want to explicitly set the version in the configuration, unless you're using a config file to generate a Docker Compose configuration using the buildarr compose command.

Callum027 · 2024-05-04T02:00:31Z

roles/arrstack/templates/buildarr/sonarr.yml.j2

+        strig00_bot:
+          notification_triggers:
+            on_grab: false
+            on_import: true
+            on_upgrade: true
+            on_rename: false
+            on_series_delete: false
+            on_episode_file_delete: false
+            on_episode_file_delete_for_upgrade: true
+            on_health_issue: false
+            include_health_warnings: false
+            on_application_update: true
+          tags: []
+          type: telegram
+          bot_token: {{ vault_telegram_bot_token }}
+          chat_id: {{ vault_telegram_chat_id }}
+          send_silently: false


Can you make the Telegram bot optional?

Callum027 · 2024-05-04T02:02:41Z

roles/arrstack/templates/buildarr/radarr.yml.j2

+{% if arrstack_analytics_disable is defined and arrstack_analytics_disable %}
+      analytics:
+        send_anonymous_usage_data: false
+{% else %}
+      analytics:
+        send_anonymous_usage_data: true
+{% endif %}


Suggested change

{% if arrstack_analytics_disable is defined and arrstack_analytics_disable %}

analytics:

send_anonymous_usage_data: false

{% else %}

analytics:

send_anonymous_usage_data: true

{% endif %}

analytics:

send_anonymous_usage_data: {{ not (arrstack_analytics_disable | default(False)) | string | lower }}

Callum027 · 2024-05-04T02:04:20Z

roles/arrstack/templates/buildarr/prowlarr.yml.j2

+{% if arrstack_analytics_disable is defined and arrstack_analytics_disable %}
+      analytics:
+        send_anonymous_usage_data: false
+{% else %}
+      analytics:
+        send_anonymous_usage_data: true
+{% endif %}


Suggested change

{% if arrstack_analytics_disable is defined and arrstack_analytics_disable %}

analytics:

send_anonymous_usage_data: false

{% else %}

analytics:

send_anonymous_usage_data: true

{% endif %}

analytics:

send_anonymous_usage_data: {{ not (arrstack_analytics_disable | default(False)) | string | lower }}

Callum027 · 2024-05-04T02:07:15Z

roles/arrstack/templates/buildarr/instances/sonarr-instances.yml.j2.example

@@ -357,11 +358,12 @@ sonarr:

    # Sonarr instance for grabbing anime shows.
    sonarr-anime:
-      api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] }}"
+      hostname: {{ hostname_sonarr | default('localhost') }}
+      api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] if arrstack_instance_apikeys is defined and 'sonarr-anime' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"


Putting in an incorrect value when something is not found is an anti-pattern I believe.

Instead, let Ansible raise an error.

Suggested change

api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] if arrstack_instance_apikeys is defined and 'sonarr-anime' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"

api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] }}"

Callum027 · 2024-05-04T02:08:23Z

roles/arrstack/templates/buildarr/instances/sonarr-instances.yml.j2

+    # Sonarr instance for grabbing anime shows.
+    sonarr-anime:
+      hostname: {{ hostname_sonarr | default('localhost') }}
+      api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] if arrstack_instance_apikeys is defined and 'sonarr-anime' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"


Putting in an incorrect value when something is not found is an anti-pattern I believe.

Instead, let Ansible raise an error.

Suggested change

api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] if arrstack_instance_apikeys is defined and 'sonarr-anime' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"

api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] }}"

Callum027 · 2024-05-04T02:08:39Z

roles/arrstack/templates/buildarr/instances/sonarr-instances.yml.j2

+    # Sonarr instance for grabbing 4K TV shows.
+    sonarr-4k:
+      hostname: {{ hostname_sonarr | default('localhost') }}
+      api_key: "{{ arrstack_instance_apikeys['sonarr-4k'] if arrstack_instance_apikeys is defined and 'sonarr-4k' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"


Putting in an incorrect value when something is not found is an anti-pattern I believe.

Instead, let Ansible raise an error.

Suggested change

api_key: "{{ arrstack_instance_apikeys['sonarr-4k'] if arrstack_instance_apikeys is defined and 'sonarr-4k' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"

api_key: "{{ arrstack_instance_apikeys['sonarr-4k'] }}"

Callum027 · 2024-05-04T02:08:54Z

roles/arrstack/templates/buildarr/instances/sonarr-instances.yml.j2

+    # Sonarr instance for grabbing HD/SD TV shows.
+    sonarr-hd:
+      hostname: {{ hostname_sonarr | default('localhost') }}
+      api_key: "{{ arrstack_instance_apikeys['sonarr-hd'] if arrstack_instance_apikeys is defined and 'sonarr-hd' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"


Putting in an incorrect value when something is not found is an anti-pattern I believe.

Instead, let Ansible raise an error.

Suggested change

api_key: "{{ arrstack_instance_apikeys['sonarr-hd'] if arrstack_instance_apikeys is defined and 'sonarr-hd' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"

api_key: "{{ arrstack_instance_apikeys['sonarr-hd'] }}"

First batch of changes for PR

75bf21b

Calling this done for now!

502b9ea

Callum027 reviewed Apr 26, 2024

View reviewed changes

Callum027 assigned ezekieldas Apr 26, 2024

ingestbot added 3 commits May 1, 2024 17:42

A bunch of changes for a new PR

6cd922e

Additional changes to the role.

180b94b

A minor change to cheat_sheet_troubleshooting.md

ba87e94

Callum027 requested changes May 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First batch of changes for PR #10

First batch of changes for PR #10

ezekieldas commented Apr 24, 2024

Callum027 commented Apr 24, 2024 •

edited

Loading

ezekieldas commented Apr 25, 2024

ezekieldas commented Apr 25, 2024

Callum027 Apr 26, 2024

Callum027 commented Apr 26, 2024 •

edited

Loading

ezekieldas commented Apr 27, 2024

ezekieldas commented Apr 28, 2024

Callum027 commented Apr 28, 2024

Callum027 left a comment

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

Callum027 May 4, 2024

	api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] if arrstack_instance_apikeys is defined and 'sonarr-anime' in arrstack_instance_apikeys else 'ansible_api_key_not_found' }}"
	api_key: "{{ arrstack_instance_apikeys['sonarr-anime'] }}"

First batch of changes for PR #10

Are you sure you want to change the base?

First batch of changes for PR #10

Conversation

ezekieldas commented Apr 24, 2024

Callum027 commented Apr 24, 2024 • edited Loading

ezekieldas commented Apr 25, 2024

ezekieldas commented Apr 25, 2024

Choose a reason for hiding this comment

Callum027 commented Apr 26, 2024 • edited Loading

ezekieldas commented Apr 27, 2024

ezekieldas commented Apr 28, 2024

Callum027 commented Apr 28, 2024

Callum027 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Callum027 commented Apr 24, 2024 •

edited

Loading

Callum027 commented Apr 26, 2024 •

edited

Loading