2020-05-27 13:06:54 +00:00
#  CloudBender
2019-02-08 10:51:44 +00:00
# About
2021-11-15 12:20:58 +00:00
Toolset to deploy and maintain infrastructure in automated and trackable manner.
First class support for:
- [AWS CloudFormation ](https://aws.amazon.com/cloudformation )
- [Pulumi ](https://www.pulumi.com/docs/ )
2019-02-08 10:51:44 +00:00
# Install
`$ pip install cloudbender`
2021-11-15 17:37:52 +00:00
# State management
## Cloudformation
All state is handled by AWS Cloudformation.
The required account and region are determined by CloudBender automatically from the configuration.
## Pulumi
The state for all Pulumi resources are stored on S3 in your account and in the same region as the resources being deployed.
No data is send to nor shared with the official Pulumi provided APIs.
CloudBender configures Pulumi with a local, temporary workspace on the fly. This incl. the injection of various common parameters like the AWS account ID and region etc.
2019-02-08 10:51:44 +00:00
# CLI
```
Usage: cloudbender [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--debug Turn on debug logging.
--dir TEXT Specify cloudbender project directory.
--help Show this message and exit.
Commands:
clean Deletes all previously rendered files locally
2021-11-15 12:20:58 +00:00
create-change-set Creates a change set for an existing stack - CFN only
2020-06-04 15:48:56 +00:00
create-docs Parses all documentation fragments out of rendered...
2019-02-08 10:51:44 +00:00
delete Deletes stacks or stack groups
2021-11-15 12:20:58 +00:00
get-config Get a config value, decrypted if secret
2020-06-04 15:48:56 +00:00
outputs Prints all stack outputs
2021-11-15 12:20:58 +00:00
preview Preview of Pulumi stack up operation
2019-02-08 10:51:44 +00:00
provision Creates or updates stacks or stack groups
2021-11-15 12:20:58 +00:00
refresh Refreshes Pulumi stack / Drift detection
render Renders template and its parameters - CFN only
set-config Sets a config value, encrypts with stack key if secret
2019-03-20 12:51:17 +00:00
sync Renders template and provisions it right away
2021-11-15 12:20:58 +00:00
validate Validates already rendered templates using cfn-lint...
2019-02-08 10:51:44 +00:00
```
2020-04-08 15:30:58 +00:00
2021-02-12 11:06:43 +00:00
## Config management
- Within the config folder each directory represents either a stack group if it has sub-directories, or an actual Cloudformation stack in case it is a leaf folder.
- The actual configuration for each stack is hierachly merged. Lower level config files overwrite higher-level values. Complex data structures like dictionaries and arrays are deep merged.
2021-11-15 12:20:58 +00:00
## Quickstart
TBD
2020-04-08 15:30:58 +00:00
2021-11-15 12:20:58 +00:00
## Secrets handling
2020-04-08 15:30:58 +00:00
2021-11-15 12:20:58 +00:00
### Pulumi
CloudBender supports the native Pulumi secret handling.
See [Pulumi Docs ](https://www.pulumi.com/docs/intro/concepts/secrets/ ) for details.
### Cloudformation
CloudBender supports [SOPS ](https://github.com/mozilla/sops ) to encrypt values in any config yaml file since version 0.8.1
2020-04-08 15:30:58 +00:00
If a sops encrypted config file is detected CloudBender will automatically try to decrypt the file during execution.
All required information to decrypt has to be present in the embedded sops config or set ahead of time via sops supported ENVIRONMENT variables.
2021-11-15 12:20:58 +00:00
SOPS support can be disabled by setting `DISABLE_SOPS` in order to reduce timeouts etc.
