Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt

Use this file to discover all available pages before exploring further.

manage docker-compose files Refer to the Compose Deploy guide for additional details. 
cpln stack [SUBCOMMAND]

Commands:
  cpln stack deploy    deploy from a docker-compose file  [aliases: up]
  cpln stack manifest  Generate a CPLN apply file from a docker-compose file
  cpln stack rm        Delete objects from a docker-compose file  [aliases: down]

Options:
  --help  Show help  [boolean]

​
stack deploy

deploy from a docker-compose file Refer to the compose deploy guide for more details. Usage 
cpln stack deploy [OPTIONS]

Command options:
  --directory, --dir  Path to parent folder of docker-compose file
  --compose-file      Name of the docker-compose file if alternative naming was used
  --build             Build images  [boolean] [default: true]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
  --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]
Common Options Reference
  • Assuming there is a docker compose project in the current directory
cpln stack deploy

​
stack manifest

Generate a CPLN spec file from a compose project. Outputs result to stdout. Note: this command will build and push images to CPLN Usage 
cpln stack manifest [OPTIONS]

Command options:
  --directory, --dir  Path to parent folder of docker-compose file
  --compose-file      Name of the docker-compose file if alternative naming was used
  --build             Build images  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
  --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Options:
  --help  Show help  [boolean]
Common Options Reference
  • Assuming there is a docker compose project in the current directory.
cpln stack manifest

​
stack rm

Delete all resources generated from a docker compose project. Usage 
cpln stack rm [OPTIONS]

Command options:
  --directory, --dir  Path to parent folder of docker-compose file
  --compose-file      Name of the docker-compose file if alternative naming was used

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
  --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]
Common Options Reference
  • Assuming there is a docker compose project in the current directory
cpln stack rm