From: Peter Palfrader <peter@palfrader.org>
Date: Tue, 10 Sep 2019 19:58:33 +0000 (+0200)
Subject: Document static-components.yaml
X-Git-Url: https://git.adam-barratt.org.uk/?a=commitdiff_plain;h=9c0a07c52dc8a2cfdbc7bef88f419a12f25cecd8;p=mirror%2Fdsa-puppet.git

Document static-components.yaml
---

diff --git a/modules/roles/misc/static-components.yaml b/modules/roles/misc/static-components.yaml
index 080a65a4d..78bf0317d 100644
--- a/modules/roles/misc/static-components.yaml
+++ b/modules/roles/misc/static-components.yaml
@@ -1,5 +1,21 @@
 --- 
 
+# By default, each component is put onto every static node.
+#
+# However, exceptions are caused as follows:
+#   - Individual mirrors can set a 'components-include' list.
+#       A mirror that has a components-include list will mirror
+#       exactly those components.
+#   - Individual components can exclude themselves from
+#       being pushed to individual mirrors by setting
+#       an 'exclude-mirrors' list.
+#   - Alternatively, individual components can provide a
+#       whitelist of mirrors ('limit-mirrors') that they should
+#       be synced to, thus excluding all others.
+#
+# A mirrorrun for a component can only be triggered by its source
+# host and any hosts listed in that components "extra-push" list.
+
 components:
   bits.debian.org:
     master: dillon.debian.org