Merge pull request #24 from linuxserver/develop-sidekiq

Author: thespad

.github/workflows/call_invalid_helper.yml

@@ -0,0 +1,12 @@
+name: Comment on invalid interaction
+on:
+  issues:
+    types:
+      - labeled
+jobs:
+  add-comment-on-invalid:
+    if: github.event.label.name == 'invalid'
+    permissions:
+      issues: write
+    uses: linuxserver/github-workflows/.github/workflows/invalid-interaction-helper.yml@v1
+    secrets: inherit

Dockerfile

@@ -1,3 +1,5 @@
+# syntax=docker/dockerfile:1
+
 FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.15
 
 ARG BUILD_DATE

Dockerfile.aarch64

@@ -1,3 +1,5 @@
+# syntax=docker/dockerfile:1
+
 FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.15
 
 ARG BUILD_DATE

Dockerfile.armhf

@@ -1,3 +1,5 @@
+# syntax=docker/dockerfile:1
+
 FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm32v7-3.15
 
 ARG BUILD_DATE

README.md

@@ -80,6 +80,12 @@ We support all of the official [environment variables](https://docs.joinmastodon
 
 For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
 
+### Running separate sidekiq instances
+
+It is currently only supported to run a single queue per container instance *or* all queues in a single container instance.
+
+All containers must share the same `/config`` mount and be on a common docker network.
+
 ### Strict reverse proxies
 
 This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
@@ -129,6 +135,11 @@ services:
       - AWS_ACCESS_KEY_ID= #optional
       - AWS_SECRET_ACCESS_KEY= #optional
       - S3_ALIAS_HOST= #optional
+      - SIDEKIQ_ONLY=false #optional
+      - SIDEKIQ_QUEUE= #optional
+      - SIDEKIQ_DEFAULT=false #optional
+      - SIDEKIQ_THREADS=5 #optional
+      - DB_POOL=5 #optional
     volumes:
       - /path/to/appdata/config:/config
     ports:
@@ -173,6 +184,11 @@ docker run -d \
   -e AWS_ACCESS_KEY_ID= `#optional` \
   -e AWS_SECRET_ACCESS_KEY= `#optional` \
   -e S3_ALIAS_HOST= `#optional` \
+  -e SIDEKIQ_ONLY=false `#optional` \
+  -e SIDEKIQ_QUEUE= `#optional` \
+  -e SIDEKIQ_DEFAULT=false `#optional` \
+  -e SIDEKIQ_THREADS=5 `#optional` \
+  -e DB_POOL=5 `#optional` \
   -p 80:80 \
   -p 443:443 \
   -v /path/to/appdata/config:/config \
@@ -219,6 +235,11 @@ Container images are configured using parameters passed at runtime (such as thos
 | `-e AWS_ACCESS_KEY_ID=` | S3 bucket access key ID |
 | `-e AWS_SECRET_ACCESS_KEY=` | S3 bucket secret access key |
 | `-e S3_ALIAS_HOST=` | Alternate hostname for object fetching if you are front the S3 connections. |
+| `-e SIDEKIQ_ONLY=false` | Only run the sidekiq service in this container instance. For large scale instances that need better queue handling. |
+| `-e SIDEKIQ_QUEUE=` | The name of the sidekiq queue to run in this container. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-queues). |
+| `-e SIDEKIQ_DEFAULT=false` | Set to `true` on the main container if you're running additional sidekiq instances. It will run the `default` queue. |
+| `-e SIDEKIQ_THREADS=5` | The number of threads for sidekiq to use. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads). |
+| `-e DB_POOL=5` | The size of the DB connection pool, must be *at least* the same as `SIDEKIQ_THREADS`. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads). |
 | `-v /config` | Contains all relevant configuration files. |
 
 ## Environment variables from files (Docker secrets)
@@ -330,5 +351,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **19.12.22:** - Support separate sidekiq queue instances.
 * **08.11.22:** - Add develop branch.
 * **05.11.22:** - Initial Release.

readme-vars.yml

@@ -58,6 +58,11 @@ opt_param_env_vars:
   - { env_var: "AWS_ACCESS_KEY_ID", env_value: "", desc: "S3 bucket access key ID"}
   - { env_var: "AWS_SECRET_ACCESS_KEY", env_value: "", desc: "S3 bucket secret access key"}
   - { env_var: "S3_ALIAS_HOST", env_value: "", desc: "Alternate hostname for object fetching if you are front the S3 connections."}
