From 66347e28e5025bfb1aa4f03e26d1547529296177 Mon Sep 17 00:00:00 2001
From: Maarten de Waard <maarten@greenhost.nl>
Date: Tue, 28 Sep 2021 14:34:25 +0200
Subject: [PATCH] add brief explanation to .flux.env.example

---
 docs/installation/install_oas.rst | 2 +-
 install/.flux.env.example         | 4 ++++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/installation/install_oas.rst b/docs/installation/install_oas.rst
index 956eb929a..34802fccc 100644
--- a/docs/installation/install_oas.rst
+++ b/docs/installation/install_oas.rst
@@ -58,7 +58,7 @@ Prerequisites
 Copy the file ``install/.flux.env.example`` to your cluster dir
 ``clusters/oas.example.org/.flux.env``. This file contains the last bit of
 information you need to configure. You **have to** configure the following
-values. The rest are optional. 
+values. The rest are optional.
 
 - ``ip_address``: The IP address of your cluster
 - ``domain``: The FQDN of your cluster
diff --git a/install/.flux.env.example b/install/.flux.env.example
index a52a4079a..d67c951cc 100755
--- a/install/.flux.env.example
+++ b/install/.flux.env.example
@@ -1,3 +1,7 @@
+# This file contains variables that will be used in Kubernetes manifests.
+# Replace the values to make sense for your setup. The values should not be
+# quoted (correct: a=b, incorrect: a="b").
+
 # IP address of the cluster
 ip_address=1.2.3.4
 # FQDN of the cluster
-- 
GitLab