Skip to content

docs: warn on missing docker-start and document custom-image CMD pitfall - #13898

Open
mehrdadbn9 wants to merge 1 commit into
apache:masterfrom
mehrdadbn9:fix/custom-image-cmd-13775
Open

docs: warn on missing docker-start and document custom-image CMD pitfall#13898
mehrdadbn9 wants to merge 1 commit into
apache:masterfrom
mehrdadbn9:fix/custom-image-cmd-13775

Conversation

@mehrdadbn9

Copy link
Copy Markdown

Description

A custom image built from docker commit of a shell session bakes the shell into CMD, replacing the official ["docker-start"]. The entrypoint then falls through to exec "$@" and the container exits 0 with no logs and no APISIX process (#13775).

This PR:

  • emits a stderr warning in /docker-entrypoint.sh when the first argument is not docker-start, so the silent failure is obvious instead of a mysterious exit 0.
  • adds an FAQ entry with the correct Dockerfile pattern (switch USER inside the Dockerfile instead of committing a shell session), plus the Kubernetes command/args override.

Checklist

  • I have explained my changes
  • Doc/entrypoint change, no behavior change for the normal docker-start path

Refs #13775

A custom image built from 'docker commit' of a shell session bakes the
shell into CMD, replacing the official ['docker-start']. The entrypoint
then falls through to 'exec "$@"' and the container exits 0 with no
logs and no APISIX process.

- emit a stderr warning when the first arg is not 'docker-start' so the
  silent failure is obvious
- add an FAQ entry with the correct Dockerfile pattern (switch USER
  inside the Dockerfile instead of committing a shell)

Refs apache#13775

Signed-off-by: Mehrdad Biukian Naeini <mehrdadbiukian@gmail.com>
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. doc Documentation things labels Aug 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant