Repository navigation
docs(cli): describe deploy build, logs and prune as they now work - #4441
Conversation
- build push: --platform from builder.arch (list or comma string, default amd64, validated), --builder kamal-<service> when builder.remote is set, --build-arg per builder.args entry sorted by key, and the service label. - build create: passes builder.remote's endpoint; run it once when remote builds are configured. - app logs: without --container, each role's newest running container; --container is shell-quoted. - prune images (and the prune index): removes the service's unused images, tagged ones included. - app: an unknown --role is an error listing the defined roles; --release also takes the space form. Every command shown was run with --dry-run against develop. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com>
|
rev1-r3 review @ 38d4635: content APPROVE (final pending PR CI) I checked all six pages against the merged code for #4423 (
Two optional nits:
Gate: docs-only, so PR CI (including the guides build). I'll post the final when it's green. |
… role - prune images: rollback restarts a version's existing container and doesn't pull, so pruning only matters once prune containers has removed that container; then redeploy the version with --skip-push to pull its image. - app logs: the role and destination filters are added per targeted role, quoted as emitted; the destination filter is empty without --destination. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com>
|
rev1-r3 review @ 88e4a2a: content APPROVE (final pending PR CI) Both nits are folded in, and the rollback note corrects my premise. Rollback runs The logs sample now marks the role and destination filters optional and quotes each filter, and it explains the empty-destination case. Gate: PR CI. I'll post the final when it's green. |
|
rev1-r3 review @ e3dca19: APPROVE (final) The content was approved at 88e4a2a, and this head's changed lines against Ready to merge. |
Summary
This updates the deploy command reference to the behaviour of #4423 (builder options,
app logs,prune images) and #4424 (space-form values, unknown--role). #4404 had documented the behaviour from before those fixes.build push:--platformcomes frombuilder.arch: a list or a comma-separated string, defaulting toamd64. An entry containing/is used as is, and anything that isn't a plain platform name is rejected withWheels.Deploy.InvalidInput.--builder kamal-<service>is added whenbuilder.remoteis set.--build-argperbuilder.argsentry, sorted by key.servicelabel is set on every image, with a--dry-runexample.build create: passesbuilder.remote's endpoint, so the builder runs on that host. Run it once when remote builds are configured.app logs: without--container, each role's newest running container (docker ps --latest ... | xargs -r docker logs);--containeris shell-quoted. The examples no longer need--container.prune images(and the rows in thepruneindex):docker image prune --all --force --filter label=service=<service>. It removes the service's unused images, tagged ones included. Images built before the label was added carry none.appcommon flags: an unknown--roleis an error that lists the defined roles;--releasealso takes the space form.Verification
--dry-run, using a CLI built from develop (fix(cli): deploy build push honours the builder block; logs and prune images work #4423 and fix(cli): deploy binds space-form values, rejects an unknown role, prints whole ports #4424 merged) against a scratch app with two roles and abuildersection. Checked: list and comma-stringarch, an invalid arch, defaults with nobuilder,--tail,--follow, a quoted--container, and an unknown role on boot, stop, details and logs.pnpm build(guides): 852 pages.pnpm verify:docson the deploy pages: 1 passed, 0 failed.🤖 Generated with Claude Code