octopaas deployments
Deploy versions, scale them, roll them out and take them down
A deployment runs one version of an integration on the platform. Commands take a deployment by name or by id, and an integration by name or by id.
Deploying, scaling and rolling out wait until the deployment is running (or has failed) and show you how it is going. Add --no-wait to return as soon as the platform has accepted the change.
Also: deployment, deploy, dep.
Examples
octopaas deployments create billing --version v1.3.0 --replicas 2
octopaas deployments list
octopaas deployments rollout billing --version v1.4.0octopaas deployments create
Deploy one version of an integration, and wait for it to be running.
Without --version it deploys the integration as it stands: its newest version when nothing has changed since that was frozen, or otherwise the draft, frozen first under the next tag (v1.2.0 becomes v1.2.1; an integration with no versions starts at v0.1.0).
Every env var the integration declares needs a value: give it one with --env, or point it at a cluster secret with --secret. deployments options lists what a deploy of it needs.
octopaas deployments create <integration> [flags]Examples
octopaas deployments create billing
octopaas deployments create billing --version v1.3.0
octopaas deployments create billing --version v1.3.0 --replicas 2 \
--env LOG_LEVEL=info --secret STRIPE_KEY=stripe --expose external --subdomain billingFlags
| Flag | What it does | Default |
|---|---|---|
--access | what the deployment's own token may do besides its stores: developer, operator | |
--env | bind a declared env var to a value, as NAME=value (repeatable) | |
--expose | external to publish it outside the cluster | |
--no-wait | return once the platform accepts the change | |
--replicas | how many replicas to run (default: the platform's) | |
--runner | standard or agentic (default: picked from the integration) | |
--runtime | pin to a runtime release (see deployments runtimes), or latest to follow the install | |
--secret | bind a declared env var to a cluster secret, as NAME=secret-name (repeatable) | |
--slug | its internal address label (default: a free one) | |
--subdomain | the subdomain to publish it on, with --expose external | |
--timeout | how long to wait for it to be running | 5m0s |
--tracing | record traces for this deployment | |
--version | the version to run, by tag or id (create: default the integration as it stands) |
octopaas deployments get
Show a deployment, its pods and where it answers.
octopaas deployments get <deployment>Examples
octopaas deployments get billingoctopaas deployments list
List deployments, newest first.
octopaas deployments list [flags]Also: ls.
Examples
octopaas deployments list
octopaas deployments list --integration billingFlags
| Flag | What it does | Default |
|---|---|---|
-i, --integration | only this integration's deployments |
octopaas deployments options
Show whether an integration serves HTTP, the env vars it declares, and whether a slug is free, before you deploy it.
octopaas deployments options <integration> [flags]Examples
octopaas deployments options billing --version v1.3.0
octopaas deployments options billing --slug billing -o jsonFlags
| Flag | What it does | Default |
|---|---|---|
--expose | external to check external exposure | |
--slug | check whether this slug is free | |
--version | check against this version, by tag or id |
octopaas deployments outdated
List every deployment that runs an older runtime release than the one the platform deploys now: the move a rollout would make, whether it is pinned, and how its test suites last went on the new runtime. Deployments whose version has no test suites are called out, since an upgrade cannot be checked before it ships. With -o json or yaml only the outdated deployments are listed.
octopaas deployments outdatedExamples
octopaas deployments outdated
octopaas deployments outdated -o json | jq -r '.deployments[] | select(.hasSuites | not) | .name'octopaas deployments rm
Take a deployment down. Its version stays, so you can deploy it again.
octopaas deployments rm <deployment> [flags]Also: delete, undeploy.
Examples
octopaas deployments rm billing --yesFlags
| Flag | What it does | Default |
|---|---|---|
-y, --yes | do not ask first |
octopaas deployments rollout
Update a deployment in place, one replica at a time. Whatever you leave out keeps what the deployment already has. A version is named by its tag in the deployment's integration, or by id.
octopaas deployments rollout <deployment> [flags]Examples
octopaas deployments rollout billing --version v1.4.0
octopaas deployments rollout billing --env LOG_LEVEL=debug --tracingFlags
| Flag | What it does | Default |
|---|---|---|
--env | bind a declared env var to a value, as NAME=value (repeatable) | |
--no-wait | return once the platform accepts the change | |
--runtime | pin to a runtime release (see deployments runtimes), or latest to follow the install | |
--secret | bind a declared env var to a cluster secret, as NAME=secret-name (repeatable) | |
--timeout | how long to wait for it to be running | 5m0s |
--tracing | record traces for this deployment | |
--version | the version to run, by tag or id (create: default the integration as it stands) |
octopaas deployments runtimes
List the runtime release the platform deploys and the supported releases no newer than it. Pin a deployment with --runtime on deployments create or rollout; --runtime latest follows the install again.
octopaas deployments runtimesExamples
octopaas deployments runtimes
octopaas deployments rollout billing --runtime 0.11.13octopaas deployments scale
Change how many replicas a deployment runs.
octopaas deployments scale <deployment> <replicas> [flags]Examples
octopaas deployments scale billing 3Flags
| Flag | What it does | Default |
|---|---|---|
--no-wait | return once the platform accepts the change | |
--timeout | how long to wait for it to be running | 5m0s |
octopaas deployments test
Run the test suites frozen under a version of the deployment's integration — by default the version it runs — with the deployment's env, on the runtime release the platform deploys now. With --upgrade, a run in which every case passes rolls the deployment onto that version; a pinned deployment refuses it.
The command waits for the verdict and exits 1 when the suites do not pass. An API key starts a test run with the CI/CD or operator role. With --upgrade, on an install that lends deployments an identity, the rollout after a pass is refused for a deployment with access grants; sign in for those (octopaas auth login).
octopaas deployments test <deployment> [flags]Examples
octopaas deployments test billing
octopaas deployments test billing --upgrade
octopaas deployments test billing --version v1.5.0Flags
| Flag | What it does | Default |
|---|---|---|
--no-wait | return once the run has started | |
--timeout | how long to wait for the verdict | 10m0s |
--upgrade | roll the deployment onto the tested version when every case passes | |
--version | the version to test, by tag or id (default: the one it runs) |
octopaas deployments upgrade
Roll a deployment onto the runtime release the platform deploys now, keeping its version, env and tracing. A pinned deployment stays pinned, at the new release.
With --test the deployment's suites run first and it is upgraded only when every case passes; a pinned one is tested, then has its pin moved. On an install that lends deployments an identity, an API key upgrades only with the CI/CD or operator role, and only a deployment with no access grants; otherwise sign in (octopaas auth login).
octopaas deployments upgrade <deployment> [flags]Examples
octopaas deployments upgrade billing --test
octopaas deployments upgrade billingFlags
| Flag | What it does | Default |
|---|---|---|
--no-wait | return once the platform accepts the change | |
--test | run the deployment's test suites first, and upgrade only if they pass | |
--timeout | how long to wait | 10m0s |