+  - { env_var: "SIDEKIQ_ONLY", env_value: "false", desc: "Only run the sidekiq service in this container instance. For large scale instances that need better queue handling."}
+  - { env_var: "SIDEKIQ_QUEUE", env_value: "", desc: "The name of the sidekiq queue to run in this container. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-queues)."}
+  - { env_var: "SIDEKIQ_DEFAULT", env_value: "false", desc: "Set to `true` on the main container if you're running additional sidekiq instances. It will run the `default` queue."}
+  - { env_var: "SIDEKIQ_THREADS", env_value: "5", desc: "The number of threads for sidekiq to use. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads)."}
+  - { env_var: "DB_POOL", env_value: "5", desc: "The size of the DB connection pool, must be *at least* the same as `SIDEKIQ_THREADS`. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads)."}
 
 param_usage_include_ports: true
 param_ports:
@@ -83,11 +88,18 @@ app_setup_block: |
 
   For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
 
+  ### Running separate sidekiq instances
+
+  It is currently only supported to run a single queue per container instance *or* all queues in a single container instance.
+
+  All containers must share the same `/config`` mount and be on a common docker network.
+
   ### Strict reverse proxies
 
   This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
 
 # changelog
 changelogs:
+  - { date: "19.12.22:", desc: "Support separate sidekiq queue instances." }
   - { date: "08.11.22:", desc: "Add develop branch." }
-  - { date: "05.11.22:", desc: "Initial Release." }
+  - { date: "05.11.22:", desc: "Initial Release." }

root/etc/cont-init.d/50-config

@@ -4,6 +4,13 @@
 # Disable php-fpm service as Mastodon doesn't use it
 touch /etc/services.d/php-fpm/down
 
+# Disable other services if this is a sidekiq-only container
+if [[ ${SIDEKIQ_ONLY,,} == "true" ]]; then
+    touch /etc/services.d/mastodon/down
+    touch /etc/services.d/streaming/down
+    touch /etc/services.d/nginx/down
+fi
+
 mkdir -p \
     /app/www/tmp \
     /config/mastodon/public/system
@@ -15,7 +22,10 @@ ln -s /config/mastodon/public/system /app/www/public/system
 
 cd /app/www/ || exit 1
 
-s6-setuidgid abc /usr/bin/bundle exec rails db:prepare
+# Don't run DB prep if this is a sidekiq-only container
+if [[ ${SIDEKIQ_ONLY,,} != "true" ]]; then
+    s6-setuidgid abc /usr/bin/bundle exec rails db:prepare
+fi
 
 chown abc:abc \
     /config/mastodon/public/system

root/etc/services.d/mastodon/run

@@ -1,9 +1,9 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-RAILS_ENV=production
-PATH="${PATH}:/app/www/bin"
-RAILS_SERVE_STATIC_FILES=false
+export RAILS_ENV=production
+export PATH="${PATH}:/app/www/bin"
+export RAILS_SERVE_STATIC_FILES=false
 
 exec \
     s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 3000" \

root/etc/services.d/sidekiq/run

@@ -1,10 +1,30 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-RAILS_ENV=production
-PATH="${PATH}:/app/www/bin"
+export RAILS_ENV=production
+export PATH="${PATH}:/app/www/bin"
+
+if [[ -n ${SIDEKIQ_THREADS} ]]; then
+    SIDEKIQ_THREADS=$(printf '%d' "${SIDEKIQ_THREADS}")
+else
+    SIDEKIQ_THREADS=$(printf '%d' 5)
+fi
 
 cd /app/www || exit 1
 
-exec \
-    s6-setuidgid abc /usr/bin/bundle exec sidekiq
+if [[ ${SIDEKIQ_ONLY,,} == "true" ]] && [[ -n ${SIDEKIQ_QUEUE} ]]; then
+    echo "*** Starting sidekiq handling ${SIDEKIQ_QUEUE} queue with ${SIDEKIQ_THREADS} threads ***"
+    exec \
+        s6-setuidgid abc /usr/bin/bundle exec sidekiq -q "${SIDEKIQ_QUEUE}" -c ${SIDEKIQ_THREADS}
+elif [[ ${SIDEKIQ_ONLY,,} == "true" ]] && [[ -z ${SIDEKIQ_QUEUE} ]]; then
+    echo "*** No sidekiq queue specified, aborting ***"
+    sleep infinity
+elif [[ ${SIDEKIQ_DEFAULT,,} == "true"  ]]; then
+    echo "*** Starting sidekiq handling default queue with ${SIDEKIQ_THREADS} threads ***"
+    exec \
+        s6-setuidgid abc /usr/bin/bundle exec sidekiq -q default -c ${SIDEKIQ_THREADS}
+else
+    echo "*** Starting sidekiq handling all queues with ${SIDEKIQ_THREADS} threads ***"
+    exec \
+        s6-setuidgid abc /usr/bin/bundle exec sidekiq -c ${SIDEKIQ_THREADS}
+fi

root/etc/services.d/streaming/run

@@ -1,8 +1,8 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-NODE_ENV=production
-PATH="${PATH}:/app/www/bin"
+export NODE_ENV=production
+export PATH="${PATH}:/app/www/bin"
 
 exec \
     s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 4000" \