extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2024-11-21 23:43:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
TwinProduction 2020-11-11 16:37:08 -05:00
parent 3a0a8db898
commit dbc893fbc4
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -336,7 +336,9 @@ You can exclude certain services from the dashboard by using `kubernetes.exclude
```yaml
kubernetes:
auto-discover: true
cluster-mode: "out"
# out: Gatus is deployed outside of the K8s cluster.
# in: Gatus is deployed in the K8s cluster
cluster-mode: "out"
excluded-service-suffixes:
- canary
service-template:
@ -345,8 +347,14 @@ kubernetes:
- "[STATUS] == 200"
namespaces:
- name: default
# If cluster-mode is out, you should use an externally accessible hostname suffix (e.g.. .example.com)
# This will result in gatus generating services with URLs like <service-name>.example.com
# If cluster-mode is in, you can use either an externally accessible hostname suffix (e.g.. .example.com)
# or an internally accessible hostname suffix (e.g. .default.svc.cluster.local)
hostname-suffix: ".default.svc.cluster.local"
target-path: "/health"
# If some services cannot be or do not need to be monitored, you can exclude them by explicitly defining them
# in the following list.
excluded-services:
- gatus
- kubernetes