build
Command used to create or update resources in a StackQL environment.
Syntax
stackql-deploy build STACK_DIR STACK_ENV [FLAGS]
Arguments
| Argument | Description | Example |
|---|---|---|
STACK_DIR | The directory containing the stack configuration files | my-stack |
STACK_ENV | The target environment for the stack deployment | dev |
STACK_DIR can be an absolute or relative path.
STACK_ENV is a user defined environment symbol (e.g. dev, sit, prd) which is used to deploy your stack to different environments.
Optional Flags
| Flag | Description | Example |
|---|---|---|
--log-level | Set the logging level. Default is INFO | --log-level DEBUG |
--env-file | Specify an environment variables file. Default is .env | --env-file .env |
-e --env | Set additional environment variables (can be used multiple times) | --env DB_USER=admin |
--dry-run | Perform a dry run of the operation. No changes will be made | |
--show-queries | Display the queries executed in the output logs | |
--download-dir | Custom download directory for StackQL | /etc/stackql |
--custom-registry | Custom StackQL provider registry URL | https://myreg |
Exported variables specified as protected in the respective resource definition in the stackql_manifest.yml file are obfuscated in the logs by default.
Examples
Deploy a stack to a target environment
Deploy the stack defined in the azure-stack directory to the sit environment, setting additional environment variables to be used in the deployment:
stackql-deploy build azure-stack sit \
-e AZURE_SUBSCRIPTION_ID=631d1c6d-0000-0000-0000-688bfe4e1468
Perform a dry run deployment
Perform a dry run or a stack defined in the aws-stack directory to a prd environment, showing templated queries without actually running them:
stackql-deploy build aws-stack prd \
--dry-run
Specifying a custom environment file
Use a custom environment file .env.prod to supply environment variables to a stack defined in the gcp-stack directory to a prod environment:
stackql build gcp-stack prod \
--env-file .env.prod