computesphere/Deploy to ComputeSphere

Deploy an app to ComputeSphere from a computesphere.yaml manifest or prebuilt image, and wait for it to reach Running.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
tokenComputeSphere API token used to authenticate `csph`. A project-scoped `csph_` token is recommended. It is masked and exported as COMPUTESPHERE_API_TOKEN by the install step — never interpolated into a shell command.yes
versioncsph version to install (e.g. "0.12.2"). Defaults to "latest"; pin a concrete version for reproducible pipelines.nolatest
filePath to the computesphere.yaml manifest to deploy (relative to working-directory). Ignored when `image` is set.nocomputesphere.yaml
imageA prebuilt image reference to deploy as a one-service web app instead of a manifest. Prefer an immutable digest (e.g. ghcr.io/org/app@sha256:…) so a preview and production are provably the same artifact.no""
nameService name when deploying with `image`. Defaults to a name derived from the image.no""
portContainer port for the `image` service.no8080
registry-usernameUsername for the private registry hosting `image`. Only applies with `image`.no""
registry-passwordPassword or access token for the private registry hosting `image`. Only applies with `image`. This is a secret — pass a repository or environment secret (e.g. secrets.REGISTRY_PASSWORD), never a literal. The deploy step masks it (`::add-mask::`) before use.no""
registry-urlRegistry server URL for private-registry auth (e.g. `ghcr.io`). Only applies with `image`; defaults to the registry in the image reference.no""
image-providerRegistry provider hint for private-registry auth (e.g. `ghcr`, `dockerhub`, `acr`). Only applies with `image`.no""
projectTarget project ID. Falls back to the token's default when unset.no""
environmentTarget environment ID. Falls back to the account default when unset.no""
atomicRoll every resource back if any fails (all-or-nothing).nofalse
wait-timeoutHow long to wait for the deployment to reach Running, as a Go duration (e.g. "5m", "90s").no5m
no-waitReturn as soon as resources are accepted; don't wait for Running. NOT recommended in CI — the job then can't reflect whether the deploy became healthy.nofalse
working-directoryDirectory to run the deploy in (where the manifest lives).no.
namedescription
deployment-idDeployment ID of the single deployed/updated service. Empty for a multi-service manifest apply.
service-urlPublic URL of the deployed service (empty when not resolvable).
statusApply outcome for the service — created, updated, or unchanged.
resultThe full `csph deploy --output json` result document.