architect.yml
For users of Visual Studio Code, check out the Architect extension!
Components described using this syntax can leverage the CLI and Kubernetes cluster to provision and update production-grade environments on-demand or via automation.
Configuration options
name
Name of the component that can be resolved by others. Component names must be unique within an Architect account.
description
(optional) A human-readable description of the component. This will be rendered when others view the component so that they know what it should be used for.
keywords
(optional) Additional search terms to be used when the component is indexed so that others can find it more easily.
services
A dictionary of named runtimes for the component. Each service described in an
architect.yml
file will be automatically deployed to your Kubernetes cluster
and registered with your service mesh and API gateway as needed.
Learn more about configuring services
dependencies
A key-value store of components and their respective tags that this component depends on. Dependency referencing and resolution is a key feature of Architect that enables distribute teams to collaborate without having to get into the specifics of how to operate dependencies.
Learn more about configuring dependencies
tasks
A dictionary of named tasks included with the component. Each task described in
an architect.yml
file will run on its specified schedule and/or be made
available as an executable via Architects CLI upon deployment.
Learn more about configuring tasks
secrets
(optional) A dictionary of named, configurable fields for the component. Each secret can include a description so that others know what to assign for values, a default value for when deployers don’t specify one, and an indication as to whether or not a value is required.