This repository has been archived by the owner on Mar 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Move acorn file example to docs. * reshuffled and added content
- Loading branch information
1 parent
cbbab06
commit 05d7179
Showing
12 changed files
with
106 additions
and
313 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,245 +1,14 @@ | ||
| ### WARNING: Consuming this project can expose you to chemicals, which are known to the State of California to cause cancer and birth defects or other reproductive harm. | ||
| ### WARNING: Consuming this project can expose you to chemicals, which are known to the State of California to cause cancer and birth defects or other reproductive harm | ||
|
|
||
| [](https://github.com/acorn-io/acorn/actions/workflows/main-release.yaml) [macOS](https://cdn.acrn.io/cli/default_darwin_amd64_v1/acorn)/[Linux](https://cdn.acrn.io/cli/default_linux_amd64_v1/acorn)/[Windows](https://cdn.acrn.io/cli/default_windows_amd64_v1/acorn.exe) | ||
|
|
||
| ### Quick Start | ||
| Please see [the Quick Start documentation](docs/docs/20-quickstart.md) | ||
| ### Quick Start | ||
|
|
||
| ### Reference acorn.cue file | ||
| ```cue | ||
| // The acorn file is a cue syntax. CUE is a superset of JSON, so all valid JSON is CUE. In CUE you don't | ||
| // need to quote most keys, comments using // are supported, and trailing commas are optional. | ||
| See [the Quick Start documentation](https://docs.acorn.io/quickstart) | ||
|
|
||
| // Definitions of containers to run. The key of will be used as the container name and must be a valid | ||
| // short DNS name. The container(s) will be accesible through DNS by this short name. The keys have to be | ||
| // unique across containers, jobs, cronjobs, and routers. | ||
| containers: { | ||
| // A definition of a container to run. The scale field below will determine how many containers from this | ||
| // one definition. At runtime each container will have a unique hostname. | ||
| sample: { | ||
| // The Docker/OCI image to run for this container. Either image or build must be specified | ||
| image: "some-docker/image:v1.0.0" | ||
| ### Docs and getting started | ||
|
|
||
| // Build the image to run from a Dockerfile. This can either be a path to where the Dockerfile | ||
| // for example: | ||
| // | ||
| // build: "./image" | ||
| // | ||
| // The above will is the same as {dockerfile: "./image/Dockerfile", context: "./image"} | ||
| // is or full build definition like below. | ||
| build: { | ||
| // Build arguments to pass to the Docker build. | ||
| buildArgs: { | ||
| param1: "value" | ||
| } | ||
| // The context root of the Docker build relative to the root of the acorn build | ||
| context: "./subdir" | ||
| // Location of the Dockerfile to use relative to the root of the acorn build, not the context path | ||
| dockerfile: "./subdir/otherdir/Dockerfile" | ||
| // The multi-stage build target to build in the Dockerfile | ||
| target: string | *"" | ||
| } | ||
| Using Acorns [docs](https://docs.acorn.io/Running%20Acorns) | ||
| Authoring Acorns [docs](https://docs.acorn.io/Acornfile/overview) | ||
|
|
||
| // Override the ENTRYPOINT defined in the Dockerfile | ||
| entrypoint: ["echo", "hello", "world"] | ||
| // Override the CMD defined in the Dockerfile | ||
| cmd: ["echo", "hello", "world"] | ||
| // Environment variables to set on the running process | ||
| env: { | ||
| VAR1: "value" | ||
| VAR2: "value" | ||
| } | ||
| // Override the WORKDIR defined in the Dockerfile | ||
| workDir: "/tmp" | ||
| // Allocate a TTY | ||
| interactive: false | ||
| // Ports to open to other containers in the existing app (no publically accesible) | ||
| // Ports are of the format "[EXTERNAL:]INTERNAL[/PROTOCOL]". Acceptable protocols | ||
| // are tcp, udp, http, https | ||
| ports: [ | ||
| // TCP port 22 | ||
| 22, | ||
| // TCP port 2222 externally accessible as port 22 | ||
| "22:2222", | ||
| // HTTP port 80 | ||
| "80/http", | ||
| // UDP port 1234 | ||
| "1234/udp", | ||
| ] | ||
| // Expose these ports out side of the acorn (possibly public) and internally. The format is the same as "ports" | ||
| expose: [ | ||
| 22, | ||
| "22:2222", | ||
| "80/http", | ||
| "1234/udp", | ||
| ] | ||
| // Files to inject into the running container. The key must be the path of the file to create. The value | ||
| // is any arbitrary string or bytes. Secrets values can be injected into files using the syntax | ||
| // "secret://secret-name/data-key" | ||
| files: { | ||
| // Sample of a string value | ||
| "/var/lib/www/index.html": "<h1>Hello World</h1>" | ||
| // Sample of a byte value | ||
| "/var/lib/www/1px.png": | ||
| '\x89\x50\x4e\x47\x0d\x0a\x1a\x0a\x00\x00\x00\x0d' + | ||
| '\x49\x48\x44\x52\x00\x00\x00\x01\x00\x00\x00\x01' + | ||
| '\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00' + | ||
| '\x0d\x49\x44\x41\x54\x08\x5b\x63\x48\xde\xda\xf5' + | ||
| '\x1f\x00\x05\xc3\x02\xa2\x30\x41\xf9\xda\x00\x00' + | ||
| '\x00\x00\x49\x45\x4e\x44\xae\x42\x60\x82' | ||
| // Sample of a secret using the format "secret://secret-name/data-key" | ||
| "/run/secret/password": "secret://sample-user/password" | ||
| } | ||
| // Mount a volume, secrets, or ephemeral storage a directory or secrets. | ||
| // Secrets are referenced by the value "secret://secret-name". The secret data will become files | ||
| // named the same as the keys. | ||
| // Volumes are reference by "volume://name?class=className&size=10" where size is in gigabytes. | ||
| dirs: { | ||
| // Mount volume named "my-data" | ||
| "/var/lib/data": "my-data" | ||
| // Mount volume named "my-data" using storage class "local" of size 30G | ||
| "/var/lib/data2": "volume://my-data?class=local&size=30" | ||
| // Mount anonymous ephemeral storage | ||
| "/var/lib/data3": "ephemeral://" | ||
| // Mount named ephemeral storage. Named ephemeral storage can be used to share data between sidecars | ||
| "/var/lib/data4": "ephemeral://my-eph" | ||
| // Mount the secret named secret-name | ||
| "/var/lib/data4": "secret://secret-name" | ||
| } | ||
| // Sidecars are containers that run colocated with the parent container and share the | ||
| // same network and PID namespace. | ||
| sidecars: { | ||
| "sample-sidecar": { | ||
| // All of the same fields of containers are supported here | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // Jobs are containers that will run at least once to completion and then not executed | ||
| // again. | ||
| jobs: { | ||
| "sample-job": { | ||
| // All of the same fields of containers are supported here | ||
| } | ||
| } | ||
| // Volumes hold persistent data that can be mounted into containers | ||
| volumes: { | ||
| "vol1": { | ||
| // size of the requested volume in gigabytes | ||
| size: 50 | ||
| // Valid access modes are "readWriteMany", "readWriteOnce", "readOnlyMany", "readWriteOncePod" | ||
| accessModes: ["readWriteOnce"] | ||
| } | ||
| } | ||
| secrets: { | ||
| "generated-basic-auth": { | ||
| // Represents a standard basic auth of username/password | ||
| type: "basic" | ||
| data: { | ||
| // If not set a username will be generated | ||
| username: string | ||
| // If not set a password will be generated | ||
| password: string | ||
| } | ||
| } | ||
| "generated-tls": { | ||
| type: "tls" | ||
| params: { | ||
| algorithm: "rsa" | *"ecdsa" | ||
| caSecret?: string | ||
| usage: *"server" | "client" | ||
| commonName?: string | ||
| organization: [...string] | ||
| sans: [...string] | ||
| durationDays: int | *365 | ||
| } | ||
| data: { | ||
| "tls.crt"?: (string | bytes) | ||
| "tls.key"?: (string | bytes) | ||
| "ca.crt"?: (string | bytes) | ||
| "ca.key"?: (string | bytes) | ||
| } | ||
| } | ||
| "generated-from-job": { | ||
| type: "generated" | ||
| params: { | ||
| job: string | ||
| format: *"text" | "json" | ||
| } | ||
| } | ||
| "generated-from-template": { | ||
| type: "template" | ||
| data: { | ||
| // Other secrets can be referenced using the syntax ${secret://secret-name/key} | ||
| template: string | ||
| } | ||
| } | ||
| "generated-token": { | ||
| type: "token" | ||
| params: { | ||
| characters: string | *"bcdfghjklmnpqrstvwxz2456789" | ||
| length: (>=0 & <=256) | *54 | ||
| } | ||
| data: { | ||
| token?: string | ||
| } | ||
| } | ||
| "pull-secret": { | ||
| // Pull secrets are expected to be in this format | ||
| type: "docker" | ||
| data: { | ||
| // Contents of ~/.docker/config.json | ||
| ".dockerconfigjson": "..." | ||
| } | ||
| } | ||
| } | ||
| // Schema of parameters to impact behavior at build or deploy time | ||
| args: { | ||
| build: { | ||
| "some-string": string | *"default value" | ||
| "some-int": int | *5 | ||
| "some-complex": { | ||
| key?: { | ||
| key: string | ||
| } | ||
| } | ||
| } | ||
| deploy: { | ||
| "some-string": string | *"default value" | ||
| "some-int": int | *5 | ||
| "some-complex": { | ||
| key?: { | ||
| key: string | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // Arbitrary information that the acorn file author can embed so that if can be | ||
| // referenced somewhere else in the file. This is used mostly as a way to organize or better | ||
| // format your acorn file | ||
| localData: { | ||
| key: "value" | ||
| complex: { | ||
| key: "value" | ||
| } | ||
| } | ||
| ``` | ||
| See the reference docs for full example of the [Acorn file](https://docs.acorn.io/Reference/acorn.cue) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.