Skip to content

Commit db4adca

Browse files
committed
OSDOCS-14994: updates for mounting secrets section in SSCSI
1 parent a017fec commit db4adca

File tree

4 files changed

+60
-60
lines changed

4 files changed

+60
-60
lines changed

modules/secrets-store-aws.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ endif::[]
1515
[id="secrets-store-aws_{context}"]
1616
= Mounting secrets from {secrets-store-provider}
1717

18-
You can use the {secrets-store-operator} to mount secrets from {secrets-store-provider} to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from {secrets-store-provider}, your cluster must be installed on AWS and use AWS Security Token Service (STS).
18+
You can use the {secrets-store-operator} to mount secrets from {secrets-store-provider} external secrets store to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from {secrets-store-provider}, your cluster must be installed on Amazon Web Services (AWS) and use AWS Security Token Service (STS).
1919

2020
.Prerequisites
2121

22-
* Your cluster is installed on AWS and uses AWS Security Token Service (STS).
23-
* You installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
24-
* You configured {secrets-store-provider} to store the required secrets.
25-
* You extracted and prepared the `ccoctl` binary.
26-
* You installed the `jq` CLI tool.
22+
* You have installed the cluster on AWS and use AWS Security Token Service (STS).
23+
* You have installed the {secrets-store-operator}. For more information, see "Installing the {secrets-store-driver}".
24+
* You have configured {secrets-store-provider} to store the required secrets.
25+
* You have extracted and prepared the `ccoctl` binary.
26+
* You have installed the `jq` CLI tool.
2727
* You have access to the cluster as a user with the `cluster-admin` role.
2828
2929
.Procedure
3030

3131
. Install the {secrets-store-provider} provider:
3232

33-
.. Create a YAML file with the following configuration for the provider resources:
33+
.. Create a YAML file with the following provider resource configurations:
3434
+
3535
[IMPORTANT]
3636
====
@@ -157,7 +157,7 @@ $ oc apply -f aws-provider.yaml
157157
$ mkdir credentialsrequest-dir-aws
158158
----
159159

160-
.. Create a YAML file with the following configuration for the credentials request:
160+
.. Create a YAML file with the following credentials request configurations:
161161
+
162162
.Example `credentialsrequest.yaml` file
163163
[source,yaml]
@@ -312,7 +312,7 @@ spec:
312312
driver: secrets-store.csi.k8s.io
313313
readOnly: true
314314
volumeAttributes:
315-
secretProviderClass: "my-aws-provider" <3>
315+
secretProviderClass: "my-aws-provider" <3>
316316
----
317317
<1> Specify the name for the deployment.
318318
<2> Specify the namespace for the deployment. This must be the same namespace as the secret provider class.

modules/secrets-store-azure.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@
66
[id="secrets-store-azure_{context}"]
77
= Mounting secrets from Azure Key Vault
88

9-
You can use the {secrets-store-operator} to mount secrets from Azure Key Vault to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from Azure Key Vault, your cluster must be installed on Microsoft Azure.
9+
You can use the {secrets-store-operator} to mount secrets from Azure Key Vault external secrets store to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from Azure Key Vault, your cluster must be installed on Microsoft Azure.
1010

1111
.Prerequisites
1212

13-
* Your cluster is installed on Azure.
14-
* You installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
15-
* You configured Azure Key Vault to store the required secrets.
16-
* You installed the Azure CLI (`az`).
13+
* Your have installed the cluster on Azure.
14+
* You have installed the {secrets-store-operator}. For more information, see "Installing the {secrets-store-driver}".
15+
* You have configured Azure Key Vault to store the required secrets.
16+
* You have installed the Azure CLI (`az`) tool.
1717
* You have access to the cluster as a user with the `cluster-admin` role.
1818
1919
.Procedure
2020

2121
. Install the Azure Key Vault provider:
2222

23-
.. Create a YAML file with the following configuration for the provider resources:
23+
.. Create a YAML file with the following provider resources configuration:
2424
+
2525
[IMPORTANT]
2626
====

modules/secrets-store-google.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@
66
[id="secrets-store-google_{context}"]
77
= Mounting secrets from Google Secret Manager
88

9-
You can use the {secrets-store-operator} to mount secrets from Google Secret Manager to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from Google Secret Manager, your cluster must be installed on {gcp-first}.
9+
You can use the {secrets-store-operator} to mount secrets from Google Secret Manager external secrets store to a Container Storage Interface (CSI) volume in {product-title}. To mount secrets from Google Secret Manager, your cluster must be installed on {gcp-first}.
1010

1111
.Prerequisites
1212

13-
* You installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
14-
* You configured Google Secret Manager to store the required secrets.
15-
* You created a service account key named `key.json` from your Google Cloud service account.
13+
* You have installed the {secrets-store-operator}. For more information, see "Installing the {secrets-store-driver}".
14+
* You have configured Google Secret Manager to store the required secrets.
15+
* You have created a service account key named `key.json` from your Google Cloud service account.
1616
* You have access to the cluster as a user with the `cluster-admin` role.
1717
1818
.Procedure
1919

