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.

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

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-action@v0.1.4
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.

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.0a0.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

acru_l-1.0.0a0-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: acru-l-1.0.0a0.tar.gz
  • Upload date:
  • Size: 22.5 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.0a0.tar.gz
Algorithm Hash digest
SHA256 f4fed072b22302c7d6c172e86756d983746ea8b5822c2750de728e5504b7fc97
MD5 ff92af65f9bee9989f0d10395bac113c
BLAKE2b-256 b375e79237f71825bc7ef493aa80e052c4e28c21f25ccfc786ed26e86474b143

See more details on using hashes here.

File details

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

File metadata

  • Download URL: acru_l-1.0.0a0-py3-none-any.whl
  • Upload date:
  • Size: 32.3 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.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 356e7e21411c793c97621692f64a42f3544fbe71ee7a5aac85a191d0e4d79644
MD5 4c7c6061f6355a4a0ab428dae2c5643b
BLAKE2b-256 93148a3057bab94b61a4aea1c662308abb0a78a311008f5030976b08dd16a877

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