Merge pull request #47 from cybozu-go/clarify-manual

docs: clarify the behavior of label/annotation propagation
cybozu-go · Feb 3, 2022 · 8c32d2f · 8c32d2f
2 parents d9c2439 + 60e0771
commit 8c32d2f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -12,7 +12,7 @@ Any Namespace other than sub-namespaces can reference a template Namespace with
 
 Sub-namespace can reference a root or another sub-namespace as its parent.
 
-Accurate propagates the Namespace labels, annotations, and namespace-scope resources from a referenced Namespace to referencing Namespaces.
+When configured to do so, Accurate propagates the Namespace labels, annotations, and namespace-scope resources from a referenced Namespace to referencing Namespaces.
 
 Circular references are prohibited by an admission webhook.
 

diff --git a/docs/subnamespaces.md b/docs/subnamespaces.md
@@ -30,6 +30,8 @@ metadata:
     team: foo
 ```
 
+Accurate only propagates labels/annotations that have been configured in that respect via the `labelKeys` and `annotationKeys` parameters in `config.yaml`. This prevents the propagation of labels/annotations that were not meant to do so.
+
 ### Preparing resources for tenant users
 
 In almost all cases, a root Namespace should have RoleBinding for a group of tenant users.