Health Check

A health_check stanza allows the definition of a health check which must pass before the container is marked as successfully created. There are three different types of healthcheck http, tcp, and exec, these are not mutually exclusive, it is possible to define more than one health check.

Health checks are executed sequentially, if one health check fails, the following checks are not executed. The execution order is http, tcp, exec.

Attributes

Attributes are the properties of a resource that can be used to configure it.

Attribute	Description
Timeout timeout required string	The maximum duration to wait before marking the health check as failed. Expressed as a Go duration, e.g. `1s` = 1 second, `100ms` = 100 milliseconds.
HTTP http required []block HealthCheckHTTP	HTTP Health Check block defining the address to check and expected status codes. Can be specified more than once.
TCP tcp required []block HealthCheckTCP	TCP Health Check block defining the address to test. Can be specified more than once.
Exec exec required []block HealthCheckExec	Exec Health Check block defining either a command to run in the current container, or a script to execute. Can be specified more than once.

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefor only known at parsetime or runtime.

Attribute	Description
Meta ID meta.id string	The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path: resource "type" "name" { ... }
Meta Type meta.type string	The type of the resource. This taken from the type label of the resource definition. resource "type" "name" { ... }
Meta Name meta.name string	The name of the resource. This taken from the name label of the resource definition. resource "type" "name" { ... }

Examples

health_check {
    timeout = "30s"
    http {
      address = "http://localhost:8500/v1/status/leader"
      success_codes = [200]
    }

    http {
      address = "http://localhost:8500/v1"
      success_codes = [200]
    }

    tcp {
      address = "localhost:8500"
    }

   exec {
      script = <<-EOF
        #!/bin/bash

        curl "http://localhost:9090"
      EOF
    }
  }