Skip to content

Make probe path configurable and document maildev 3.x opt-in - #10

Open
djfarrelly wants to merge 1 commit into
mainfrom
feat/configurable-probe-path-3x-docs
Open

Make probe path configurable and document maildev 3.x opt-in#10
djfarrelly wants to merge 1 commit into
mainfrom
feat/configurable-probe-path-3x-docs

Conversation

@djfarrelly

Copy link
Copy Markdown
Member

Context

Follow-up to the question of defaulting the chart to maildev 3.x. Investigation found:

  • 3.0.0-rc.1's flags/env are compatible with the chart (--verbose, --auto-relay, --outgoing-secure, ports all work; no MAILDEV_HTTPS-style truthiness trap).
  • But 3.x is a rewrite that removed the /healthz endpoint. On 3.0.0-rc.1, /healthz → 404 and only / → 200. Since the probes hardcode /healthz, a bare image.tag: 3.0.0-rc.1 would crashloop.
  • It's also a release candidate, so it shouldn't be the default for a published chart.

Change

  • Keep 2.2.1 as the default appVersion.

  • Add a probePath value (default /healthz, so 2.x behavior is unchanged) used by both the liveness and readiness probes.

  • Document the 3.x opt-in in values.yaml and a new README section:

    image:
      tag: "3.0.0-rc.1"
    probePath: "/"
  • Chart version 0.2.0 → 0.3.0 (additive, backward-compatible).

Verification

  • helm lint → 0 failures.
  • Default render: image: maildev/maildev:2.2.1, probes path: /healthz.
  • --set image.tag=3.0.0-rc.1 --set probePath=/: image: maildev/maildev:3.0.0-rc.1, probes path: /.
  • Confirmed against the real image: 3.0.0-rc.1 serves / → 200 (and /healthz → 404), 2.2.1 serves /healthz → 200.

🤖 Generated with Claude Code

maildev 3.x is a rewrite that removed the /healthz endpoint the
liveness/readiness probes use, so a 3.x image would crashloop against the
hardcoded path. Expose the probe path as `probePath` (default /healthz,
unchanged for 2.x) so users can point it at "/" when running 3.x.

Keep the stable 2.2.1 as the chart default (a published chart shouldn't
default to a release candidate) and document how to opt into the 3.0.0-rc.1
image in the README and values.yaml. Chart version 0.2.0 -> 0.3.0.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant