forge.yaml
The forge.yaml file contains the global Forge configuration information. Currently this consists of Docker Registry configuration and credentials. A forge.yaml is automatically created as part of the forge setup process; it can also be created by hand.
| Field | Type | Docs |
|---|---|---|
| search-path | sequence[string] | Search path for service dependencies. |
| registry | (registry:docker|registry:gcr|registry:ecr|registry:local) | |
| docker-repo | string | Deprecated, use registry instead. |
| user | string | Deprecated, use registry instead. |
| password | base64 | Deprecated, use registry instead. |
| workdir | string | deprecated |
| profiles | map[profile] | A map keyed by profile-name of profile-specific settings. |
| concurrency | integer | This controls the maximum number of parallel builds. |
registry:docker
A generic Docker registry.
| Field | Type | Docs |
|---|---|---|
| type | 'docker' | This must be 'docker' for docker registries |
| url | string | The url of the docker registry. |
| verify | boolean | A boolean that indicates whether or not to verify the SSL connection to the registry. This defaults to true. Set this to false if you are using a registry with self-signed certs. |
| user | string | The docker user. |
| password | base64 | The docker password, base64 encoded. |
| namespace | string | The namespace for the docker registry. For docker hub this is a
user or an organization. This is used as the first path component
of the registry URL, for example:
registry.hub.docker.com/ |
registry:gcr
A Google Cloud registry.
| Field | Type | Docs |
|---|---|---|
| type | 'gcr' | The type of the registry; this will be 'gcr' for Google registries |
| url | string | The url of the registry, e.g. `gcr.io`. |
| project | string | The Google project name. |
| key | base64 | The base64 encoded JSON key used for authentication. |
registry:ecr
An Amazon ECR registry.
| Field | Type | Docs |
|---|---|---|
| type | 'ecr' | The type of the registry; this will be 'ecr' for amazon registries |
| account | string | The amazon account id to use. |
| region | string | The Amazon region to use. |
| aws_access_key_id | string | The id of the AWS access key to use. |
| aws_secret_access_key | string | The AWS secret access key. |
registry:local
A local registry.
| Field | Type | Docs |
|---|---|---|
| type | 'local' | The type of the registry; this will be 'local' for local registries |
profile
Profile-specific settings.
| Field | Type | Docs |
|---|---|---|
| search-path | sequence[string] | Search path for service dependencies. |
| registry | (registry:docker|registry:gcr|registry:ecr|registry:local) |