Skip to content

README.md

Latest commit

 

History

History
80 lines (57 loc) · 3.09 KB

README.md

File metadata and controls

80 lines (57 loc) · 3.09 KB

stackql-deploy starter project for aws

for starter projects using other providers, try stackql-deploy patch-doc-test --provider=azure or stackql-deploy patch-doc-test --provider=google

see the following links for more information on stackql, stackql-deploy and the aws provider:

Overview

stackql-deploy is a stateless, declarative, SQL driven Infrastructure-as-Code (IaC) framework. There is no state file required as the current state is assessed for each resource at runtime. stackql-deploy is capable of provisioning, deprovisioning and testing a stack which can include resources across different providers, like a stack spanning aws and azure for example.

Prerequisites

This example requires stackql-deploy to be installed using pip install stackql-deploy. The host used to run stackql-deploy needs the necessary environment variables set to authenticate to your specific provider, in the case of the aws provider, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN must be set, for more information on authentication to aws see the aws provider documentation.

Note for macOS users
to install stackql-deploy in a virtual environment (which may be necessary on macOS), use the following:

python3 -m venv myenv
source myenv/bin/activate
pip install stackql-deploy

Usage

Adjust the values in the stackql_manifest.yml file if desired. The stackql_manifest.yml file contains resource configuration variables to support multiple deployment environments, these will be used for stackql queries in the resources folder.

The syntax for the stackql-deploy command is as follows:

stackql-deploy { build | test | teardown } { stack-directory } { deployment environment} [ optional flags ]

Deploying a stack

For example, to deploy the stack named patch-doc-test to an environment labeled sit, run the following:

stackql-deploy build \
examples/aws/patch-doc-test \
sit \
-e AWS_REGION=ap-southeast-2 \
--show-queries

Use the --dry-run flag to view the queries to be run without actually running them, for example:

stackql-deploy build \
examples/aws/patch-doc-test \
sit \
-e AWS_REGION=ap-southeast-2 \
--dry-run

Testing a stack

To test a stack to ensure that all resources are present and in the desired state, run the following (in our sit deployment example):

stackql-deploy test \
examples/aws/patch-doc-test \
sit \
-e AWS_REGION=ap-southeast-2

Tearing down a stack

To destroy or deprovision all resources in a stack for our sit deployment example, run the following:

stackql-deploy teardown \
examples/aws/patch-doc-test \
sit \
-e AWS_REGION=ap-southeast-2