Skip to content

Commit 1142f0e

Browse files
authored
Merge pull request #102530 from xenolinux/A14
[enterprise-4.14] OSDOCS#14994: Minor SSCSI fixes
2 parents 3cf91f3 + 6b75f2c commit 1142f0e

File tree

2 files changed

+24
-25
lines changed

2 files changed

+24
-25
lines changed

modules/secrets-store-aws.adoc

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,27 @@ 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 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} to a CSI volume in {product-title}. To mount secrets from {secrets-store-provider}, your must install your cluster on AWS and use AWS Security Token Service (STS).
1919

2020
[IMPORTANT]
2121
====
22-
It is not supported to use the {secrets-store-operator} with {secrets-store-provider} in a hosted control plane cluster.
22+
To use the {secrets-store-operator} with {secrets-store-provider} is not supported in {hcp}.
2323
====
2424

2525
.Prerequisites
2626

27-
* Your cluster is installed on AWS and uses AWS Security Token Service (STS).
28-
* You have installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
29-
* You have configured {secrets-store-provider} to store the required secrets.
30-
* You have extracted and prepared the `ccoctl` binary.
31-
* You have installed the `jq` CLI tool.
3227
* You have access to the cluster as a user with the `cluster-admin` role.
28+
* You have installed the `jq` tool.
29+
* You have extracted and prepared the `ccoctl` utility.
30+
* You have installed the cluster on {aws-first} and the cluster uses {aws-short} Security Token Service (STS).
31+
* You have installed the {secrets-store-operator}. For more information, see "Installing the {secrets-store-driver}".
32+
* You have configured {secrets-store-provider} to store the required secrets.
3333
3434
.Procedure
3535

3636
. Install the {secrets-store-provider} provider:
3737

38-
.. Create a YAML file with the following configuration for the provider resources:
38+
.. Create a YAML file by using the following example configuration:
3939
+
4040
[IMPORTANT]
4141
====
@@ -153,24 +153,23 @@ $ oc adm policy add-scc-to-user privileged -z csi-secrets-store-provider-aws -n
153153
$ oc apply -f aws-provider.yaml
154154
----
155155

156-
. Grant permission to allow the service account to read the AWS secret object:
156+
. Grant the read permission to the service account for the AWS secret object:
157157

158158
.. Create a directory to contain the credentials request by running the following command:
159159
+
160160
[source,terminal]
161161
----
162-
$ mkdir credentialsrequest-dir-aws
162+
$ mkdir <aws_creds_directory_name>
163163
----
164164

165-
.. Create a YAML file with the following configuration for the credentials request:
165+
.. Create a YAML file that defines the `CredentialsRequest` resource configuration. See the following example configuration:
166166
+
167-
.Example `credentialsrequest.yaml` file
168167
[source,yaml]
169168
----
170169
apiVersion: cloudcredential.openshift.io/v1
171170
kind: CredentialsRequest
172171
metadata:
173-
name: aws-provider-test
172+
name: aws-creds-request
174173
namespace: openshift-cloud-credential-operator
175174
spec:
176175
providerSpec:
@@ -196,10 +195,10 @@ endif::aws-systems-manager-parameter-store[]
196195
name: aws-creds
197196
namespace: my-namespace
198197
serviceAccountNames:
199-
- aws-provider
198+
- <service_account_name>
200199
----
201200

202-
.. Retrieve the OIDC provider by running the following command:
201+
.. Retrieve the OpenID Connect (OIDC) provider by running the following command:
203202
+
204203
[source,terminal]
205204
----
@@ -219,8 +218,8 @@ Copy the OIDC provider name `<oidc_provider_name>` from the output to use in the
219218
----
220219
$ ccoctl aws create-iam-roles \
221220
--name my-role --region=<aws_region> \
222-
--credentials-requests-dir=credentialsrequest-dir-aws \
223-
--identity-provider-arn arn:aws:iam::<aws_account>:oidc-provider/<oidc_provider_name> --output-dir=credrequests-ccoctl-output
221+
--credentials-requests-dir=<aws_creds_dir_name> \
222+
--identity-provider-arn arn:aws:iam::<aws_account_id>:oidc-provider/<oidc_provider_name> --output-dir=<output_dir_name>
224223
----
225224
+
226225
.Example output

modules/secrets-store-azure.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
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 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 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

1313
* Your cluster is installed on Azure.
14-
* You have installed the {secrets-store-operator}. See _Installing the {secrets-store-driver}_ for instructions.
15-
* You have configured Azure Key Vault to store the required secrets.
16-
* You have installed the Azure CLI (`az`).
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`).
1717
* You have access to the cluster as a user with the `cluster-admin` role.
1818
1919
.Procedure
@@ -283,11 +283,11 @@ $ oc create -f deployment.yaml
283283

284284
* Verify that you can access the secrets from Azure Key Vault in the pod volume mount:
285285
286-
.. List the secrets in the pod mount:
286+
.. List the secrets in the pod mount by running the following command:
287287
+
288288
[source,terminal]
289289
----
290-
$ oc exec busybox-<hash> -n my-namespace -- ls /mnt/secrets-store/
290+
$ oc exec my-azure-deployment-<hash> -n my-namespace -- ls /mnt/secrets-store/
291291
----
292292
+
293293
.Example output
@@ -296,11 +296,11 @@ $ oc exec busybox-<hash> -n my-namespace -- ls /mnt/secrets-store/
296296
secret1
297297
----
298298

299-
.. View a secret in the pod mount:
299+
.. View a secret in the pod mount by running the following command:
300300
+
301301
[source,terminal]
302302
----
303-
$ oc exec busybox-<hash> -n my-namespace -- cat /mnt/secrets-store/secret1
303+
$ oc exec my-azure-deployment-<hash> -n my-namespace -- cat /mnt/secrets-store/secret1
304304
----
305305
+
306306
.Example output

0 commit comments

Comments
 (0)