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}.

Tagging and publishing images

In this repo, images are built and published based on git tags. The tag contains information about the image to publish and the version to give it. Here are the guidelines for tagging to publish an image:

• The tag must be of the form: <image name>/<version>
• The image name portion must map to a directory name in the repo
• The version portion will be used as the image version. As such, it must conform to image tag restrictions. For example, it cannot contain a + symbol
• The version portion must start with v and be followed by a number