Support patching existing config files (#152)

itzg · Nov 26, 2023 · 703d81a · 703d81a
1 parent c404dcc
commit 703d81a
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 12 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -25,24 +25,27 @@ ARG TARGETOS
 ARG TARGETARCH
 ARG TARGETVARIANT
 
-ARG EASY_ADD_VER=0.8.1
-ADD https://github.com/itzg/easy-add/releases/download/${EASY_ADD_VER}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
+ARG APPS_REV=1
+ARG GITHUB_BASEURL=https://github.com
+
+ARG EASY_ADD_VERSION=0.8.2
+ADD ${GITHUB_BASEURL}/itzg/easy-add/releases/download/${EASY_ADD_VERSION}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
 RUN chmod +x /usr/bin/easy-add
 
-# Add mc-monitor
+ARG MC_MONITOR_VERSION=0.12.6
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
- --var version=0.12.5 --var app=mc-monitor --file {{.app}} \
- --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+  --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-# Add rcon-cli
+ARG RCON_CLI_VERSION=1.6.4
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
- --var version=1.6.3 --var app=rcon-cli --file {{.app}} \
- --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+  --var version=${RCON_CLI_VERSION} --var app=rcon-cli --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 COPY --chmod=444 templates/ /templates/
 
-ARG MC_HELPER_VERSION=1.36.12
-ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
+ARG MC_HELPER_VERSION=1.37.0
+ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1
 RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \

diff --git a/README.md b/README.md
@@ -340,6 +340,54 @@ The content of `db_password`:
 
     ug23u3bg39o-ogADSs
 
+### Patching existing files
+
+JSON path based patches can be applied to one or more existing files by setting the variable `PATCH_DEFINITIONS` to the path of a directory that contains one or more [patch definition json files](https://github.com/itzg/mc-image-helper#patchdefinition) or a [patch set json file](https://github.com/itzg/mc-image-helper#patchset).
+
+JSON path based patches can be applied to one or more existing files by setting the variable `PATCH_DEFINITIONS` to the path of a directory that contains one or more [patch definition json files](https://github.com/itzg/mc-image-helper#patchdefinition) or a [patch set json file](https://github.com/itzg/mc-image-helper#patchset).
+
+The `file` and `value` fields of the patch definitions may contain `${...}` variable placeholders. The allowed environment variables in placeholders can be restricted by setting `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_".
+
+The following example shows a patch-set file were various fields in the `paper.yaml` configuration file can be modified and added:
+
+```json
+{
+  "patches": [
+    {
+      "file": "/data/paper.yml",
+      "ops": [
+        {
+          "$set": {
+            "path": "$.verbose",
+            "value": true
+          }
+        },
+        {
+          "$set": {
+            "path": "$.settings['velocity-support'].enabled",
+            "value": "${CFG_VELOCITY_ENABLED}",
+            "value-type": "bool"
+          }
+        },
+        {
+          "$put": {
+            "path": "$.settings",
+            "key": "my-test-setting",
+            "value": "testing"
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+Supports the file formats:
+- JSON
+- JSON5
+- Yaml
+- TOML, but processed output is not pretty
+
 ## Scenarios
 
 ### Running non-root

diff --git a/scripts/run-bungeecord.sh b/scripts/run-bungeecord.sh
@@ -187,7 +187,7 @@ function processConfigs {
   if [ -d /config ]; then
       log "Copying configs over..."
 
-      mc-image-helper --debug="${DEBUG}" $subcommand \
+      mc-image-helper $subcommand \
         --skip-newer-in-destination="${SYNC_SKIP_NEWER_IN_DESTINATION}" \
         --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
         --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
@@ -207,14 +207,22 @@ function processConfigs {
   # Replace environment variables in config files
   if isTrue "${REPLACE_ENV_VARIABLES}"; then
     log "Replacing env variables in configs that match the prefix $REPLACE_ENV_VARIABLE_PREFIX..."
-    mc-image-helper --debug=${DEBUG} interpolate \
+    mc-image-helper interpolate \
       --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
       --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
       --replace-env-exclude-paths="${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}" \
       --replace-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
       "${BUNGEE_HOME}"
 
   fi
+
+  if [[ -v PATCH_DEFINITIONS ]]; then
+    log "Applying patch definitions from ${PATCH_DEFINITIONS}"
+    mc-image-helper patch \
+      --patch-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
+      "${PATCH_DEFINITIONS}"
+  fi
+
 }
 
 function pruneOlder() {