From ea37a0739beb865308845de1432108c89b2a15de Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Thu, 24 Jun 2021 15:08:03 -0400
Subject: [PATCH] Document the domain parameter

---
 morph/lib/customize-issuer.nix     | 7 +++++++
 morph/lib/customize-monitoring.nix | 3 +--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/morph/lib/customize-issuer.nix b/morph/lib/customize-issuer.nix
index 94599313..28edb72e 100644
--- a/morph/lib/customize-issuer.nix
+++ b/morph/lib/customize-issuer.nix
@@ -26,6 +26,13 @@
   # A string giving the VPN IPv4 address for this system.
 , monitoringvpnIPv4
 
+  # A string giving the domain name associated with this grid.  This is meant
+  # to be combined with the hostname for this system to produce a
+  # fully-qualified domain name.  For example, an issuer might have "payments"
+  # as its hostname and belong to a grid with the domain
+  # "example-grid.invalid".  This ``domain`` parameter should have the value
+  # ``"example-grid.invalid"`` for the system figure out that
+  # ``payments.example-grid.invalid`` is the name of this system.
 , domain
 
   # A set mapping usernames as strings to SSH public keys as strings.  For
diff --git a/morph/lib/customize-monitoring.nix b/morph/lib/customize-monitoring.nix
index 75f668a7..c50eb506 100644
--- a/morph/lib/customize-monitoring.nix
+++ b/morph/lib/customize-monitoring.nix
@@ -8,11 +8,10 @@
   # allows Grafana to show us hostnames instead of VPN IP addresses.
   hostsMap
 
-, domain
-
   # See ``customize-issuer.nix``.
 , monitoringvpnKeyDir
 , monitoringvpnIPv4
+, domain
 
   # A list of VPN IP addresses as strings indicating which clients will be
   # allowed onto the VPN.
-- 
GitLab