From dbc893fbc4adc7eb72f02209fd0ec540ffff134e Mon Sep 17 00:00:00 2001
From: TwinProduction <twin@twinnation.org>
Date: Wed, 11 Nov 2020 16:37:08 -0500
Subject: [PATCH] Improve documentation

---
 README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 77db0790..240258d9 100644
--- a/README.md
+++ b/README.md
@@ -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