Skip to content

Commit a3a6c67

Browse files
committed
Adding secret example configuration 2
1 parent 9a5eafa commit a3a6c67

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

content/learn/getting-started-multi-cloud-gitops.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ $ ./pattern.sh make load-secrets
209209

210210
The deployment will not take long but it should deploy successfully.
211211

212-
Alternatively you can deploy the Multicloud GitOps pattern by using the command line script `pattern.sh`
212+
Alternatively you can deploy the Multicloud GitOps pattern by using the command line script `pattern.sh`.
213213

214214
[id="deploying-cluster-using-patternsh-file"]
215215
== Deploying the cluster by using the pattern.sh file
@@ -244,7 +244,7 @@ $ ./pattern.sh make install
244244
+
245245
image::multicloud-gitops/multicloud-gitops-argocd.png[Multicloud GitOps Hub]
246246

247-
As part of installing by using the script `pattern.sh` pattern, HashiCorp Vault is installed. the load-secrets makefile target. Running `./pattern.sh make install` also calls the `load-secrets` makefile target. This `load-secrets` target looks for a yaml file describing the secrets to be loaded into vault and in case it cannot find one it will use the `values-secret.yaml.template` file in the git repo to try and generate random secrets.
247+
As part of installing by using the script `pattern.sh` pattern, HashiCorp Vault is installed. Running `./pattern.sh make install` also calls the `load-secrets` makefile target. This `load-secrets` target looks for a yaml file describing the secrets to be loaded into vault and in case it cannot find one it will use the `values-secret.yaml.template` file in the git repo to try and generate random secrets.
248248

249249
For more information, see section on https://validatedpatterns.io/secrets/vault/[Vault].
250250

@@ -276,7 +276,7 @@ Verify that the *config-demo* application deployed successfully as follows:
276276
+
277277
[source,terminal]
278278
----
279-
Hub Cluster domain is 'apps.ci-ln-b7ib8bt-76ef8.aws-2.ci.openshift.org'
280-
Pod is running on Local Cluster Domain 'apps.ci-ln-b7ib8bt-76ef8.aws-2.ci.openshift.org'
279+
Hub Cluster domain is 'apps.aws-hub-cluster.openshift.org'
280+
Pod is running on Local Cluster Domain 'apps.aws-hub-cluster.openshift.org'
281281
The secret is secret
282282
----

content/learn/getting-started-secret-management.adoc

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ As of December 12, 2023, ESO is not officially supported by Red Hat as a product
4545

4646
ESO's custom file format and utilities streamlines secret management by allowing file references and supporting encrypted secret storage. The design prioritizes security through multi-layer encryption and simplifies key management. In particular the ini key type is especially helpful for handling AWS credentials, where mismanagement could lead to unauthorized use and potential financial or operational issues.
4747

48-
Validated Patterns primary backend secret store is HashiCorp Vault It acts as a centralized service for securely managing secrets, such as passwords, API keys, and certificates.
48+
Validated Patterns primary backend secret store is HashiCorp Vault. HashiCorp Vault acts as a centralized service for securely managing secrets, such as passwords, API keys, and certificates.
4949

5050
Unlike other secret management systems tied to specific cloud providers for example AWS Secrets Manager or Azure Key Vault, Vault can be deployed across different clouds, on bare-metal systems, and in hybrid environments. This cross-platform support made it a popular and practical choice for maintaining a consistent secrets management strategy.
5151

@@ -81,7 +81,7 @@ $ cd <repository-name>
8181
+
8282
[source,terminal]
8383
----
84-
$ vi <repository-name>
84+
$ git checkout -b mysecret
8585
----
8686

8787
. Edit the existing `~/values-secret-multicloud-gitops.yaml`
@@ -106,6 +106,7 @@ secrets:
106106
onMissingValue: generate
107107
----
108108

109+
109110
. Load the secrets into the Vault by running the following command:
110111
+
111112
[source,terminal]
@@ -125,40 +126,46 @@ secrets:
125126

126127
.. Add the modified file to your Git repository:
127128
+
129+
[source,terminal]
128130
----
129131
$ git add -u
130132
----
131133

132134
.. Commit your changes:
133135
+
136+
[source,terminal]
134137
----
135-
$ git commit -m "Added mysecret-external-secret to create mysecret-secret in config-demo"
138+
$ git commit -m "Adding a Secret to Multicloud GitOps Patternn in config-demo"
136139
----
137140

138141
.. Push your branch to the origin of your fork:
139142
+
143+
[source,terminal]
140144
----
141145
$ git push origin mysecret
142146
----
143147

144-
=== Creating a new External Secret in OpenShift GitOps
148+
=== Creating a new external secret in OpenShift GitOps
145149

146150
Follow these steps to create and deploy a new external secret in your GitOps repository.
147151

148152
. Navigate to the `charts/all/config-demo/templates` directory in your repository:
149153
+
154+
[source,terminal]
150155
----
151156
$ cd charts/all/config-demo/templates
152157
----
153158

154159
. Create a new YAML file named `mysecret-external-secret.yaml`:
155160
+
161+
[source,terminal]
156162
----
157163
$ touch mysecret-external-secret.yaml
158164
----
159165

160166
. Open the file in your preferred text editor:
161167
+
168+
[source,terminal]
162169
----
163170
$ vi mysecret-external-secret.yaml
164171
----
@@ -194,37 +201,43 @@ spec:
194201

195202
. Add the new file to Git:
196203
+
204+
[source,terminal]
197205
----
198206
$ git add charts/all/config-demo/templates/mysecret-external-secret.yaml
199207
----
200208

201209
.. Commit your changes:
202210
+
211+
[source,terminal]
203212
----
204213
$ git commit -m "Added mysecret-external-secret to create mysecret-secret in config-demo"
205214
----
206215

207216
.. Push your branch to the origin of your fork:
208217
+
218+
[source,terminal]
209219
----
210220
$ git push origin mysecret
211221
----
212222

213-
== Step 3: Wait for ArgoCD to Apply the Changes
214223
. Ensure that ArgoCD is monitoring the `charts/all/config-demo` directory.
224+
215225
. Wait for ArgoCD to synchronize and apply the new changes. You can observe the synchronization status in the ArgoCD web UI.
216226

217-
== Step 4: Verify the Secret in the Cluster
218-
. Once ArgoCD has applied the changes, verify that the `mysecret-secret` has been created in the `config-demo` namespace:
227+
. Verify the Secret in the Cluster
228+
229+
.. Once ArgoCD has applied the changes, verify that the `mysecret-secret` has been created in the `config-demo` namespace:
219230
+
231+
[source,terminal]
220232
----
221-
oc get secret mysecret-secret -n config-demo
233+
$ oc get secret mysecret-secret -n config-demo
222234
----
223235

224-
. Check the contents of the secret if necessary:
236+
.. Check the contents of the secret if necessary:
225237
+
238+
[source,terminal]
226239
----
227-
oc describe secret mysecret-secret -n config-demo
240+
$ oc describe secret mysecret-secret -n config-demo
228241
----
229242

230243
== Outcome

0 commit comments

Comments
 (0)