Skip to content

Commit b800c68

Browse files
aravipraaravipra
committed
OSDOCS-14805: adding missing details in ESO documentation
1 parent cce7f17 commit b800c68

22 files changed

+616
-2
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ endif::[]
6262
:osc: OpenShift sandboxed containers
6363
:osc-operator: OpenShift sandboxed containers Operator
6464
:cert-manager-operator: cert-manager Operator for Red Hat OpenShift
65+
:external-secrets-operator: External Secrets Operator for Red Hat OpenShift
66+
:external-secrets-operator-short: External Secrets Operator
6567
:secondary-scheduler-operator-full: Secondary Scheduler Operator for Red Hat OpenShift
6668
:secondary-scheduler-operator: Secondary Scheduler Operator
6769
:descheduler-operator: Kube Descheduler Operator
@@ -392,9 +394,9 @@ endif::openshift-origin[]
392394
// Formerly on-cluster image layering
393395
:image-mode-os-caps: Image mode for OpenShift
394396
:image-mode-os-lower: image mode for OpenShift
395-
// Formerly on-cluster layering
397+
// Formerly on-cluster layering
396398
:image-mode-os-on-caps: On-cluster image mode
397399
:image-mode-os-on-lower: on-cluster image mode
398-
// Formerly out-of-cluster layering
400+
// Formerly out-of-cluster layering
399401
:image-mode-os-out-caps: Out-of-cluster image mode
400402
:image-mode-os-out-lower: out-of-cluster image mode

‎_topic_maps/_topic_map.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1231,6 +1231,12 @@ Topics:
12311231
File: cert-manager-log-levels
12321232
- Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
12331233
File: cert-manager-operator-uninstall
1234+
- Name: External Secrets Operator for Red Hat OpenShift
1235+
Dir: external_secrets_operator
1236+
Distros: openshift-enterprise
1237+
Topics:
1238+
- Name: External Secrets Operator APIs
1239+
File: external-secrets-operator-api
12341240
- Name: Viewing audit logs
12351241
File: audit-log-view
12361242
- Name: Configuring the audit log policy

‎modules/eso-bitwarden-secret.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-bitwarden-secret_{context}"]
7+
= bitwardenSecretManagerProvider
8+
9+
The `bitwardenSecretManagerProvider` enables the bitwarden secrets manager provider and
10+
sets up the additional service required to connect to the bitwarden server.
11+
12+
[cols="1,1,1,1",options="header"]
13+
|===
14+
| Field
15+
| Description
16+
| Default
17+
| Validation
18+
19+
| `enabled`
20+
| `enabled` is for enabling the bitwarden secrets manager provider, which can be indicated by setting `true` or `false`.
21+
| false
22+
| Enum: [true false] Optional: \{\}
23+
|===

‎modules/eso-cert-manager-config.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-cert-manager-config_{context}"]
7+
= certManagerConfig
8+
9+
The `certManagerConfig` configures cert-manager specifics.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `enabled`
19+
| `enabled` is for enabling the use of cert-manager for obtaining and renewing the certificates used for webhook server, instead of built-in certificates. Use `true` or `false` to indicate the preference.
20+
| false
21+
| Enum: [true false] Optional: \{\}
22+
23+
| `addInjectorAnnotations`
24+
| `addInjectorAnnotations` is for adding the `cert-manager.io/inject-ca-from` annotation to the webhooks and CRDs to automatically setup webhook to the cert-manager CA. This requires CA Injector to be enabled in cert-manager. Use `true` or `false` to indicate the preference.
25+
| false
26+
| Enum: [true false] Optional: \{\}
27+
28+
| `issuerRef` _[ObjectReference](#objectreference)_
29+
| `issuerRef` contains details to the referenced object used for obtaining the certificates. It must exist in the external-secrets namespace if not using a cluster-scoped cert-manager issuer.
30+
|
31+
| Required: \{\}
32+
33+
| `certificateDuration` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#duration-v1-meta[Duration]
34+
| `certificateDuration` is the validity period of the webhook certificate.
35+
| 8760h
36+
| Optional: \{\}
37+
38+
| `certificateRenewBefore` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#duration-v1-meta[Duration]
39+
| `certificateRenewBefore` is the ahead time to renew the webhook certificate before expiry.
40+
|
41+
| Optional: \{\}
42+
|===
43+
44+
45+

‎modules/eso-conditional-status.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="eso-conditional-status_{context}"]
7+
= conditionalStatus
8+
9+
[cols="1,1,1,1",options="header"]
10+
|===
11+
| Field
12+
| Description
13+
| Default
14+
| Validation
15+
16+
| `conditions` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta[Condition]
17+
| conditions holds information of the current state of deployment.
18+
|
19+
|
20+
|===

‎modules/eso-controller-config.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-controller-config_{context}"]
7+
= controllerConfig
8+
9+
The controllerConfig configures the operator to set the default values for installing external-secrets.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `namespace` _string_
19+
| namespace configures the namespace for installing the external-secret operand.
20+
| external-secrets
21+
| Optional
22+
23+
| `labels` _object (keys:string, values:string)_
24+
| applies labels to all resources created for the external-secrets deployment.
25+
|
26+
| Optional
27+
|===

