Browse Source

Clarify that setting `spec.refreshInterval` to 0 disables all update behaviour (#4567)

If `spec.refreshInterval` is `0` the `Kind=Secret` is never updated, even if annotations or spec changes.

Signed-off-by: Patrick Del Conte <p.del.conte@hotmail.ch>
Co-authored-by: Gustavo Fernandes de Carvalho <17139678+gusfcarvalho@users.noreply.github.com>
Patrick Del Conte 1 year ago
parent
commit
7470307f53
1 changed files with 2 additions and 2 deletions
  1. 2 2
      docs/api/externalsecret.md

+ 2 - 2
docs/api/externalsecret.md

@@ -13,9 +13,9 @@ When the controller reconciles the `ExternalSecret` it will use the `spec.templa
 
 
 ## Update Behavior
 ## Update Behavior
 
 
-The `Kind=Secret` is updated when:
+The `Kind=Secret` is updated when one of the following conditions is met and `spec.refreshInterval` is not `0`:
 
 
-* the `spec.refreshInterval` has passed and is not `0`
+* the `spec.refreshInterval` has passed
 * the `ExternalSecret`'s `labels` or `annotations` are changed
 * the `ExternalSecret`'s `labels` or `annotations` are changed
 * the `ExternalSecret`'s `spec` has been changed
 * the `ExternalSecret`'s `spec` has been changed