Skip to content

Commit 019d4b9

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

File tree

9 files changed

+97
-2
lines changed

9 files changed

+97
-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-api-reference.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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-api-reference_{context}"]
7+
= APIs
8+
9+
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[ExternalSecrets]
10+
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[ExternalSecretsList]
11+
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[ExternalSecretsManager]
12+
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[ExternalSecretsManagerList]

‎modules/eso-bitwarden-secret.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+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="eso-api-reference_{context}"]
8+
= bitwardenSecretManagerProvider
9+
10+
11+
The `bitwardenSecretManagerProvider` is used for enabling the bitwarden secrets manager provider and
12+
for setting up the additional service required for connecting with the bitwarden server.
13+
14+
15+
[cols="1,1,1,1",options="header"]
16+
|===
17+
| Field
18+
| Description
19+
| Default
20+
| Validation
21+
22+
23+
| `enabled` _string_
24+
| enabled is for enabling the bitwarden secrets manager provider, which can be indicated by setting `true` or `false`.
25+
| false
26+
| Enum: [true false] <br />Optional: \{\} <br />
27+
|===

‎security/external_secrets_operator/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes

‎security/external_secrets_operator/external-secrets-operator-api.adoc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="external-secrets-operator-api"]
3+
= {external-secrets-operator} APIs
4+
include::_attributes/common-attributes.adoc[]
5+
:context: external-secrets-operator-api
6+
7+
toc::[]
8+
9+
{external-secrets-operator} uses the following two APIs to configure the `external-secrets` application deployment.
10+
11+
//:FeatureName: The {external-secrets-operator}
12+
//include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
[cols="1,1,1",options="header"]
15+
|===
16+
| Group
17+
| Version
18+
| Kind
19+
20+
| operator.openshift.io
21+
| V1alpha1
22+
| externalsecrets
23+
24+
| operator.openshift.io
25+
| V1alpha1
26+
| externalsecretsmanager
27+
|===
28+
29+
[NOTE]
30+
====
31+
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group.
32+
====
33+
34+
//API
35+
include::modules/eso-api-reference.adoc[leveloffset=+1]
36+
37+
//bitwardenSecretManagerProvider
38+
include::modules/eso-bitwarden-secret.adoc[leveloffset=+1]
39+
40+
//CertManagerConfig
41+
//include::modules/eso-cert-manager-config.adoc[leveloffset=+1]
42+
43+
//ConditionalStatus
44+
//include::modules/eso-conditional-status.adoc[leveloffset=+1]

‎security/external_secrets_operator/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

‎security/external_secrets_operator/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules

‎security/external_secrets_operator/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets

0 commit comments

Comments
 (0)