canasta sidecar add
From Canasta Wiki
canasta sidecar add
Add an app sidecar to config/sidecars.yaml
Synopsis
Declare an app sidecar in config/sidecars.yaml, then run
canasta restart to deploy it. Covers the common fields; for
richer sidecars (mounted config files, dependencies, healthchecks)
edit config/sidecars.yaml directly.
canasta sidecar add [flags]
Examples
canasta sidecar add -i mywiki --name cache --image redis:7-alpine --port 6379
canasta sidecar add -i mywiki --name cache --image redis:7-alpine --volume data:/data:1Gi
Flags
| Flag | Shorthand | Description | Default | Required | Orchestrator |
|---|---|---|---|---|---|
--build |
Build context path (mutually exclusive with --image) | Both | |||
--env |
Environment entry as KEY=VALUE (repeatable) | Both | |||
--id |
-i |
Canasta instance ID | * | Both | |
--image |
Image reference (mutually exclusive with --build) | Both | |||
--path |
-p |
Path to the Canasta instance directory | Both | ||
--port |
Container port the sidecar listens on (repeatable) | Both | |||
--sidecar-command |
Override command (a string) | Both | |||
--sidecar-name |
-n |
Sidecar name (a DNS label; becomes a service + hostname) | ✓ | Both | |
--volume |
Volume as NAME:MOUNTPATH (ephemeral) or NAME:MOUNTPATH:SIZE (persistent); repeatable | Both |
* Defaults to the Canasta instance matching the current directory, if any.
Global flags
| Flag | Shorthand | Description | Default | Required | Orchestrator |
|---|---|---|---|---|---|
--help |
-h |
Show help message and exit | Both | ||
--verbose |
-v |
Enable verbose output | Both |
