Skip to content

Configuration schema

Zbigniew Kostrzewa edited this page Jan 4, 2019 · 13 revisions

General schema

server:
  listen_on: HOST(string){:PORT(int)}

checks:
  CHECK_NAME:
    type: http|dial|command|swarm
    options(string -> any)

Options

  • http

    url: URL(string)

  • dial

    protocol: tcp|udp [tcp]
    address: HOST(string){:PORT(int)}
    timeout: TIMEOUT(time_duration_string) [10s]
  • command
    command: echo "free form run through shell"
    command:
      - echo
      - "exec form"
    shell: bash [sh]
    Host: HOST(string){:PORT(int)}|UNIX_SOCKET_PATH(string) [unix:///var/run/docker.sock]
    Version: API_VERSION(string) [auto]
    Services: LIST_OF_SERVICE_NAMES(list[string]) [all services]
    MinReplicas: MIN_NUM_OF_RUNNING_REPLICAS(int) [all replicas must be running]

Examples

server:
  listen_on: 127.0.0.1:8199

checks:
  google:
    type: http
    url: http://google.com
  rabbit:
    type: dial
    address: 127.0.0.1:5672
    timeout: 5s
  echo:
    command: echo "hello world!"
Clone this wiki locally