Skip to main content

No project description provided

Project description

AWS Cloud Resource Utils - Library (ACRU-L)

codecov Code style: black Build

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

- user: actions/setup-python@v2
  with:
  python-version: 3.8
- uses: actions/setup-node@v2
  with:
  node-version: 12
- uses: quadio-media/acru-l@1.0.0a5
  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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acru-l-1.0.0a5.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

acru_l-1.0.0a5-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file acru-l-1.0.0a5.tar.gz.

File metadata

  • Download URL: acru-l-1.0.0a5.tar.gz
  • Upload date:
  • Size: 22.9 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

Hashes for acru-l-1.0.0a5.tar.gz
Algorithm Hash digest
SHA256 789ba29ac133d96448ba253cbcc14aabc557071c0d8ea3b524dc0b3404cb0cb7
MD5 a2ba1d6502e10a93df7e8d512bcc396a
BLAKE2b-256 7aa4944acf78054e692d3b61fb37f12f838111a4a84fb980cd4ca7a164e6eb06

See more details on using hashes here.

File details

Details for the file acru_l-1.0.0a5-py3-none-any.whl.

File metadata

  • Download URL: acru_l-1.0.0a5-py3-none-any.whl
  • Upload date:
  • Size: 33.0 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

Hashes for acru_l-1.0.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 e24ccb5a6ca996072c922ab4fe7c97eb8f1510cdd700fbc2aa9d66c34e2ea2e6
MD5 f015567c8962cd8ff9d8411ce03a9ccd
BLAKE2b-256 e875e4f2392c0732a6d83d550634880218ca6bfbc2bb3774240d9cc3d8f33789

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page