-
Notifications
You must be signed in to change notification settings - Fork 0
help settings
Coach is primarily configured by the inclusion of a .coach folder into a project. Inside this folder are a number of configuration files that coach recognizes, and parses to read the project settings.
Most of the configuration files are parsed as YAML.
This file is a YAML file that configures project level settings such as the name of the project.
- Project : project name, often used in generation of image and container names
- Tokens : an optional map of tokens, which can be used for substitution in other configuration files.
This YAML file lists a map of nodes, each node corresponding to a set of containers based on a single build/image.
A map of tokens, which can also be used for substitution in further config files. This file is kept separate so that the entire secrets folder is easily targeted for ignores in git.
The purpose of this file is to centralize sensitive, or user specific information for a project, which should not be shared as a part of a project configuration.
If a ~/.coach folder exists, it can be used to provide settings and tokens that can be shared across all projects.
A user level secrets file functions that same as the project secrets file, but keeps secrets across all projects for a user. The user secrets files is parsed before the project file, so project secrets take precendence over user secrets.
If a templates folder exists, it can container subfolders that can be used as init templates using the syntax:
$/> coach init user {template}
In this case, the matching template subfolder contents would be copied into the current folder in order to create a new project.