4f317b8499
Validate the Kamal configuration giving useful warning on errors. Each section of the configuration has its own config class and a YAML file containing documented example configuration. You can run `kamal docs` to see the example configuration, and `kamal docs <section>` to see the example configuration for a specific section. The validation matches the configuration to the example configuration checking that there are no unknown keys and that the values are of matching types. Where there is more complex validation - e.g for envs and servers, we have custom validators that implement those rules. Additonally the configuration examples are used to generate the configuration documentation in the kamal-site repo. You generate them by running: ``` bundle exec bin/docs <kamal-site-checkout> ```
50 lines
1.8 KiB
YAML
50 lines
1.8 KiB
YAML
# Registry
|
||
#
|
||
# The default registry is Docker Hub, but you can change it using registry/server:
|
||
#
|
||
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
|
||
# in the local environment.
|
||
|
||
registry:
|
||
server: registry.digitalocean.com
|
||
username:
|
||
- DOCKER_REGISTRY_TOKEN
|
||
password:
|
||
- DOCKER_REGISTRY_TOKEN
|
||
|
||
# Using AWS ECR as the container registry
|
||
# You will need to have the aws CLI installed locally for this to work.
|
||
# AWS ECR’s access token is only valid for 12hrs. In order to not have to manually regenerate the token every time, you can use ERB in the deploy.yml file to shell out to the aws cli command, and obtain the token:
|
||
|
||
registry:
|
||
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
||
username: AWS
|
||
password: <%= %x(aws ecr get-login-password) %>
|
||
|
||
# Using GCP Artifact Registry as the container registry
|
||
# To sign into Artifact Registry, you would need to
|
||
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
||
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
||
# Normally, assigning a roles/artifactregistry.writer role should be sufficient.
|
||
#
|
||
# Once the service account is ready, you need to generate and download a JSON key, base64 encode it and add to .env:
|
||
#
|
||
# ```shell
|
||
# echo "KAMAL_REGISTRY_PASSWORD=$(base64 -i /path/to/key.json)" | tr -d "\\n" >> .env
|
||
# ```
|
||
# Use the env variable as password along with _json_key_base64 as username.
|
||
# Here’s the final configuration:
|
||
|
||
registry:
|
||
server: <your registry region>-docker.pkg.dev
|
||
username: _json_key_base64
|
||
password:
|
||
- KAMAL_REGISTRY_PASSWORD
|
||
|
||
# Validating the configuration
|
||
#
|
||
# You can validate the configuration by running:
|
||
# ```shell
|
||
# kamal registry login
|
||
# ```
|