‎modules/eso-external-secrets-config.adoc

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-config_{context}"]
7+
= externalSecretsConfig
8+
9+
The externalSecretsConfig configures the behavior of external-secrets.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `logLevel` _integer_
19+
| logLevel supports value range as per link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use[kubernetes logging guidelines].
20+
| 1
21+
| Maximum: 5 Minimum: 1 Optional:
22+
23+
| `operatingNamespace` _string_
24+
| operatingNamespace restricts the external-secrets operations to the provided namespace. Enabling this field implicitly disables `ClusterSecretStore` and `ClusterExternalSecret`.
25+
|
26+
| Optional
27+
28+
| `bitwardenSecretManagerProvider`
29+
| bitwardenSecretManagerProvider enables the bitwarden secrets manager provider and sets up the additional service required for connecting to the bitwarden server.
30+
|
31+
| Optional
32+
33+
| `webhookConfig`
34+
| webhookConfig configures webhook specifics of the external-secrets.
35+
|
36+
|
37+
38+
| `certManagerConfig`
39+
| CertManagerConfig configures cert-manager specifics used to generate certificates for the webhook and bitwarden-sdk-server components.
40+
|
41+
|Optional
42+
43+
| `resources` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#resourcerequirements-v1-core[_ResourceRequirements_]
44+
| resources defines the resource requirements. Cannot be updated. For more information, see link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[]
45+
|
46+
| Optional
47+
48+
| `affinity` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#affinity-v1-core[_Affinity_]
49+
| affinity sets the scheduling affinity rules. For more information, see link:https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/[]
50+
|
51+
| Optional
52+
53+
| `tolerations` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#toleration-v1-core[_Toleration_] _array_
54+
| tolerations sets the pod tolerations. For more information, see link:https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[]
55+
|
56+
| Optional
57+
58+
| `nodeSelector` _object (keys:string, values:string)_
59+
| nodeSelector defines the scheduling criteria by using node labels. For more information, see link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[]
60+
|
61+
| Optional
62+
|===

‎modules/eso-external-secrets-list.adoc

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-list_{context}"]
7+
= externalSecretsList
8+
9+
The externalSecretsList stores a list of externalSecrets objects.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `apiVersion` _string_
19+
| `operator.openshift.io/v1alpha1`
20+
|
21+
|
22+
23+
| `kind` _string_
24+
| `externalSecretsList`
25+
|
26+
|
27+
28+
| `metadata` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta[_ListMeta_]
29+
| Refer to Kubernetes API documentation for details about the `metadata` fields.
30+
|
31+
|
32+
33+
| `items` _array_
34+
|
35+
|
36+
|
37+
|===

‎modules/eso-external-secrets-manager-list.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-manager-list_{context}"]
7+
= externalSecretsManagerList
8+
9+
The externalSecretsManagerList stores a list of externalSecretsManager objects.
10+
11+
12+
[cols="1,1,1,1",options="header"]
13+
|===
14+
| Field
15+
| Description
16+
| Default
17+
| Validation
18+
19+
| `apiVersion` _string_
20+
| `operator.openshift.io/v1alpha1`
21+
|
22+
|
23+
24+
| `kind` _string_
25+
| `externalSecretsManagerList`
26+
|
27+
|
28+
29+
| `metadata` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta[_ListMeta_]
30+
| Refer to Kubernetes API documentation for details about the `metadata` fields.
31+
|
32+
|
33+
34+
| `items` _array_
35+
|
36+
|
37+
|
38+
|===

‎modules/eso-external-secrets-manager-spec.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-manager-spec_{context}"]
7+
= externalSecretsManagerSpec
8+
9+
The externalSecretsManagerSpec defines the desired behavior of the externalSecretsManager.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `globalConfig`
19+
| globalConfig configures the behavior of deployments that external-secrets-operator manages.
20+
|
21+
| Optional
22+
23+
| `features` _array_
24+
| features enable the optional features of the Operator .
25+
|
26+
| Optional
27+
|===

‎modules/eso-external-secrets-manager.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-manager_{context}"]
7+
= externalSecretsManager
8+
9+
10+
The externalSecretsManager defines the configuration and information for deployments managed by
11+
the external-secrets-operator. Set the name to `cluster` as this is a singleton object that allows only one instance of externalSecretsManager per cluster.
12+
13+
use externalSecretsManager to configure global options and enable optional features. This serves as a centralized configuration for managing multiple controllers of the operator. The Operator automatically creates this object during installation.
14+
15+
[cols="1,1,1,1",options="header"]
16+
|===
17+
| Field
18+
| Description
19+
| Default
20+
| Validation
21+
22+
| `apiVersion` _string_
23+
| `operator.openshift.io/v1alpha1`
24+
|
25+
|
26+
27+
| `kind` _string_
28+
| `externalSecretsManager`
29+
|
30+
|
31+
32+
| `metadata` link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta[_ObjectMeta_]
33+
| Refer to Kubernetes API documentation for details about the `metadata` fields.
34+
|
35+
|
36+
37+
| `spec`
38+
| `spec` is the specification of the desired behavior
39+
|
40+
|
41+
42+
| `status`
43+
| Displays the most observed status of the controllers that the External Secrets Operator uses.
44+
|
45+
|
46+
|===

‎modules/eso-external-secrets-spec.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/external_secrets_operator/external-secrets-operator-api.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="eso-external-secrets-spec_{context}"]
7+
= externalSecretsSpec
8+
9+
The externalSecretsSpec defines the desired behavior of the externalSecrets.
10+
11+
[cols="1,1,1,1",options="header"]
12+
|===
13+
| Field
14+
| Description
15+
| Default
16+
| Validation
17+
18+
| `externalSecretsConfig`
19+
| externalSecretsConfig configures the behavior of external-secrets.
20+
|
21+
| Optional
22+
23+
| `controllerConfig`
24+
| controllerConfig configures the controller to set up defaults that enable external-secrets.
25+
|
26+
| Optional
27+
|===

0 commit comments

Comments
 (0)