README
¶
Celerity CLI
The CLI for managing Celerity applications and blueprints used more generally for Infrastructure as Code.
The CLI provides the following main features:
- Initialise projects: Create a new Celerity application or blueprint project from a template.
- Validate blueprints: Validate a Celerity blueprint, ensuring the blueprint is well-formed and meets the requirements of resource providers.
- Build applications: Build a Celerity application.
- Deploy projects: Deploy a Celerity application to a target environment or deploy standalone blueprints used for Infrastructure as Code.
- Manage plugins: Install, update, and remove Provider and Transformer plugins for the Deploy Engine running on the same machine as the CLI.
Additional documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
Package buildmanifest defines the on-disk build manifest produced by the Celerity CLI build step and consumed by the Celerity transformer plugin when producing concrete deploy resources (e.g.
|
Package buildmanifest defines the on-disk build manifest produced by the Celerity CLI build step and consumed by the Celerity transformer plugin when producing concrete deploy resources (e.g. |
|
maintenance-runner
command
Command maintenance-runner is the in-network half of Celerity's database maintenance path.
|
Command maintenance-runner is the in-network half of Celerity's database maintenance path. |
|
internal
|
|
|
build
Package build provides application build and packaging logic for Celerity application deployments.
|
Package build provides application build and packaging logic for Celerity application deployments. |
|
dbconn
Package dbconn turns an endpoint plus a resolved credential into a connection string for a SQL engine.
|
Package dbconn turns an endpoint plus a resolved credential into a connection string for a SQL engine. |
|
dbconn/awscreds
Package awscreds resolves database credentials on AWS: Secrets Manager for stored credentials, RDS IAM for short-lived tokens.
|
Package awscreds resolves database credentials on AWS: Secrets Manager for stored credentials, RDS IAM for short-lived tokens. |
|
deployconfig
Package deployconfig handles reading Celerity app deploy configuration and converting it to the Bluelink deploy configuration format.
|
Package deployconfig handles reading Celerity app deploy configuration and converting it to the Bluelink deploy configuration format. |
|
deploydb
Package deploydb resolves a database connection from a deployed blueprint instance's state so the CLI can run schema migrations against a deployed environment.
|
Package deploydb resolves a database connection from a deployed blueprint instance's state so the CLI can run schema migrations against a deployed environment. |
|
devconfig/resolve
Package resolve provides pure path-resolution and config-parsing helpers extracted from devconfig so they can be unit-tested without side effects.
|
Package resolve provides pure path-resolution and config-parsing helpers extracted from devconfig so they can be unit-tested without side effects. |
|
devtest/detect
Package detect provides pure detection and command-building logic for test runners, extracted so it can be unit-tested without executing shell commands.
|
Package detect provides pure detection and command-building logic for test runners, extracted so it can be unit-tested without executing shell commands. |
|
engine
Package engine gives the CLI its deploy engine client.
|
Package engine gives the CLI its deploy engine client. |
|
handlerresolve
Package handlerresolve is the shared extract + merge + collect pipeline used by both the dev and build commands so handler discovery behaves identically across them.
|
Package handlerresolve is the shared extract + merge + collect pipeline used by both the dev and build commands so handler discovery behaves identically across them. |
|
handlertoolchain
Package handlertoolchain resolves and drives the build tooling for an OS-only runtime.
|
Package handlertoolchain resolves and drives the build tooling for an OS-only runtime. |
|
maintenancerunner
Package maintenancerunner defines the contract between the Celerity CLI and the maintenance runner, and implements the runner side of it.
|
Package maintenancerunner defines the contract between the Celerity CLI and the maintenance runner, and implements the runner side of it. |
|
maintenancerunner/awsrunner
Package awsrunner hosts and invokes the Celerity maintenance runner on AWS.
|
Package awsrunner hosts and invokes the Celerity maintenance runner on AWS. |
|
seed/dynamoconv
Package dynamoconv provides pure conversion functions between Go types and DynamoDB attribute values.
|
Package dynamoconv provides pure conversion functions between Go types and DynamoDB attribute values. |
Click to show internal directories.
Click to hide internal directories.