Sha256: bb19af822b8f596d0b79607521f6b20029ae7477a37bf9b3e2f4137c206eddfe

Contents?: true

Size: 1.89 KB

Versions: 12

Compression:

Stored size: 1.89 KB

Contents

# Healthcheck configuration
#
# On roles that are running Traefik, Kamal will supply a default healthcheck to `docker run`.
# For other roles, by default no healthcheck is supplied.
#
# If no healthcheck is supplied and the image does not define one, they we wait for the container
# to reach a running state and then pause for the readiness delay.
#
# The default healthcheck is `curl -f http://localhost:<port>/<path>`, so it assumes that `curl`
# is available within the container.

# Healthcheck options
#
# These go under the `healthcheck` key in the root or role configuration.
healthcheck:

  # Command
  #
  # The command to run, defaults to `curl -f http://localhost:<port>/<path>` on roles running Traefik
  cmd: "curl -f http://localhost"

  # Interval
  #
  # The Docker healthcheck interval, defaults to `1s`
  interval: 10s

  # Max attempts
  #
  # The maximum number of times we poll the container to see if it is healthy, defaults to `7`
  # Each check is separated by an increasing interval starting with 1 second.
  max_attempts: 3

  # Port
  #
  # The port to use in the healthcheck, defaults to `3000`
  port: "80"

  # Path
  #
  # The path to use in the healthcheck, defaults to `/up`
  path: /health

  # Cords for zero-downtime deployments
  #
  # The cord file is used for zero-downtime deployments. The healthcheck is augmented with a check
  # for the existance of the file. This allows us to delete the file and force the container to
  # become unhealthy, causing Traefik to stop routing traffic to it.
  #
  # Kamal mounts a volume at this location and creates the file before starting the container.
  # You can set the value to `false` to disable the cord file, but this loses the zero-downtime
  # guarantee.
  #
  # The default value is `/tmp/kamal-cord`
  cord: /cord

  # Log lines
  #
  # Number of lines to log from the container when the healthcheck fails, defaults to `50`
  log_lines: 100

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
kamal-1.9.2 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.9.1 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.9.0 lib/kamal/configuration/docs/healthcheck.yml
kamal-2.0.0.alpha lib/kamal/configuration/docs/healthcheck.yml
kamal-1.8.3 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.8.2 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.8.1 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.8.0 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.7.3 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.7.2 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.7.1 lib/kamal/configuration/docs/healthcheck.yml
kamal-1.7.0 lib/kamal/configuration/docs/healthcheck.yml