From bf4a1a1ad90d8af229d9d4ba6a08578e8b6f6a4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Lindh=C3=A9?= <7773090+lindhe@users.noreply.github.com> Date: Tue, 12 Nov 2024 22:36:58 +0100 Subject: [PATCH] Update docs for ExternalSecrets's refreshInterval (#4097) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #4079 Signed-off-by: Andreas Lindhé <7773090+lindhe@users.noreply.github.com> --- apis/externalsecrets/v1beta1/externalsecret_types.go | 4 +++- .../bases/external-secrets.io_clusterexternalsecrets.yaml | 4 +++- .../crds/bases/external-secrets.io_externalsecrets.yaml | 4 +++- deploy/crds/bundle.yaml | 8 ++++++-- docs/api/spec.md | 8 ++++++-- 5 files changed, 21 insertions(+), 7 deletions(-) diff --git a/apis/externalsecrets/v1beta1/externalsecret_types.go b/apis/externalsecrets/v1beta1/externalsecret_types.go index 416c8a7da..6df9d538d 100644 --- a/apis/externalsecrets/v1beta1/externalsecret_types.go +++ b/apis/externalsecrets/v1beta1/externalsecret_types.go @@ -342,8 +342,10 @@ type ExternalSecretSpec struct { // +optional Target ExternalSecretTarget `json:"target,omitempty"` - // RefreshInterval is the amount of time before the values are read again from the SecretStore provider + // RefreshInterval is the amount of time before the values are read again from the SecretStore provider, + // specified as Golang Duration strings. // Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + // Example values: "1h", "2h30m", "5d", "10s" // May be set to zero to fetch and create it once. Defaults to 1h. // +kubebuilder:default="1h" RefreshInterval *metav1.Duration `json:"refreshInterval,omitempty"` diff --git a/config/crds/bases/external-secrets.io_clusterexternalsecrets.yaml b/config/crds/bases/external-secrets.io_clusterexternalsecrets.yaml index 326e2448e..0df4036c3 100644 --- a/config/crds/bases/external-secrets.io_clusterexternalsecrets.yaml +++ b/config/crds/bases/external-secrets.io_clusterexternalsecrets.yaml @@ -357,8 +357,10 @@ spec: refreshInterval: default: 1h description: |- - RefreshInterval is the amount of time before the values are read again from the SecretStore provider + RefreshInterval is the amount of time before the values are read again from the SecretStore provider, + specified as Golang Duration strings. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + Example values: "1h", "2h30m", "5d", "10s" May be set to zero to fetch and create it once. Defaults to 1h. type: string secretStoreRef: diff --git a/config/crds/bases/external-secrets.io_externalsecrets.yaml b/config/crds/bases/external-secrets.io_externalsecrets.yaml index a0396a820..f59284093 100644 --- a/config/crds/bases/external-secrets.io_externalsecrets.yaml +++ b/config/crds/bases/external-secrets.io_externalsecrets.yaml @@ -621,8 +621,10 @@ spec: refreshInterval: default: 1h description: |- - RefreshInterval is the amount of time before the values are read again from the SecretStore provider + RefreshInterval is the amount of time before the values are read again from the SecretStore provider, + specified as Golang Duration strings. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + Example values: "1h", "2h30m", "5d", "10s" May be set to zero to fetch and create it once. Defaults to 1h. type: string secretStoreRef: diff --git a/deploy/crds/bundle.yaml b/deploy/crds/bundle.yaml index d73ea44a7..1898611eb 100644 --- a/deploy/crds/bundle.yaml +++ b/deploy/crds/bundle.yaml @@ -335,8 +335,10 @@ spec: refreshInterval: default: 1h description: |- - RefreshInterval is the amount of time before the values are read again from the SecretStore provider + RefreshInterval is the amount of time before the values are read again from the SecretStore provider, + specified as Golang Duration strings. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + Example values: "1h", "2h30m", "5d", "10s" May be set to zero to fetch and create it once. Defaults to 1h. type: string secretStoreRef: @@ -5882,8 +5884,10 @@ spec: refreshInterval: default: 1h description: |- - RefreshInterval is the amount of time before the values are read again from the SecretStore provider + RefreshInterval is the amount of time before the values are read again from the SecretStore provider, + specified as Golang Duration strings. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + Example values: "1h", "2h30m", "5d", "10s" May be set to zero to fetch and create it once. Defaults to 1h. type: string secretStoreRef: diff --git a/docs/api/spec.md b/docs/api/spec.md index 28dce8462..ceecadcf9 100644 --- a/docs/api/spec.md +++ b/docs/api/spec.md @@ -2989,8 +2989,10 @@ Kubernetes meta/v1.Duration -

RefreshInterval is the amount of time before the values are read again from the SecretStore provider +

RefreshInterval is the amount of time before the values are read again from the SecretStore provider, +specified as Golang Duration strings. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” +Example values: “1h”, “2h30m”, “5d”, “10s” May be set to zero to fetch and create it once. Defaults to 1h.

@@ -3730,8 +3732,10 @@ Kubernetes meta/v1.Duration -

RefreshInterval is the amount of time before the values are read again from the SecretStore provider +

RefreshInterval is the amount of time before the values are read again from the SecretStore provider, +specified as Golang Duration strings. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” +Example values: “1h”, “2h30m”, “5d”, “10s” May be set to zero to fetch and create it once. Defaults to 1h.