1 Commits
v4 ... v5
Author SHA1 Message Date
tthandClaude Opus 5.5 380988c194 portainer-deploy: content-addressed Swarm configs from repo files (v5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-26 14:24:36 +01:00
2 changed files with 144 additions and 69 deletions

No files matched your search

+18 -1
View File
@@ -115,7 +115,7 @@ live) are kept and never logged; only `vars` are overwritten. Images are
re-pulled (`pullImage`).
```yaml
- uses: https://git.rfa.cz/tth-pub/ci-actions/portainer-deploy@v4
- uses: https://git.rfa.cz/tth-pub/ci-actions/portainer-deploy@v5
with:
url: ${{ secrets.PORTAINER_URL }}
token: ${{ secrets.PORTAINER_TOKEN }}
@@ -128,6 +128,23 @@ re-pulled (`pullImage`).
smoke-timeout: "180"
```
Config files from the repo can ride along as Swarm configs. Each becomes a
config named after its content hash, created when missing; the stack
variable points at it, so a changed file rolls the services that mount it,
and superseded versions are removed once nothing uses them:
```yaml
configs: |
CFG_NGINX=deploy/nginx.conf
config-prefix: myapp_
```
```yaml
# compose
configs:
nginx_conf: {external: true, name: "${CFG_NGINX}"}
```
Pin images in the compose file to the variable (`image: …:${IMAGE_TAG}`), so
the deployed version is the commit that passed the gate, not whatever
`latest` points at when Swarm pulls.
+126 -68
View File
@@ -4,7 +4,8 @@ description: >
compose file is the single source of truth: Portainer's stored compose is
replaced on every deploy, the stack's env vars (where the secrets live) are
kept and only the given variables are overwritten. Images are re-pulled.
Optionally waits until a URL answers with the expected status.
Config files from the repo can be shipped as content-addressed Swarm
configs. Optionally waits until a URL answers with the expected status.
inputs:
url:
@@ -29,6 +30,19 @@ inputs:
Stack variables to set, one NAME=value per line (e.g. IMAGE_TAG=sha-1234abcd).
Every other stack variable is kept as it is.
default: ""
configs:
description: >
Files shipped as Swarm configs, one VAR=path per line. Each file becomes
a config named <config-prefix><var>-<sha256[:12] of the content>
(created when missing) and the stack variable VAR is set to that name,
so the compose file references it as
`{external: true, name: "${VAR}"}`. A changed file = a new config =
the service is updated; older versions of the same VAR are removed once
no service uses them.
default: ""
config-prefix:
description: Prefix of the config names (e.g. the stack name and an underscore).
default: ""
prune:
description: Remove services that are no longer in the compose file.
default: "false"
@@ -53,6 +67,8 @@ runs:
COMPOSE_FILE: ${{ inputs.compose-file }}
ENDPOINT_ID: ${{ inputs.endpoint-id }}
SET_VARS: ${{ inputs.vars }}
CONFIGS: ${{ inputs.configs }}
CONFIG_PREFIX: ${{ inputs.config-prefix }}
PRUNE: ${{ inputs.prune }}
SMOKE_URL: ${{ inputs.smoke-url }}
SMOKE_STATUS: ${{ inputs.smoke-status }}
@@ -63,73 +79,115 @@ runs:
echo "::notice::portainer-deploy: no stack id, deploy skipped"
exit 0
fi
: "${PORTAINER_URL:?url input is empty}" "${PORTAINER_TOKEN:?token input is empty}"
[ -f "$COMPOSE_FILE" ] || { echo "::error::compose file $COMPOSE_FILE not found"; exit 1; }
work="${RUNNER_TEMP:-/tmp}/portainer-deploy"; mkdir -p "$work"; chmod 700 "$work"
trap 'rm -rf "$work"' EXIT
base="${PORTAINER_URL%/}"
# The stack env carries the secrets: it only ever lives in this
# process's memory, between the GET and the PUT, never in the log.
python3 - <<'PY'
import base64, hashlib, json, os, ssl, sys, time, urllib.error, urllib.parse, urllib.request
# The stack body carries the env (secrets): it goes from this GET into
# the PUT body through a private temp file and never to the log.
code=$(curl -sS -o "$work/stack.json" -w '%{http_code}' \
-H "X-API-Key: $PORTAINER_TOKEN" "$base/api/stacks/$STACK_ID") || code=000
if [ "$code" != 200 ]; then
echo "::error::Portainer GET /api/stacks/$STACK_ID returned HTTP $code"
exit 1
fi
E = os.environ
base = E["PORTAINER_URL"].rstrip("/")
token = E["PORTAINER_TOKEN"]
stack_id, endpoint = E["STACK_ID"], E.get("ENDPOINT_ID") or "1"
if not base or not token:
sys.exit("::error::portainer-deploy: url and token are required")
python3 - "$work/stack.json" "$COMPOSE_FILE" "$work/body.json" <<'PY'
import json, os, sys
stack_path, compose_path, out_path = sys.argv[1:]
with open(stack_path) as f:
stack = json.load(f)
sets = {}
for line in os.environ.get("SET_VARS", "").splitlines():
line = line.strip()
if not line:
continue
name, sep, value = line.partition("=")
if not sep or not name:
sys.exit(f"portainer-deploy: bad vars line (want NAME=value): {name!r}")
sets[name.strip()] = value
env = [e for e in (stack.get("Env") or []) if e.get("name") not in sets]
env += [{"name": k, "value": v} for k, v in sets.items()]
with open(compose_path) as f:
compose = f.read()
body = {
"stackFileContent": compose,
"env": env,
"prune": os.environ.get("PRUNE", "false").lower() == "true",
"pullImage": True,
}
fd = os.open(out_path, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
with os.fdopen(fd, "w") as f:
json.dump(body, f)
kept = len(env) - len(sets)
print(f"stack {stack.get('Name', '?')}: setting {', '.join(f'{k}={v}' for k, v in sets.items()) or 'nothing'}; {kept} other variable(s) kept")
def api(method, path, body=None, ok=(200,)):
req = urllib.request.Request(base + path, method=method,
headers={"X-API-Key": token, "Content-Type": "application/json"},
data=None if body is None else json.dumps(body).encode())
try:
with urllib.request.urlopen(req, timeout=120) as r:
status, raw = r.status, r.read()
except urllib.error.HTTPError as e:
status, raw = e.code, e.read()
if status not in ok:
raise RuntimeError(f"{method} {path.split('?')[0]} -> HTTP {status}: {raw[:300].decode(errors='replace')}")
return status, (json.loads(raw) if raw.strip() else None)
def lines(name):
out = {}
for line in E.get(name, "").splitlines():
line = line.strip()
if not line:
continue
key, sep, value = line.partition("=")
if not sep or not key.strip():
sys.exit(f"::error::portainer-deploy: bad {name.lower()} line (want NAME=value): {key!r}")
out[key.strip()] = value.strip() if name == "CONFIGS" else value
return out
try:
sets = lines("SET_VARS")
docker = f"/api/endpoints/{endpoint}/docker"
# Content-addressed configs: the name changes with the content, so
# a changed file rolls the services that mount it.
prefix = E.get("CONFIG_PREFIX", "")
stale = []
for var, path in lines("CONFIGS").items():
with open(path, "rb") as f:
data = f.read()
stem = f"{prefix}{var.lower()}"
name = f"{stem}-{hashlib.sha256(data).hexdigest()[:12]}"
flt = urllib.parse.quote(json.dumps({"label": [f"portainer-deploy.config={stem}"]}))
_, existing = api("GET", f"{docker}/configs?filters={flt}")
names = {c["Spec"]["Name"]: c["ID"] for c in existing or []}
if name in names:
print(f"config {name} ({path}) unchanged")
else:
api("POST", f"{docker}/configs/create", {
"Name": name,
"Data": base64.b64encode(data).decode(),
"Labels": {"portainer-deploy.config": stem},
}, ok=(200, 201))
print(f"config {name} created from {path}")
stale += [(n, i) for n, i in names.items() if n != name]
sets[var] = name
_, stack = api("GET", f"/api/stacks/{stack_id}")
env = [e for e in (stack.get("Env") or []) if e.get("name") not in sets]
kept = len(env)
env += [{"name": k, "value": v} for k, v in sets.items()]
with open(E["COMPOSE_FILE"]) as f:
compose = f.read()
api("PUT", f"/api/stacks/{stack_id}?endpointId={endpoint}", {
"stackFileContent": compose,
"env": env,
"prune": E.get("PRUNE", "false").lower() == "true",
"pullImage": True,
})
shown = ", ".join(f"{k}={v}" for k, v in sets.items()) or "nothing"
print(f"stack {stack.get('Name', stack_id)} updated from {E['COMPOSE_FILE']}: {shown}; {kept} other variable(s) kept")
# Older versions go once nothing mounts them; Docker refuses to
# delete a config in use (the previous task may still be draining),
# the next deploy retries.
for name, cid in stale:
try:
api("DELETE", f"{docker}/configs/{cid}", ok=(200, 204))
print(f"config {name} removed (superseded)")
except RuntimeError:
print(f"config {name} still in use, kept for the next deploy")
except (RuntimeError, OSError) as exc:
sys.exit(f"::error::portainer-deploy: {exc}")
url = E.get("SMOKE_URL", "")
if url:
want, deadline = E.get("SMOKE_STATUS", "200"), time.time() + float(E.get("SMOKE_TIMEOUT") or 180)
ctx = ssl.create_default_context()
ctx.check_hostname, ctx.verify_mode = False, ssl.CERT_NONE
while True:
try:
with urllib.request.urlopen(url, timeout=10, context=ctx) as r:
got = str(r.status)
except urllib.error.HTTPError as e:
got = str(e.code)
except (urllib.error.URLError, OSError):
got = "000"
if got == want:
print(f"smoke: {url} answered {got}")
break
if time.time() >= deadline:
sys.exit(f"::error::smoke: {url} answered {got}, expected {want}")
time.sleep(10)
PY
code=$(curl -sS -o "$work/resp.json" -w '%{http_code}' -X PUT \
"$base/api/stacks/$STACK_ID?endpointId=$ENDPOINT_ID" \
-H "X-API-Key: $PORTAINER_TOKEN" -H "Content-Type: application/json" \
--data-binary "@$work/body.json") || code=000
if [ "$code" != 200 ]; then
echo "::error::Portainer stack PUT returned HTTP $code: $(head -c 300 "$work/resp.json" 2>/dev/null)"
exit 1
fi
echo "stack $STACK_ID updated from $COMPOSE_FILE"
[ -n "$SMOKE_URL" ] || exit 0
deadline=$(( $(date +%s) + SMOKE_TIMEOUT ))
while :; do
got=$(curl -sk -o /dev/null -w '%{http_code}' --max-time 10 "$SMOKE_URL" 2>/dev/null) || got=000
if [ "$got" = "$SMOKE_STATUS" ]; then
echo "smoke: $SMOKE_URL answered $got"
break
fi
if [ "$(date +%s)" -ge "$deadline" ]; then
echo "::error::smoke: $SMOKE_URL answered $got, expected $SMOKE_STATUS (waited ${SMOKE_TIMEOUT}s)"
exit 1
fi
sleep 10
done