dcloud deploy apps updateChange an app, including its release command and health checks
Takes effect on the next deployment.
Synopsis
dcloud deploy apps update id [flags]Arguments
<id>Requiredstring
Also accepted as
--id. Constraints: uuid
Flags
--nameOptionalstring
New display name
Constraints: 1-64 chars
--branchOptionalstring
Branch the app deploys from; null returns to the repository’s default branch
Constraints: 1-255 chars
May be null.
--deploy-on-pushOptionalboolean (--deploy-on-push / --no-deploy-on-push)
Whether each commit pushed to the branch is deployed
--root-dirOptionalstring
Directory in the repository the app is built from
Constraints: 1-255 chars, /^[A-Za-z0-9._/-]+$/
--builderOptionalenum
How the app is built: railpack, dockerfile, image or compose (see Create an app)
One of:
railpack,dockerfile,forgejo_actions,image,compose--build-commandOptionalstring
Replaces the detected build command; null returns to the detected one
Constraints: max 1024 chars
May be null.
--start-commandOptionalstring
Replaces the detected start command; null returns to the detected one
Constraints: max 1024 chars
May be null.
--image-refOptionalstring
Container image the app runs, for builder image
Constraints: 1-512 chars, /^[a-z0-9]([a-z0-9._-]*[a-z0-9])?(:[0-9]+)?(\/[a-z0-9]([a-z0-9._-]*[a-z0-9])?)*(:[A-Za-z0-9._-]+|@sha256:[a-f0-9]{64})?$/
--compose-sourceOptionalenum
Compose apps: inline (composeFile) or git (composePath in the repository)
One of:
inline,git--compose-fileOptionalstring
Compose apps: the new compose file text, checked when saved
Constraints: max 131072 chars
--compose-pathOptionalstring
Compose apps: path of the compose file in the repository
Constraints: 1-255 chars, /^[A-Za-z0-9._/-]+$/
--compose-serviceOptionalstring
Compose apps: the service published on the app’s domains
Constraints: 1-63 chars
--compose-portOptionalnumber
Compose apps: the container port of composeService that receives traffic
Constraints: integer, 1-65535
--portOptionalnumber
Port the app listens on in its container
Constraints: integer, 1-65535
--instance-typeOptionalstring
Machine size of each machine, an instance type, e.g. performance-2 (the provider’s own names are still accepted, deprecated)
Constraints: 1-32 chars
--replicasOptionalnumber
Number of machines; more than one puts a load balancer in front
Constraints: integer, 1-10
--locationsOptionalarray of string
Locations the machines are spread over in order, all in one region (e.g. fsn1, nbg1); empty means the region’s own location
Constraints: /^[a-z]{3}\d$/
--release-commandOptionalstring
Command run once per deployment with /bin/sh -c in the new image, before traffic moves to it (e.g. database migrations); null or omitted runs none
Constraints: 1-4096 chars
May be null.
--release-serviceOptionalstring
Compose apps: the service whose image and environment run the release command; omitted or null, the published service
Constraints: 1-63 chars
May be null.
--release-timeout-secOptionalnumber
Seconds the release command may run before the deployment fails; a new app gets 600
Constraints: integer, 10-3600
--health-checkOptionalobject
The HTTP check a new container must pass before it gets traffic; null or omitted means GET / on the app port, any status below 500
Constraints: JSON
May be null.
--compose-health-checksOptionalmap of string
Compose apps: health checks for services other than the published one, keyed by service name
Constraints: key=<json>
May be null.
Example
dcloud deploy apps update idGenerated from the API description, the same one the API checks requests against and the CLI is built from.