Browse Source

doc: enhance best practices for cluster-wide resources reconciliation (#4423)

Signed-off-by: Kilian Kluge <dev@kluge.ai>
Kilian Kluge 1 year ago
parent
commit
4286d2766e
1 changed files with 18 additions and 6 deletions
  1. 18 6
      docs/guides/security-best-practices.md

+ 18 - 6
docs/guides/security-best-practices.md

@@ -31,23 +31,35 @@ spec:
 
 ### 3. Selectively Disable Reconciliation of Cluster-Wide Resources
 
-ESO allows you to selectively disable the reconciliation of cluster-wide resources such as `ClusterSecretStore`, `ClusterExternalSecret`, and `PushSecret`. You can disable the installation of CRDs in the Helm chart or disable reconciliation in the core-controller using the following options:
+ESO allows you to selectively disable the reconciliation of cluster-wide resources `ClusterSecretStore`, `ClusterExternalSecret`, and `PushSecret`.
+You can disable the installation of CRDs and reconciliation in the Helm chart, or disable reconciliation in the core controller.
 
-To disable CRD installation:
+To disable reconciliation in the Helm chart:
+
+```yaml
+processClusterExternalSecret: false
+processClusterStore: false
+processPushSecret: false
+```
+
+To disable CRD installation in the Helm chart:
 
 ```yaml
-# disable cluster-wide resources & push secret
 crds:
   createClusterExternalSecret: false
   createClusterSecretStore: false
   createPushSecret: false
 ```
 
-To disable reconciliation in the core-controller:
+Note that disabling CRD installation for a cluster-wide resource does not automatically disable its reconciliation.
+The core controller will issue error logs if the CRD is not installed but the reconciliation is not disabled.
+
+To disable reconciliation in the core controller, set the following flags:
 
 ```
---enable-cluster-external-secret-reconciler
---enable-cluster-store-reconciler
+--enable-cluster-external-secret-reconciler=false
+--enable-cluster-store-reconciler=false
+--enable-push-secret-reconciler=false
 ```
 
 ### 4. Implement Namespace-Scoped Installation