Giter Club home page Giter Club logo

cztack's Introduction

CZtack

// bump Cztack (pronounced "stack") is CZI's collection of Terraform modules. We use these as way to scale our infrastructure work.

These modules are compatible with Terraform 0.12 and up.

Contributing

Making a release

Release-please managages all the releases. To make a release, merge the release PR.

Adding a new module

To create a new module, copy the module-template directory and modify as you see fit. And make sure to add the module to the list of modules to test in .github/workflows/ci.yml.

Writing tests

A few notes on writing test for this repo. Note that this is new ground for us, so this will be a work in progress.

  • To make modules testable, all fields that have a unique constraint need to be parameterizeable. Otherwise concurrent tests will conflict.
  • It is tempting in testing module A to use module B to set up some context, but because terraform will just store the statefile locally, you can have a conflict.
    • We've tried to avoid this for now and set up context more directly
    • And also to not run tests in parrallel
    • and to clean up state files before and after each run
  • our linter requires a test for each module. At the very least run init so that its syntax is checked. See an example here.
  • AWS IAM is eventually consistent and supposedly is homed in us-east-1, so its probably best to run all tests that use IAM in that region.

Test Dependencies

cztack's People

Contributors

ryanking avatar mbarrien avatar dependabot[bot] avatar czi-github-helper[bot] avatar kuannie1 avatar jakeyheath avatar jayengee avatar jgadling avatar dingying0410 avatar alldoami avatar alexlokshin-czi avatar jjb007 avatar dependabot-preview[bot] avatar abiju-czi avatar chauvm avatar dtsai-czi avatar alexsmaliy-czi avatar netvisao avatar oliviabholmes avatar huzefa avatar salmacodes avatar katyho avatar chrisgoffinet avatar tapanr avatar srm78 avatar cziprodsec avatar czimergebot avatar bento007 avatar yiouzuo avatar lamroger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.