dcloud deploy apps update

Change an app, including its release command and health checks

IAM deploy:UpdateAppChanges stateAsks before it deletes (-y skips)

Takes effect on the next deployment.

Synopsis

dcloud deploy apps update id [flags]

Arguments

  • <id>Required

    string

    Also accepted as --id. Constraints: uuid

Flags

  • --nameOptional

    string

    New display name

    Constraints: 1-64 chars

  • --branchOptional

    string

    Branch the app deploys from; null returns to the repository’s default branch

    Constraints: 1-255 chars

    May be null.

  • --deploy-on-pushOptional

    boolean (--deploy-on-push / --no-deploy-on-push)

    Whether each commit pushed to the branch is deployed

  • --root-dirOptional

    string

    Directory in the repository the app is built from

    Constraints: 1-255 chars, /^[A-Za-z0-9._/-]+$/

  • --builderOptional

    enum

    How the app is built: railpack, dockerfile, image or compose (see Create an app)

    One of: railpack, dockerfile, forgejo_actions, image, compose

  • --build-commandOptional

    string

    Replaces the detected build command; null returns to the detected one

    Constraints: max 1024 chars

    May be null.

  • --start-commandOptional

    string

    Replaces the detected start command; null returns to the detected one

    Constraints: max 1024 chars

    May be null.

  • --image-refOptional

    string

    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-sourceOptional

    enum

    Compose apps: inline (composeFile) or git (composePath in the repository)

    One of: inline, git

  • --compose-fileOptional

    string

    Compose apps: the new compose file text, checked when saved

    Constraints: max 131072 chars

  • --compose-pathOptional

    string

    Compose apps: path of the compose file in the repository

    Constraints: 1-255 chars, /^[A-Za-z0-9._/-]+$/

  • --compose-serviceOptional

    string

    Compose apps: the service published on the app’s domains

    Constraints: 1-63 chars

  • --compose-portOptional

    number

    Compose apps: the container port of composeService that receives traffic

    Constraints: integer, 1-65535

  • --portOptional

    number

    Port the app listens on in its container

    Constraints: integer, 1-65535

  • --instance-typeOptional

    string

    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

  • --replicasOptional

    number

    Number of machines; more than one puts a load balancer in front

    Constraints: integer, 1-10

  • --locationsOptional

    array 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-commandOptional

    string

    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-serviceOptional

    string

    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-secOptional

    number

    Seconds the release command may run before the deployment fails; a new app gets 600

    Constraints: integer, 10-3600

  • --health-checkOptional

    object

    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-checksOptional

    map 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 id

Generated from the API description, the same one the API checks requests against and the CLI is built from.