Giter Site home page Giter Site logo

acorn-library's Introduction

Acorn Library

This repository houses all of the Acorn library image definitions.

Style / Guidelines for library acorns

  1. Use official images from the Docker library if available.

  2. Use specific version tags of images, at least to the minor in semver.

  3. Use automatically generated secrets, and allow the user to specify values if needed.

  4. Prefer to handle the application in cuelang vs. string interpolations.

  5. Do not use master - slave terminology. Use terms like leader / follower, worker / agents, replicas, etc.

  6. When adding parameters:

    1. Use scale to represent number of containers running of the exact same config.
    2. Use replicas to represent multiple instances with the same role.
  7. Create a secret "user-secret-data": type: "opaque" to allow users to bind in secret data for use inside the acorn.

  8. For consistency and readability create Acorn cue with top level keys in the following order:

    1. args
    2. containers
    3. jobs
    4. volumes
    5. acorns
    6. secrets
    7. localData
  9. If you are using if blocks to deploy an optional component, the if block should add/modify keys in the overall acorn key order.

  10. When merging user provided structs with default structs, place the user provided struct variable first. args.deploy.userData & {...acorn defined data}.

acorn-library's People

Contributors

cloudnautique avatar ibuildthecloud 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.