hivepaas app
An environment's apps
hivepaas app [command]
Aliases: app, apps
hivepaas app create
Create an app in an environment. With --image it runs that image, with --repo it builds that repository, with the flags of its source as hivepaas deploy takes them: its variables (--var) and port (--port) are set first, then its source, which deploys it; the command waits for the deployment as deploy does. Without a source the app is created empty, for the dashboard or hivepaas deploy to fill.
hivepaas app create NAME [flags]
Examples:
hivepaas app create api -p shop -e staging --image ghcr.io/acme/api:1.4.3 --port 8080 \
--var LOG_LEVEL=info --var DATABASE_URL='${db.HIVEPAAS_URL}'
hivepaas app create web -p shop -e staging --repo https://github.com/acme/web.git --ref main \
--git-credential acme --push-to ghcr --port 3000
Flags:
| Flag | Description |
|---|---|
--auto-deploy | deploy each push to the ref |
--command string | the container's command; "" for the image's |
--commit string | build this commit, its full SHA, and stay at it; none to follow the ref |
--dockerfile string | the Dockerfile's path in the repository |
--dockerfile-auto | generate the Dockerfile from the source |
--dockerfile-inline string | use this local file as the Dockerfile, kept in the settings; - reads stdin |
--entrypoint string | the container's entrypoint; "" for the image's |
--git-credential string | clone with this git credential; none for none |
--image string | deploy this image: ghcr.io/acme/api:1.4.3 |
--lfs | fetch the Git LFS files |
--no-auto-deploy | do not deploy on push |
--no-lfs | do not fetch the Git LFS files |
--no-submodules | do not clone the git submodules |
--no-wait | do not wait for the deployment |
--port int | the port the app listens on |
--post-deploy string | a command run after each deployment; "" for none |
--pre-deploy string | a command run before each deployment; "" for none |
--push-to string | push the built image to the registry of this credential; none keeps it on the node |
--ref string | the branch to build, or tags/NAME for a tag |
--registry-auth string | pull the image with this registry credential; none for none |
--repo string | build this git repository: https://github.com/acme/api.git |
--scan-path string | the directory a generated Dockerfile is made from |
--submodules | clone the git submodules |
--timeout duration | how long to wait for the deployment (default: 30m0s) |
--use string | switch what the app deploys: image, or repo |
--var stringArray | a runtime variable, KEY=VALUE; repeat for more |
--workdir string | the container's working directory; "" for the image's |
hivepaas app delete
Delete an app, and the apps that go with it: its previews, and what a template created for it. Its data on the volumes stays unless --remove-storage.
At a terminal it asks for the app's name to be typed; elsewhere it needs --yes.
hivepaas app delete [APP] [flags]
Flags:
| Flag | Description |
|---|---|
--remove-storage | delete the data the apps keep on volumes too |
-y, --yes | do not ask: for a script |
hivepaas app get
Show an app
hivepaas app get [APP]
hivepaas app ls
List an environment's apps
hivepaas app ls
hivepaas app scale
Without flags, show the app's replicas, its autoscale and its limits.
--replicas runs a fixed count. --min and --max turn autoscale on, between them, on the CPU (--cpu, percent of the limit) or the requests in flight (--requests); --no-autoscale turns it off. --cpus and --memory limit each replica. The change applies at once, without a deployment.
hivepaas app scale [APP] [flags]
Examples:
hivepaas app scale
hivepaas app scale --replicas 3
hivepaas app scale --min 2 --max 10 --cpu 70
hivepaas app scale --no-autoscale --replicas 2
hivepaas app scale worker --cpus 0.5 --memory 512MB
Flags:
| Flag | Description |
|---|---|
--cpu int | autoscale on the CPU: the percent of its limit each replica is kept at |
--cpus float32 | limit each replica to this many CPUs: 0.5 |
--max int | autoscale: the most replicas |
--memory string | limit each replica's memory: 512MB, 2GB |
--min int | autoscale: the fewest replicas |
--no-autoscale | turn autoscale off |
--replicas int | run this many replicas |
--requests int | autoscale on the requests in flight each replica takes |
hivepaas app start
Start an app that was stopped
hivepaas app start [APP]
hivepaas app stop
Stop an app: it keeps its settings and data, and runs nothing until started
hivepaas app stop [APP]
The global flags apply to every command.