No project description provided
Project description
AWS Cloud Resource Utils - Library (ACRU-L)
Pronounced Ah-crew-el (ə-kroo͞′l)
An open source framework for collecting and reusing AWS CDK constructs and stacks.
NOTE: This project is currently not stable (alpha releases only) and is subject change at any time. Please use at your own risk.
Usage: ACRU-L Action
This action provisions AWS stacks given an ACRU-L configuration file. The intention is to encapsulate the code needed to provision resources without conflating application code with devops requirements.
The goal is to avoid conflating microservice application code with "infrastructure as code".
Inputs
subcommand
Optional The aws-cdk subcommand to run. Default "deploy -f --require-approval=never"
.
Example usage
uses: quadio-media/acru-l@1.0.0a3
with:
subcommand: deploy -f
env:
AWS_REGION: us-east-1
AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
DEPLOY_ID: ${{ github.sha }}
ACRUL_CONFIG_PATH: "./acru-l.toml"
Configuration
The following settings must be passed as environment variables as shown in the example. Sensitive information, especially AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
, should be set as encrypted secrets — otherwise, they'll be public to anyone browsing your repository's source code and CI logs.
Key | Value | Suggested Type | Required | Default |
---|---|---|---|---|
AWS_ACCOUNT_ID |
Your AWS Account ID. | secret env |
Yes | N/A |
AWS_ACCESS_KEY_ID |
Your AWS Access Key. More info here. | secret env |
Yes | N/A |
AWS_SECRET_ACCESS_KEY |
Your AWS Secret Access Key. More info here. | secret env |
Yes | N/A |
AWS_REGION |
The region you want the VPC Stack to live in. | env |
Yes | N/A |
DEPLOY_ID |
SHA of the commit that triggered the action. | env / github.sha |
Yes | N/A |
ACRUL_CONFIG_PATH |
Path to the ACRU-L configuration file to use. | env |
No | ./acru-l.toml |
License
This project is distributed under the MIT license.
Why?
The problem with infrastructure as code ...
Monorepos... Snowflake code...
Confounding application source code with devops
A strict interface and reuse patterns
Installation
poetry add -D acru-l
pip install acru-l
About
Core Concepts
- Resources - Extended constructs
- Services - Collections of Resources that build a service interface
- Stacks - Collections of Services
Resources
Extended constructs with set defaults
Services
TBD
Stacks
TBD
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file acru-l-1.0.0a3.tar.gz
.
File metadata
- Download URL: acru-l-1.0.0a3.tar.gz
- Upload date:
- Size: 22.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d2ce1970744b56729854098cc872a47c31640866abc0ded6822b891e8676775 |
|
MD5 | ad40a6e3976ab940357ee67f6a2b5923 |
|
BLAKE2b-256 | 19b9e191d08a4a96685147f66ab054bcaaa53ef22cdaf0505a2407d12289cdd3 |
File details
Details for the file acru_l-1.0.0a3-py3-none-any.whl
.
File metadata
- Download URL: acru_l-1.0.0a3-py3-none-any.whl
- Upload date:
- Size: 32.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 371f22a2321e637f4d953bab7cd9e952028cd582a3a7071f8cb29a5e0dd7f343 |
|
MD5 | 9fdac64cd1da94803fa9f516ab093bca |
|
BLAKE2b-256 | 029a8c86e652f55893daaae20aee6067ce7041e798cb1f43365c86dabaed042c |