Skip to content

Commit fa024ca

Browse files
committed
Incorporated SME review comments
1 parent 08b00f2 commit fa024ca

3 files changed

Lines changed: 25 additions & 6 deletions

File tree

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Topics:
115115
File: securing-webhooks-with-event-listeners
116116
- Name: Authenticating pipelines with repositories using secrets
117117
File: authenticating-pipelines-repos-using-secrets
118-
- Name: Using secrets from dedicated stores
118+
- Name: Using secrets from external secret stores
119119
File: using-secret-stores
120120
- Name: Unprivileged building of container images using Buildah
121121
File: unprivileged-building-of-container-images-using-buildah

modules/op-csi-secrets.adoc

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// * secure/using-csi-secrets.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
[id="configuring-results_{context}"]
6+
[id="consuming-secrets-csi_{context}"]
77
= Consuming secrets from an external store such as Hashicorp Vault using the Secrets Store CSI Driver
88

9-
If you want to use secrets from an external store that has a CSI (container storage interface) provider, for example, Hashicorp Vault, you can configure {pipelines-shortname} to consume these secrets using the Secrets Store CSI Driver.
9+
If you want to use secrets from an external store that has a Container Storage Interface (CSI) provider, for example, Hashicorp Vault, you can configure {pipelines-shortname} to consume these secrets using the Secrets Store CSI Driver.
1010

1111
.Prerequisites
1212

@@ -16,7 +16,7 @@ If you want to use secrets from an external store that has a CSI (container stor
1616
+
1717
[NOTE]
1818
====
19-
If you want to use an instance of Hashicorp Vault running outside your {OCP} cluster, you must provide the address to that instance in the Helm configuration when installing the CSI Provider. For infoamtion about providing an external Vault address, see link:https://developer.hashicorp.com/vault/docs/deploy/kubernetes/helm/configuration#externalvaultaddr[Configuration] in the Hashicorp documentation.
19+
If you want to use an instance of Hashicorp Vault running outside your {OCP} cluster, you must provide the address to that instance in the Helm configuration when installing the CSI Provider. For information about providing an external Vault address, see link:https://developer.hashicorp.com/vault/docs/deploy/kubernetes/helm/configuration#externalvaultaddr[Configuration] in the Hashicorp documentation.
2020
====
2121
2222
* You configured authentication with the secret store for an {OCP} service account, for example, `pipeline-sa`. For information about configuring Kubernetes authentication with Hashicorp Vault, see link:https://developer.hashicorp.com/vault/docs/auth/kubernetes[Kubernetes auth method] in the Hashicorp documentation.
@@ -88,6 +88,11 @@ spec:
8888
secretPath: "secret/data/my-secret"
8989
secretKey: "password"
9090
----
91+
+
92+
[WARNING]
93+
====
94+
The `vaultAddress` parameter used in this example uses `http` and `vaultSkipTLSVerify`: `"true"` only for demonstration purposes. For production use, configure Vault with a secure `https` endpoint and do not skip TLS verification.
95+
====
9196

9297
. In the definition of the task that consumes the secrets, define and mount a volume that uses the CSI secrets store driver and specifies the name of the `SecretProviderClass` CR. To minimise security exposure of secrets, mount them in the definition of a task and not of an entire pipeline.
9398
+
@@ -134,6 +139,18 @@ The mount path that you specify in the pipeline or task definition overrides the
134139
[source,yaml]
135140
----
136141
apiVersion: tekton.dev/v1
142+
kind: Pipeline
143+
metadata:
144+
name: vault-secret-pipeline
145+
namespace: tekton-vault
146+
spec:
147+
tasks:
148+
- name: read-secret
149+
taskRef:
150+
name: secret-task
151+
serviceAccountName: pipeline-sa
152+
---
153+
apiVersion: tekton.dev/v1
137154
kind: PipelineRun
138155
metadata:
139156
name: vault-secret-pipeline-run
@@ -151,11 +168,13 @@ spec:
151168
.Example `TaskRun` CR
152169
[source,yaml]
153170
----
171+
apiVersion: tekton.dev/v1
154172
kind: TaskRun
155173
metadata:
156174
name: vault-secret-task-run
175+
namespace: tekton-vault
157176
spec:
158177
taskRef:
159-
name: secretTask
178+
name: secret-task
160179
serviceAccountName: pipeline-sa
161180
----

secure/using-secret-stores.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Your pipelines can use secrets that are kept in an dedicated store.
9+
You can configure pipelines to consume secrets from external secret stores by using the Secrets Store CSI driver.
1010

1111
include::modules/op-csi-secrets.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)