2020
. Install the Google Secret Manager provider:
2121

22-
.. Create a YAML file with the following configuration for the provider resources:
22+
.. Create a YAML file with the following provider resources configuration:
2323
+
2424
.Example `gcp-provider.yaml` file
2525
[source,yaml]

modules/secrets-store-vault.adoc

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="secrets-store-vault_{context}"]
77
= Mounting secrets from HashiCorp Vault
88

9-
You can use the {secrets-store-operator} to mount secrets from HashiCorp Vault to a Container Storage Interface (CSI) volume in {product-title}.
9+
You can use the {secrets-store-operator} to mount secrets from HashiCorp Vault external secrets store to a Container Storage Interface (CSI) volume in {product-title}.
1010

1111
[IMPORTANT]
1212
====
@@ -20,8 +20,8 @@ Other cloud providers might work, but have not been tested yet. Additional cloud
2020

2121
.Prerequisites
2222

23-
* You installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
24-
* You installed Helm.
23+
* You have installed the {secrets-store-operator}. For more information, see "Installing the {secrets-store-driver}".
24+
* You installed the Helm package manager.
2525
* You have access to the cluster as a user with the `cluster-admin` role.
2626
2727
.Procedure
@@ -228,42 +228,6 @@ $ oc exec -i vault-0 --namespace=vault -- vault write auth/kubernetes/role/csi \
228228
Success! Data written to: auth/kubernetes/role/csi
229229
----
230230

231-
.. Verify that all of the `vault` pods are running properly by running the following command:
232-
+
233-
[source,terminal]
234-
----
235-
$ oc get pods -n vault
236-
----
237-
+
238-
.Example output
239-
[source,terminal]
240-
----
241-
NAME READY STATUS RESTARTS AGE
242-
vault-0 1/1 Running 0 43m
243-
vault-csi-provider-87rgw 2/2 Running 0 19m
244-
vault-csi-provider-bd6hp 2/2 Running 0 19m
245-
vault-csi-provider-smlv7 2/2 Running 0 19m
246-
----
247-
248-
.. Verify that all of the `secrets-store-csi-driver` pods are running properly by running the following command:
249-
+
250-
[source,terminal]
251-
----
252-
$ oc get pods -n openshift-cluster-csi-drivers | grep -E "secrets"
253-
----
254-
+
255-
.Example output
256-
[source,terminal]
257-
----
258-
secrets-store-csi-driver-node-46d2g 3/3 Running 0 45m
259-
secrets-store-csi-driver-node-d2jjn 3/3 Running 0 45m
260-
secrets-store-csi-driver-node-drmt4 3/3 Running 0 45m
261-
secrets-store-csi-driver-node-j2wlt 3/3 Running 0 45m
262-
secrets-store-csi-driver-node-v9xv4 3/3 Running 0 45m
263-
secrets-store-csi-driver-node-vlz28 3/3 Running 0 45m
264-
secrets-store-csi-driver-operator-84bd699478-fpxrw 1/1 Running 0 47m
265-
----
266-
267231
. Create a secret provider class to define your secrets store provider:
268232

269233
.. Create a YAML file that defines the `SecretProviderClass` object:
@@ -355,7 +319,43 @@ $ oc create -f deployment.yaml
355319

356320
.Verification
357321

358-
* Verify that you can access the secrets from your HashiCorp Vault in the pod volume mount:
322+
. Verify that all of the `vault` pods are running properly by running the following command:
323+
+
324+
[source,terminal]
325+
----
326+
$ oc get pods -n vault
327+
----
328+
+
329+
.Example output
330+
[source,terminal]
331+
----
332+
NAME READY STATUS RESTARTS AGE
333+
vault-0 1/1 Running 0 43m
334+
vault-csi-provider-87rgw 2/2 Running 0 19m
335+
vault-csi-provider-bd6hp 2/2 Running 0 19m
336+
vault-csi-provider-smlv7 2/2 Running 0 19m
337+
----
338+
339+
. Verify that all of the `secrets-store-csi-driver` pods are running properly by running the following command:
340+
+
341+
[source,terminal]
342+
----
343+
$ oc get pods -n openshift-cluster-csi-drivers | grep -E "secrets"
344+
----
345+
+
346+
.Example output
347+
[source,terminal]
348+
----
349+
secrets-store-csi-driver-node-46d2g 3/3 Running 0 45m
350+
secrets-store-csi-driver-node-d2jjn 3/3 Running 0 45m
351+
secrets-store-csi-driver-node-drmt4 3/3 Running 0 45m
352+
secrets-store-csi-driver-node-j2wlt 3/3 Running 0 45m
353+
secrets-store-csi-driver-node-v9xv4 3/3 Running 0 45m
354+
secrets-store-csi-driver-node-vlz28 3/3 Running 0 45m
355+
secrets-store-csi-driver-operator-84bd699478-fpxrw 1/1 Running 0 47m
356+
----
357+
358+
. Verify that you can access the secrets from your HashiCorp Vault in the pod volume mount:
359359

360360
.. List the secrets in the pod mount by running the following command:
361361
+

0 commit comments

Comments
 (0)