Cycle Stack File

A Cycle.io stack file for environments as code

Type object
File match cycle.json cycle.yml cycle.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/cycle-stack-file/latest.json
Source https://raw.githubusercontent.com/cycleplatform/api-spec/main/stackspec/stackspec.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A Cycle stack file is an "environment as code". This allows an environment to be generated consistently based on a fixed specification. Stack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.

Properties

version string required

The version of the Cycle stack file used.

Values: "1.0"
containers object | 1 required
about object | null | string
scoped_variables array | null | 1

Describes variables that are assigned to one or more containers at runtime. Can be assigned as an environment variable, written as a file inside the container(s), or accessed over the internal API.

monitoring object | 1

Monitoring options for containers within this stack.

services object | null | 1

Settings for any auxillary services deployed as part of the environment, such as load balancer and discovery services.

annotations object | 1

Additional meta info about the stack.