Redis commander: use connections file (#803)

* redis commander: use config file

Ignore config.json

fixes

* Remove phony

* Fixes

* fixes

* fixes

Author: YuryHrytsuk

services/redis-commander/.gitignore

@@ -0,0 +1 @@
+config.json

services/redis-commander/Makefile

@@ -1,7 +1,5 @@
 .DEFAULT_GOAL := help
 
-
-
 # Internal VARIABLES ------------------------------------------------
 # STACK_NAME defaults to name of the current directory. Should not to be changed if you follow GitOps operating procedures.
 STACK_NAME = $(notdir $(shell pwd))
@@ -24,24 +22,21 @@ up-letsencrypt-dns: .init .env ${TEMP_COMPOSE}-letsencrypt-dns
 	@docker stack deploy --with-registry-auth --prune --compose-file ${TEMP_COMPOSE}-letsencrypt-dns ${STACK_NAME}
 
 .PHONY: up-dalco ## Deploys redis-commander stack for Dalco Cluster
-up-dalco: .init .env ${TEMP_COMPOSE}-dalco
-	@docker stack deploy --with-registry-auth --prune --compose-file ${TEMP_COMPOSE}-dalco ${STACK_NAME}
+up-dalco: up
 
 .PHONY: up-master ## Deploys redis-commander stack for Master Cluster
-up-master: .init .env ${TEMP_COMPOSE}-master
-	@docker stack deploy --with-registry-auth --prune --compose-file ${TEMP_COMPOSE}-master ${STACK_NAME}
+up-master: up
 
 .PHONY: up-public ## Deploys redis-commander stack for public access Cluster
-up-public: .init .env ${TEMP_COMPOSE}-public
-	@docker stack deploy --with-registry-auth --prune --compose-file ${TEMP_COMPOSE}-public ${STACK_NAME}
+up-public: up
 
 .PHONY: up-local ## Deploys redis-commander stack for local deployment
 up-local: up
 
 .PHONY: up-aws ## Deploys redis-commander stack in aws
-up-aws: .init .env ${TEMP_COMPOSE}-aws
-	@docker stack deploy --with-registry-auth --prune --compose-file ${TEMP_COMPOSE}-aws ${STACK_NAME}
+up-aws: up
 
+docker-compose.yml: config.json
 
 .PHONY: ${TEMP_COMPOSE}
 ${TEMP_COMPOSE}: docker-compose.yml .env
@@ -55,18 +50,8 @@ ${TEMP_COMPOSE}-letsencrypt-http: docker-compose.yml docker-compose.letsencrypt.
 ${TEMP_COMPOSE}-letsencrypt-dns: docker-compose.yml docker-compose.letsencrypt.dns.yml .env
 	@${REPO_BASE_DIR}/scripts/docker-stack-config.bash -e .env $< docker-compose.letsencrypt.dns.yml  > $@
 
-.PHONY: ${TEMP_COMPOSE}-dalco
-${TEMP_COMPOSE}-dalco: docker-compose.yml docker-compose.dalco.yml .env
-	@${REPO_BASE_DIR}/scripts/docker-stack-config.bash -e .env $< docker-compose.dalco.yml  > $@
-
-.PHONY: ${TEMP_COMPOSE}-public
-${TEMP_COMPOSE}-public: docker-compose.yml docker-compose.public.yml .env
-	@${REPO_BASE_DIR}/scripts/docker-stack-config.bash -e .env $< docker-compose.public.yml  > $@
-
-.PHONY: ${TEMP_COMPOSE}-master
-${TEMP_COMPOSE}-master: docker-compose.yml .env
-	@${REPO_BASE_DIR}/scripts/docker-stack-config.bash -e .env $< > $@
-
-.PHONY: ${TEMP_COMPOSE}-aws
-${TEMP_COMPOSE}-aws: docker-compose.yml docker-compose.aws.yml .env
-	@${REPO_BASE_DIR}/scripts/docker-stack-config.bash -e .env $< docker-compose.aws.yml  > $@
+config.json: config.json.j2 .env .venv
+	# generate $@
+	@$(call jinja, $<, $@)
+	# validate and format $@
+	@cat $@ | jq > /dev/null

services/redis-commander/config.json.j2

@@ -0,0 +1,30 @@
+{%- macro redis_connection(label, host, port, username, password, index, secure) %}
+{
+  "label": "{{ label }}",
+  "host": "{{ host }}",
+  "port": "{{ port }}",
+  {%- if username %}
+  "username": "{{ username }}",
+  {%- endif %}
+  "password": "{{ password }}",
+  "dbIndex": {{ index }},
+  "tls": {{ 'true' if secure.lower() in ['1', 'true', 'yes'] else 'false' }}
+}
+{%- endmacro %}
+{
+  "connections": [
+    {#- special if for DALCO. Remove once dalco is not special case anymore #}
+    {%- if REDIS_STAGING_DATABASES %}
+      {%- for label in REDIS_STAGING_DATABASES.strip(',').split(',') %}
+        {{ redis_connection(label, REDIS_HOST, REDIS_PORT, REDIS_USER, REDIS_STAGING_PASSWORD, loop.index0, REDIS_SECURE) | indent(4) }},
+      {%- endfor %}
+    {%- endif %}
+    {%- if REDIS_DATABASES %}
+      {%- for label in REDIS_DATABASES.strip(',').split(',') %}
+        {{ redis_connection(label, REDIS_HOST, REDIS_PORT, REDIS_USER, REDIS_PASSWORD, loop.index0, REDIS_SECURE) | indent(4) }}{%- if not loop.last %},{% endif %}
+      {%- endfor %}
+    {%- else %}
+      {{ "REDIS_DATABASES must not be empty" / 0 }}
+    {%- endif %}
+  ]
+}

services/redis-commander/docker-compose.aws.yml

@@ -1,26 +1,22 @@
 version: "3.7"
 services:
   redis-commander:
-    image: rediscommander/redis-commander:snyk-fix-1841981ea4b1abcbc4c13e21d5d2997d
+    image: ghcr.io/joeferner/redis-commander:0.8.1
     init: true
     ports:
       - 8081
     networks:
       - monitored
       - public
+    configs:
+      - source: redis_commander_config
+        target: /redis-commander/config/local.json
     environment:
-      - >-
-        REDIS_HOSTS=
-        resources:${REDIS_HOST}:${REDIS_PORT}:0:${REDIS_PASSWORD},
-        locks:${REDIS_HOST}:${REDIS_PORT}:1:${REDIS_PASSWORD},
-        validation_codes:${REDIS_HOST}:${REDIS_PORT}:2:${REDIS_PASSWORD},
-        scheduled_maintenance:${REDIS_HOST}:${REDIS_PORT}:3:${REDIS_PASSWORD},
-        user_notifications:${REDIS_HOST}:${REDIS_PORT}:4:${REDIS_PASSWORD},
-        announcements:${REDIS_HOST}:${REDIS_PORT}:5:${REDIS_PASSWORD},
-        distributed_identifiers:${REDIS_HOST}:${REDIS_PORT}:6:${REDIS_PASSWORD},
-        deferred_tasks:${REDIS_HOST}:${REDIS_PORT}:7:${REDIS_PASSWORD}
       - URL_PREFIX=/redis
     deploy:
+      placement:
+        constraints:
+          - node.labels.ops == true
       labels:
         - traefik.enable=true
         - traefik.docker.network=${PUBLIC_NETWORK}
@@ -38,6 +34,10 @@ services:
           memory: 64M
           cpus: "0.1"
 
+configs:
+  redis_commander_config:
+    file: ./config.json
+
 networks:
   public:
     external: true

services/redis-commander/docker-compose.dalco.yml

@@ -2,7 +2,11 @@ MONITORING_DOMAIN=${MONITORING_DOMAIN}
 PREFIX_STACK_NAME=${PREFIX_STACK_NAME}
 REDIS_HOST=${REDIS_HOST}
 REDIS_PORT=${REDIS_PORT}
+REDIS_USER=${REDIS_USER}
 REDIS_PASSWORD=${REDIS_PASSWORD}
+REDIS_SECURE=${REDIS_SECURE}
+REDIS_DATABASES=${REDIS_DATABASES}
 REDIS_STAGING_PASSWORD=${REDIS_STAGING_PASSWORD}
+REDIS_STAGING_DATABASES=${REDIS_STAGING_DATABASES}
 PUBLIC_NETWORK=${PUBLIC_NETWORK}
 MONITORED_NETWORK=${MONITORED_NETWORK}