diff --git a/modules/eso-bitwarden-secret.adoc b/modules/eso-bitwarden-secret.adoc index 6c9600e16101..7b5367960b85 100644 --- a/modules/eso-bitwarden-secret.adoc +++ b/modules/eso-bitwarden-secret.adoc @@ -6,7 +6,8 @@ [id="eso-bitwarden-secret_{context}"] = bitwardenSecretManagerProvider -The `bitwardenSecretManagerProvider` field enables the bitwarden secrets manager provider and sets up the additional service required to connect to the bitwarden server. +[role="_abstract"] +The `bitwardenSecretManagerProvider` field enables the Bitwarden secrets manager provider and sets up the additional service required to connect to the Bitwarden server. [cols="1,1,1,1,1",options="header"] |=== @@ -16,16 +17,17 @@ The `bitwardenSecretManagerProvider` field enables the bitwarden secrets manager | Default | Validation -| `enabled` +| `mode` | _string_ -| `enabled` field enables the `bitwardenSecretManagerProvider`. you can set this field to `true` or `false`. -| false -| enum: [true false] + +| `mode` field enables the `bitwardenSecretManagerProvider` provider state, which can be set to `Enabled` or `Disabled`. If set to `Enabled`, the Operator ensures the plugin is deployed and synchronized. If set to `Disabled`, the Bitwarden provider plugin reconciliation is disabled. The plugin and resources remain in their current state, and are not managed by the Operator. +| `Disabled` +a| enum: [Enabled Disabled] + Optional | `secretRef` | _SecretReference_ -| `SecretRef` specifies the kubernetes secret that contains the TLS key pair for the bitwarden server. If this reference is not provided and `certManagerConfig` field is configured, the issuer defined in `certManagerConfig` generates the required certificate. The secret must use `tls.crt` for certificate, `tls.key` for the private key, and `ca.crt` for CA certificate. +| `SecretRef` specifies the Kubernetes secret that contains the TLS key pair for the Bitwarden server. If this reference is not provided and the `certManagerConfig` field is configured, the issuer defined in `certManagerConfig` generates the required certificate. The secret must use `tls.crt` for certificate, `tls.key` for the private key, and `ca.crt` for CA certificate. | | Optional |=== diff --git a/modules/eso-cert-manager-config.adoc b/modules/eso-cert-manager-config.adoc index c10b7b5908d1..8198e6bd154b 100644 --- a/modules/eso-cert-manager-config.adoc +++ b/modules/eso-cert-manager-config.adoc @@ -16,18 +16,20 @@ The `certManagerConfig` field configures the `cert-manager` Operator settings. | Default | Validation -| `enabled` +| `mode` | _string_ -| `enabled` specifies whether cert-manager must obtain and renew certificates for the webhook server instead of using built-in certificates. Set this field to `true` or `false`. +| `mode` specifies whether to use cert-manager for certificate management instead of the built-in `cert-controller` which can be indicated by setting either `Enabled` or `Disabled`. If set to `Enabled`, uses `cert-manager` for obtaining the certificates for the webhook server and other components. If set to `Disabled`, uses the `cert-controller` for obtaining the certificates for the webhook server. `Disabled` is the default behavior. | false -| enum: [true false] + +a| enum: [true false] + Required -| `addInjectorAnnotations` +| `injectAnnotations` | _string_ -| `addInjectorAnnotations` adds the `cert-manager.io/inject-ca-from` annotation to the webhooks and custom resource definitions (CRDs) to automatically configure the webhook with the `cert-manager` Operator certificate authority (CA). This requires CA Injector to be enabled in `cert-manager` Operator. Set this field to `true` or `false`. +| `injectAnnotations` adds the `cert-manager.io/inject-ca-from` annotation to the webhooks and custom resource definitions (CRDs) to automatically configure the webhook with the `cert-manager` Operator certificate authority (CA). This requires CA Injector to be enabled in `cert-manager` Operator. Set this field to `true` or `false`. When set, this field cannot be changed. | false -| enum: [true false] + +a| enum: [true false] + Optional | `issuerRef` diff --git a/modules/eso-cert-providers-config.adoc b/modules/eso-cert-providers-config.adoc new file mode 100644 index 000000000000..2889e9df272c --- /dev/null +++ b/modules/eso-cert-providers-config.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * security/external_secrets_operator/external-secrets-operator-api.adoc + +:_mod-docs-content-type: REFERENCE +[id="eso-cert-providers-config_{context}"] += certProvidersConfig + +The `certProvidersConfig` defines the configuration for the certificate providers used to manage TLS certificates for webhook and plugins. + +[cols="1,1,1,1,1",options="header"] +|=== +| Field +| Type +| Description +| Default +| Validation + +| `certManager` +| _object_ +| `certManager` defines the configuration for `cert-manager` provider specifics. +| +| Optional +|=== diff --git a/modules/eso-condition.adoc b/modules/eso-condition.adoc new file mode 100644 index 000000000000..f8e5c953ab53 --- /dev/null +++ b/modules/eso-condition.adoc @@ -0,0 +1,36 @@ +// Module included in the following assemblies: +// +// * security/external_secrets_operator/external-secrets-operator-api.adoc + +:_mod-docs-content-type: REFERENCE +[id="eso-condition_{context}"] += condition + +The `condition` field holds information about the condition of the `external-secrets` deployment. + +[cols="1,1,1,1,1",options="header"] +|=== +| Field +| Type +| Description +| Default +| Validation + +| `type` +| _string_ +| `type` contains the condition of the deployment. +| +| Required + +| `status` +| link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#conditionstatus-v1-meta[_ConditionStatus_] +| `status` contains the status of the condition of the deployment +| +| + +| `message` +| _string_ +| `message` provides details on the state of the deployment +| +| +|=== diff --git a/modules/eso-conditional-status.adoc b/modules/eso-conditional-status.adoc new file mode 100644 index 000000000000..753f7ac894c8 --- /dev/null +++ b/modules/eso-conditional-status.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * security/external_secrets_operator/external-secrets-operator-api.adoc + +:_mod-docs-content-type: REFERENCE +[id="eso-conditional-status_{context}"] += conditionalStatus + +The `conditionalStatus` field holds information about the current state of the `external-secrets` deployment. + +[cols="1,1,1,1,1",options="header"] +|=== +| Field +| Type +| Description +| Default +| Validation + +| `conditions` +| _array_ +| `conditions` contains information on the current state of the deployment. +| +| +|=== diff --git a/modules/eso-controller-config.adoc b/modules/eso-controller-config.adoc index bb99fd8df29b..0f538ddee885 100644 --- a/modules/eso-controller-config.adoc +++ b/modules/eso-controller-config.adoc @@ -6,7 +6,7 @@ [id="eso-controller-config_{context}"] = controllerConfig -The `controllerConfig` field configures the operator to set the default values for installing `external-secrets` operand. +The `controllerConfig` specifies the configurations used by the controller when installing the `external-secrets` operand and the plugins. [cols="1,1,1,1,1",options="header"] |=== @@ -16,15 +16,20 @@ The `controllerConfig` field configures the operator to set the default values f | Default | Validation -| `namespace` +| `certProvider` | _string_ -| `namespace` configures the namespace for installing the `external-secrets` operand. -| external-secrets +| `certProvider` defines the configuration for the certificate providers used to manage TLS certificates for webhook and plugins. +| | Optional | `labels` | _object (keys:string, values:string)_ | `labels` field applies labels to all resources created for the `external-secrets` operand deployment. | -| Optional +a| The maximum number of properties is 20. + +The minimum number of properties is 0. + +Optional + |=== diff --git a/modules/eso-controller-status.adoc b/modules/eso-controller-status.adoc index 30183296a08d..c82a51e5d952 100644 --- a/modules/eso-controller-status.adoc +++ b/modules/eso-controller-status.adoc @@ -32,5 +32,5 @@ The `controllerStatus` field contains the observed conditions of the controllers | _integer_ | `observedGeneration` represents the `.metadata.generation` on the observed resource. | -| Minimum: 0 +| The minimum number of observed resources is 0. |=== diff --git a/modules/eso-external-secrets-config.adoc b/modules/eso-external-secrets-config.adoc index 0c8edc59d329..8858a865ff7a 100644 --- a/modules/eso-external-secrets-config.adoc +++ b/modules/eso-external-secrets-config.adoc @@ -4,9 +4,10 @@ :_mod-docs-content-type: REFERENCE [id="eso-external-secrets-config_{context}"] -= externalSecretsConfig += applicationConfig -The `externalSecretsConfig` field configures the behavior of `external-secrets` operand. +[role="_abstract"] +The `applicationConfig` specifies the configurations for the `external-secrets` operand. [cols="1,1,1,1,1",options="header"] |=== @@ -20,21 +21,21 @@ The `externalSecretsConfig` field configures the behavior of `external-secrets` | _integer_ | `logLevel` supports a range of values as defined in the link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use[kubernetes logging guidelines]. | 1 -| The maximum range value is 5 + -The minimum range value is 1 + +a| The maximum range value is 5 + +The minimum range value is 1 + Optional | `operatingNamespace` | _string_ | `operatingNamespace` restricts the `external-secrets` operand operations to the provided namespace. Enabling this field disables `ClusterSecretStore` and `ClusterExternalSecret`. | -| Optional +a| The maximum length is 63 -| `bitwardenSecretManagerProvider` -| _object_ -| `bitwardenSecretManagerProvider` enables the bitwarden secrets manager provider and sets up the additional service required for connecting to the bitwarden server. -| -| Optional +The minimum length is 1 + +Optional | `webhookConfig` | _object_ @@ -42,12 +43,6 @@ Optional | | -| `certManagerConfig` -| _object_ -| `certManagerConfig` configures `cert-manager` Operator settings that are used to generate certificates for the webhook and `bitwarden-sdk-server` components. -| -|Optional - | `resources` | link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#resourcerequirements-v1-core[_ResourceRequirements_] | `resources` defines the resource requirements. You cannot change the value of this field after setting it initially. For more information, see link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[] @@ -64,11 +59,25 @@ Optional | link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#toleration-v1-core[_Toleration_] _array_ | `tolerations` sets the pod tolerations. For more information, see link:https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[] | -| Optional +a| The maximum number of items is 50 + +The minimum number of items is 0 + +Optional | `nodeSelector` | _object (keys:string, values:string)_ | `nodeSelector` defines the scheduling criteria by using node labels. For more information, see link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[] | +a| The maximum number of properties is 50 + +The minimum number of properties is 0 + +Optional + +| `proxy` +| _object (keys:string, values:string)_ +| `proxy` sets the proxy configurations available in operand containers managed by the Operator as environment variables. +| | Optional |=== diff --git a/modules/eso-external-secrets-list.adoc b/modules/eso-external-secrets-list.adoc index a1e608f8becc..f9d7048a8f52 100644 --- a/modules/eso-external-secrets-list.adoc +++ b/modules/eso-external-secrets-list.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: REFERENCE [id="eso-external-secrets-list_{context}"] -= externalSecretsList += externalSecretsConfigList -The `externalSecretsList` object fetches the list of `externalSecrets` objects. +The `externalSecretsConfigList` object fetches the list of `externalSecretsConfig` objects. [cols="1,1,1,1,1",options="header"] |=== diff --git a/modules/eso-external-secrets-manager-list.adoc b/modules/eso-external-secrets-manager-list.adoc index e626180d4e00..3feca5a5cda6 100644 --- a/modules/eso-external-secrets-manager-list.adoc +++ b/modules/eso-external-secrets-manager-list.adoc @@ -37,7 +37,7 @@ The `externalSecretsManagerList` object fetches the list of `externalSecretsMana | `items` | _array_ -| `Items` contains a list of `externalSecretsManager` objects. +| | | |=== diff --git a/modules/eso-external-secrets-manager-spec.adoc b/modules/eso-external-secrets-manager-spec.adoc index 2aae7f93b9e4..7773fc4a3116 100644 --- a/modules/eso-external-secrets-manager-spec.adoc +++ b/modules/eso-external-secrets-manager-spec.adoc @@ -21,10 +21,4 @@ The `externalSecretsManagerSpec` field defines the desired behavior of the `exte | `globalConfig` configures the behavior of deployments that {external-secrets-operator-short} manages. | | Optional - -| `feature` -| _array_ -| `feature` enables the optional features of the Operator. -| -| Optional |=== diff --git a/modules/eso-external-secrets-manager-status.adoc b/modules/eso-external-secrets-manager-status.adoc index ae6af81ac40d..0bb46a053699 100644 --- a/modules/eso-external-secrets-manager-status.adoc +++ b/modules/eso-external-secrets-manager-status.adoc @@ -16,9 +16,9 @@ The `externalSecretsManagerStatus` field shows the most recently observed status | Default | Validation -| `controllerStatus` +| `controllerStatuses` | _array_ -| `controllerStatus` holds the observed conditions of the controllers used by the Operator. +| `controllerStatuses` holds the observed conditions of the controllers used by the Operator. | | @@ -26,6 +26,7 @@ The `externalSecretsManagerStatus` field shows the most recently observed status | link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta[_Time_] | `lastTransitionTime` records the most recent time the status of the condition changed. | -| Format: date-time + +a| Format: date-time + Type: string |=== diff --git a/modules/eso-external-secrets-manager.adoc b/modules/eso-external-secrets-manager.adoc index 491883fee5a6..832d9d0bf93f 100644 --- a/modules/eso-external-secrets-manager.adoc +++ b/modules/eso-external-secrets-manager.adoc @@ -8,7 +8,7 @@ The `externalSecretsManager` object defines the configuration and information of deployments managed by the {external-secrets-operator-short}. Set the name to `cluster` as this allows only one instance of `externalSecretsManager` per cluster. -You can configure global options and enable optional features by using `externalSecretsManager`. This serves as a centralized configuration for managing multiple controllers of the Operator. The Operator automatically creates the `externalSecretsManager` object during installation. +You can configure global options by using `externalSecretsManager`. This serves as a centralized configuration for managing multiple controllers of the Operator. The Operator automatically creates the `externalSecretsManager` object during installation. [cols="1,1,1,1,1",options="header"] |=== @@ -47,4 +47,4 @@ You can configure global options and enable optional features by using `external | `status` displays the most recently observed state of the controllers in the {external-secrets-operator-short}. | | -|=== +|=== \ No newline at end of file diff --git a/modules/eso-external-secrets-spec.adoc b/modules/eso-external-secrets-spec.adoc index 1194fe786cd2..8ce422121404 100644 --- a/modules/eso-external-secrets-spec.adoc +++ b/modules/eso-external-secrets-spec.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: REFERENCE [id="eso-external-secrets-spec_{context}"] -= externalSecretsSpec += externalSecretsConfigSpec -The `externalSecretsSpec` field defines the desired behavior of the `externalSecrets` object. +The `externalSecretsConfigSpec` field defines the desired behavior of the `externalSecrets` object. [cols="1,1,1,1,1",options="header"] |=== @@ -16,9 +16,15 @@ The `externalSecretsSpec` field defines the desired behavior of the `externalSec | Default | Validation -| `externalSecretsConfig` +| `appConfig` | _object_ -| `externalSecretsConfig` configures the behavior of `external-secrets` operand. +| `appConfig` configures the behavior of the `external-secrets` operand. +| +| Optional + +| `plugins` +| _object_ +| `plugins` configures the optional provider plugins. | | Optional diff --git a/modules/eso-external-secrets-status.adoc b/modules/eso-external-secrets-status.adoc index 2a9ae7e3d86e..a0ba1fbb1eff 100644 --- a/modules/eso-external-secrets-status.adoc +++ b/modules/eso-external-secrets-status.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: REFERENCE [id="eso-external-secrets-status_{context}"] -= externalSecretsStatus += externalSecretsConfigStatus -The `externalSecretsStatus` field shows the most recently observed status of the `externalSecrets` Object. +The `externalSecretsConfigStatus` field shows the most recently observed status of the `externalSecretsConfig` Object. [cols="1,1,1,1,1",options="header"] |=== @@ -27,4 +27,10 @@ The `externalSecretsStatus` field shows the most recently observed status of the | `externalSecretsImage` specifies the image name and tag used for deploy `external-secrets` operand. | | + +| `bitwardenSDKServerImage` +| _string_ +| `bitwardenSDKServerImage` specifies the name of the image and tag used for deploying the `bitwarden-sdk-server`. +| +| |=== diff --git a/modules/eso-external-secrets.adoc b/modules/eso-external-secrets.adoc index 354a0cce2483..648493e40bd8 100644 --- a/modules/eso-external-secrets.adoc +++ b/modules/eso-external-secrets.adoc @@ -4,11 +4,11 @@ :_mod-docs-content-type: REFERENCE [id="eso-external-secrets_{context}"] -= externalSecrets += externalSecretsConfig -The `externalSecrets` object defines the configuration and information for the managed `external-secrets` operand deployment. Set the name to `cluster` as `externalSecrets` object allows only one instance per cluster. +The `externalSecretsConfig` object defines the configuration and information for the managed `external-secrets` operand deployment. Set the name to `cluster` as `externalSecretsConfig` object allows only one instance per cluster. -Creating an `externalSecrets` object triggers the creation of a deployment that manages the `external-secrets` operand and maintains the desired state. +Creating an `externalSecretsConfig` object triggers the deployment of the `external-secrets` operand and maintains the desired state. [cols="1,1,1,1,1",options="header"] |=== @@ -38,7 +38,7 @@ Creating an `externalSecrets` object triggers the creation of a deployment that | `spec` | _object_ -| `spec` Contains the specifications of the desired behavior of the `externalSecrets` object. +| `spec` contains the specifications of the desired behavior of the `externalSecrets` object. | | @@ -47,4 +47,5 @@ Creating an `externalSecrets` object triggers the creation of a deployment that | `status` displays the most recently observed status of the `externalSecrets` object. | | + |=== diff --git a/modules/eso-global-config.adoc b/modules/eso-global-config.adoc index 27344e1a2693..8ac67fc94be1 100644 --- a/modules/eso-global-config.adoc +++ b/modules/eso-global-config.adoc @@ -17,12 +17,24 @@ The `globalConfig` field configures the behavior of the {external-secrets-operat | Default | Validation +| `labels` +| _integer_ +| `labels` applies to all resources created by the Operator. This field can have a maximum of 20 entries +| 1 +a| The maximum number of properties is 20 + +The minimum number of properties is 0 + +Optional + | `logLevel` | _integer_ | `logLevel` supports a range of values as defined in the link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use[kubernetes logging guidelines]. | 1 -| The maximum range value is 5 + -The minimum range value is 1 + +a| The maximum range value is 5 + +The minimum range value is 1 + Optional | `resources` @@ -41,17 +53,25 @@ Optional | link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#toleration-v1-core[_Toleration_] _array_ | `tolerations` sets the pod tolerations. For more information, see link:https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[] | -| Optional +a| The maximum number of items is 50 + +The minimum number of items is 0 + +Optional | `nodeSelector` | _object (keys:string, values:string)_ -| nodeSelector defines the scheduling criteria by using the node labels. For more information, see link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[] +| `nodeSelector` defines the scheduling criteria by using the node labels. For more information, see link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[] | -| Optional +a| The maximum number of properties is 50 -| `labels` -| _object (keys:string, values:string)_ -| `labels` applies labels to all resources created for the `external-secrets` operand deployment. +The minimum number of properties is 0 + +Optional + +| `proxy` +| _object_ +| `proxy` sets the proxy configurations available in the operand containers managed by the Operator as environment variables. | | Optional |=== diff --git a/modules/eso-feature.adoc b/modules/eso-mode.adoc similarity index 50% rename from modules/eso-feature.adoc rename to modules/eso-mode.adoc index 2c49e6170cb0..3c1f843cc910 100644 --- a/modules/eso-feature.adoc +++ b/modules/eso-mode.adoc @@ -3,10 +3,10 @@ // * security/external_secrets_operator/external-secrets-operator-api.adoc :_mod-docs-content-type: REFERENCE -[id="eso-feature_{context}"] -= feature +[id="eso-mode_{context}"] += mode -The `feature` field enables the optional features. +The `mode` field indicates the operational state of the optional features. [cols="1,1,1,1,1",options="header"] |=== @@ -16,15 +16,15 @@ The `feature` field enables the optional features. | Default | Validation -| `name` -| _string_ -| `name` of the optional feature. +| `Enabled` +| +| `Enabled` indicates the optional configuration is enabled. +| | -| Required -| `enabled` -| _boolean_ -| `enabled` determines whether the feature must be enabled. +| `Disabled` +| +| `Disabled` indicates the optional configuration is disabled. +| | -| Required |=== diff --git a/modules/eso-object-reference.adoc b/modules/eso-object-reference.adoc index fbe96965e43b..d68132d7d707 100644 --- a/modules/eso-object-reference.adoc +++ b/modules/eso-object-reference.adoc @@ -20,17 +20,29 @@ The `ObjectReference` field refers to an object by its name, kind, and group. | _string_ | `name` specifies the name of the resource being referred to. | -| Required +a| The maximum length is 253 characters. + +The minimum length is 1 character. + +Required | `kind` | _string_ | `kind` specifies the kind of the resource being referred to. | -| Optional +a| The maximum length is 253 characters. + +The minimum length is 1 character. + +Optional | `group` | _string_ | `group` specifies the group of the resource being referred to. | -| Optional +a| The maximum length is 253 characters. + +The minimum length is 1 character. + +Optional |=== diff --git a/modules/eso-plugins-config.adoc b/modules/eso-plugins-config.adoc new file mode 100644 index 000000000000..b418559812d3 --- /dev/null +++ b/modules/eso-plugins-config.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * security/external_secrets_operator/external-secrets-operator-api.adoc + +:_mod-docs-content-type: REFERENCE +[id="eso-plugiins-config_{context}"] += pluginsConfig + +The `pluginsConfig` configures the optional plugins. + +[cols="1,1,1,1,1",options="header"] +|=== +| Field +| Type +| Description +| Default +| Validation + +| `bitwardenSecretManagerProvider` +| _object_ +| `bitwardenSecretManagerProvider` enables the `bitwarden-secrets-manager` provider plugin for connecting with the 'bitwarden-secrets-manager'. +| +| Optional +|=== diff --git a/modules/eso-proxy-config.adoc b/modules/eso-proxy-config.adoc new file mode 100644 index 000000000000..551d8f2029d7 --- /dev/null +++ b/modules/eso-proxy-config.adoc @@ -0,0 +1,48 @@ +// Module included in the following assemblies: +// +// * security/external_secrets_operator/external-secrets-operator-api.adoc + +:_mod-docs-content-type: REFERENCE +[id="eso-proxy-config_{context}"] += proxyConfig + +The `proxyConfig` holds the proxy configurations which are made available in the operand containers and managed by the Operator as environment variables. + +[cols="1,1,1,1,1",options="header"] +|=== +| Field +| Type +| Description +| Default +| Validation + +| `httpProxy` +| _string_ +| The `httpProxy` field contains the URL of the proxy for HTTP requests. This field can have a maximum of 2048 characters. +| +a| The maximum length is 2048 characters. + +The minimum length is 0 characters. + +Optional + +| `httpsProxy` +| _string_ +| The `httpsProxy` field contains the URL of the proxy for HTTPS requests. This field can have a maximum of 2048 characters. +| +a| The maximum length is 2048 characters. + +The minimum length is 0 characters. + +Optional + +| `noProxy` +| _string_ +| The `noProxy` field is a comma-separated list of hostnames, classless inter-domain routings (CIDRs), and IP addresses or a combination of the three for which the proxy should not be used. This field can have a maximum of 4096 characters. +| +a| The maximum length is 4096 characters. + +The minimum length is 0 characters. + +Optional +|=== diff --git a/modules/eso-secret-reference.adoc b/modules/eso-secret-reference.adoc index 3afe055b9c2b..cdd5812173cb 100644 --- a/modules/eso-secret-reference.adoc +++ b/modules/eso-secret-reference.adoc @@ -20,5 +20,9 @@ The `secretReference` field refers to a secret with the given name in the same n | _string_ | `name` specifies the name of the secret resource being referred to. | -| Required +a| The maximum length is 253. + +The minimum length is 1. + +Required |=== diff --git a/security/external_secrets_operator/external-secrets-operator-api.adoc b/security/external_secrets_operator/external-secrets-operator-api.adoc index 5c2ce8976e7d..129fb7236355 100644 --- a/security/external_secrets_operator/external-secrets-operator-api.adoc +++ b/security/external_secrets_operator/external-secrets-operator-api.adoc @@ -19,7 +19,7 @@ toc::[] | `operator.openshift.io` | `v1alpha1` -| `externalsecrets` +| `externalsecretsConfig` | `operator.openshift.io` | `v1alpha1` @@ -28,10 +28,8 @@ toc::[] The following list contains the {external-secrets-operator} APIs: -* ExternalSecrets -* ExternalSecretsList +* ExternalSecretsConfig * ExternalSecretsManager -* ExternalSecretsManagerList //ExternalSecretsManagerList include::modules/eso-external-secrets-manager-list.adoc[leveloffset=+1] @@ -39,10 +37,10 @@ include::modules/eso-external-secrets-manager-list.adoc[leveloffset=+1] //ExternalSecretsManager include::modules/eso-external-secrets-manager.adoc[leveloffset=+1] -//ExternalSecretsList +//ExternalSecretsConfigList include::modules/eso-external-secrets-list.adoc[leveloffset=+1] -//ExternalSecrets +//ExternalSecretsConfig include::modules/eso-external-secrets.adoc[leveloffset=+1] [id="external-secrets-operator-fields_{context}"] @@ -56,27 +54,24 @@ include::modules/eso-external-secrets-manager-spec.adoc[leveloffset=+1] //externalSecretsManagerStatus include::modules/eso-external-secrets-manager-status.adoc[leveloffset=+1] -//ExternalSecretsSpec +//ExternalSecretsConfigSpec include::modules/eso-external-secrets-spec.adoc[leveloffset=+1] -//externalSecretsStatus +//externalSecretsConfigStatus include::modules/eso-external-secrets-status.adoc[leveloffset=+1] //GlobalConfig include::modules/eso-global-config.adoc[leveloffset=+1] -//Feature -include::modules/eso-feature.adoc[leveloffset=+1] +//ControllerConfig +include::modules/eso-controller-config.adoc[leveloffset=+1] //controllerStatus include::modules/eso-controller-status.adoc[leveloffset=+1] -//ExternalSecretsConfig +//ApplicationConfig include::modules/eso-external-secrets-config.adoc[leveloffset=+1] -//ControllerConfig -include::modules/eso-controller-config.adoc[leveloffset=+1] - //bitwardenSecretManagerProvider include::modules/eso-bitwarden-secret.adoc[leveloffset=+1] @@ -86,8 +81,26 @@ include::modules/eso-web-hook-config.adoc[leveloffset=+1] //CertManagerConfig include::modules/eso-cert-manager-config.adoc[leveloffset=+1] +//CertProvidersConfig +include::modules/eso-cert-providers-config.adoc[leveloffset=+1] + //ObjectReference include::modules/eso-object-reference.adoc[leveloffset=+1] //secretReference include::modules/eso-secret-reference.adoc[leveloffset=+1] + +//condition +include::modules/eso-condition.adoc[leveloffset=+1] + +//conditionalStatus +include::modules/eso-conditional-status.adoc[leveloffset=+1] + +//mode +include::modules/eso-mode.adoc[leveloffset=+1] + +//pluginsConfig +include::modules/eso-plugins-config.adoc[leveloffset=+1] + +//ProxyConfig +include::modules/eso-proxy-config.adoc[leveloffset=+1]