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> ```
24 lines
785 B
YAML
24 lines
785 B
YAML
# SSHKit
|
|
#
|
|
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
|
#
|
|
# The default settings should be sufficient for most use cases, but
|
|
# when connecting to a large number of hosts you may need to adjust
|
|
|
|
# SSHKit options
|
|
#
|
|
# The options are specified under the sshkit key in the configuration file.
|
|
sshkit:
|
|
|
|
# Max concurrent starts
|
|
#
|
|
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
|
# By default Kamal will limit concurrent connection starts to 30 at a time.
|
|
max_concurrent_starts: 10
|
|
|
|
# Pool idle timeout
|
|
#
|
|
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
|
# re-connection storms after an idle period, like building an image or waiting for CI.
|
|
pool_idle_timeout: 300
|