saltyorg / docs

GNU General Public License v3.0
59 stars 78 forks source link

Document Optional Role Healthchecks #158

Closed owine closed 1 year ago

owine commented 1 year ago

Since we've removed the manual healthcheck from the Sandbox repo, we need to create a docs page with sample healthchecks for various roles that a user can add via inventories. The below were the ones previously included and subsequently removed from Sandbox.

aria2_ng_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:8080"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

docspell_docker_healthcheck:
  test: ["CMD", "wget", "--spider", "http://localhost:{{ docspell_web_port }}/api/info/version"]
  interval: 1m
  timeout: 10s
  retries: 2
  start_period: 30s

duplicati_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ duplicati_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

elasticsearch_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:9200"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

gaps_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:8484"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

heimdall_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:80"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

homeassistant_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ homeassistant_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

koel_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

lunasea_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

omegabrr_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ omegabrr_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

phpmyadmin_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ phpmyadmin_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

plexshare_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ plexshare_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

reposilite_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ reposilite_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

rflood_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:3000"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

solr_docker_healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:{{ solr_docker_env_port }}/solr/{{ solr_docker_env_core_name }}/admin/ping"]
  interval: 1m
  timeout: 10s
  retries: 5
  start_period: 30s

tubearchivist_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ tubearchivist_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

tvheadend_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ tvheadend_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

wikijs_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:3000"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s
owine commented 1 year ago

One from Saltbox as well:

postgres_docker_healthcheck:
  test: ["CMD-SHELL", "pg_isready", "-d", "{{ postgres_docker_env_db }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s