consistent names for database secrets

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

Author: themr0c

artifacts/attributes.adoc

@@ -25,6 +25,8 @@
 :my-product-cr-name: my-rhdh-custom-resource
 :my-product-namespace: my-rhdh-project
 :my-product-secrets: my-rhdh-secrets
+:my-product-database-certificates-secrets: my-rhdh-database-certificates-secrets
+:my-product-database-secrets: my-rhdh-database-secrets
 :my-product-url: https://__<my_developer_hub_url>__
 
 // Red Hat Platforms

modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc

@@ -7,7 +7,7 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de
 
 * You are using a supported version of PostgreSQL. For more information, see the link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page].
 * You have the following details:
-** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address 
+** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address
 ** `db-port`: Denotes your PostgreSQL instance port number, such as `5432`
 ** `username`: Denotes the user name to connect to your PostgreSQL instance
 ** `password`: Denotes the password to connect to your PostgreSQL instance
@@ -16,21 +16,21 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de
 
 [NOTE]
 ====
-By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance.  
+By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance.
 ====
- 
+
 
 .Procedure
 
-. Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection: 
+. Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection:
 +
 [source,terminal]
 ----
 cat <<EOF | oc -n <your-namespace> create -f -
 apiVersion: v1
 kind: Secret
 metadata:
- name: <crt-secret> <1>
+ name: {my-product-database-certificates-secrets} <1>
 type: Opaque
 stringData:
  postgres-ca.pem: |-
@@ -39,11 +39,11 @@ stringData:
  postgres-key.key: |-
   -----BEGIN CERTIFICATE-----
   <tls-private-key> <3>
- postgres-crt.pem: |-    
+ postgres-crt.pem: |-
   -----BEGIN CERTIFICATE-----
   <tls-certificate-key> <4>
   # ...
-EOF  
+EOF
 ----
 <1> Provide the name of the certificate secret.
 <2> Provide the CA certificate key.
@@ -58,7 +58,7 @@ cat <<EOF | oc -n <your-namespace> create -f -
 apiVersion: v1
 kind: Secret
 metadata:
- name: <cred-secret> <1>
+ name: {my-product-database-secrets} <1>
 type: Opaque
 stringData: <2>
  POSTGRES_PASSWORD: <password>
@@ -83,7 +83,7 @@ upstream:
   postgresql:
     enabled: false  # disable PostgreSQL instance creation <1>
     auth:
-      existingSecret: <cred-secret> # inject credentials secret to Backstage <2>
+      existingSecret: {my-product-database-secrets} # inject credentials secret to Backstage <2>
   backstage:
     appConfig:
       backend:
@@ -102,7 +102,7 @@ upstream:
               cert:
                 $file: /opt/app-root/src/postgres-crt.pem
   extraEnvVarsSecrets:
-    - <cred-secret> # inject credentials secret to Backstage <3>
+    - {my-product-database-secrets} # inject credentials secret to Backstage <3>
   extraEnvVars:
     - name: BACKEND_SECRET
       valueFrom:
@@ -120,7 +120,7 @@ upstream:
       subPath: postgres-ca.pem
     - mountPath: /opt/app-root/src/postgres-key.key
       name: postgres-key # inject TLS private key to Backstage cont. <6>
-      subPath: postgres-key.key              
+      subPath: postgres-key.key
   extraVolumes:
     - ephemeral:
         volumeClaimTemplate:
@@ -143,10 +143,10 @@ upstream:
         secretName: dynamic-plugins-npmrc
     - name: postgres-crt
       secret:
-        secretName: <crt-secret> <7>
+        secretName: {my-product-database-certificates-secrets} <7>
         # ...
 ----
-<1> Set the value of the `upstream.postgresql.enabled` parameter to `false` to disable creating local PostgreSQL instances. 
+<1> Set the value of the `upstream.postgresql.enabled` parameter to `false` to disable creating local PostgreSQL instances.
 <2> Provide the name of the credential secret.
 <3> Provide the name of the credential secret.
 <4> Optional: Provide the name of the TLS certificate only for a TLS connection.

modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc

@@ -24,13 +24,13 @@ By default, {product-short} uses a database for each plugin and automatically cr
 
 . Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection:
 +
-[source,yaml]
+[source,yaml,subs="+attributes,+quotes"]
 ----
-cat <<EOF | oc -n <your-namespace> create -f -
+cat <<EOF | oc -n {my-product-namespace} create -f -
 apiVersion: v1
 kind: Secret
 metadata:
- name: <crt-secret> <1>
+ name: {my-product-database-certificates-secrets} <1>
 type: Opaque
 stringData:
  postgres-ca.pem: |-
@@ -52,13 +52,13 @@ EOF
 
 . Create a credential secret to connect with the PostgreSQL instance:
 +
-[source,yaml]
+[source,yaml,subs="+attributes,+quotes"]
 ----
-cat <<EOF | oc -n <your-namespace> create -f -
+cat <<EOF | oc -n {my-product-namespace} create -f -
 apiVersion: v1
 kind: Secret
 metadata:
- name: <cred-secret> <1>
+ name: {my-product-database-secrets} <1>
 type: Opaque
 stringData: <2>
  POSTGRES_PASSWORD: <password>
@@ -74,11 +74,11 @@ EOF
 <3> Optional: Provide the value based on the required link:https://www.postgresql.org/docs/15/libpq-connect.html#LIBPQ-CONNECT-SSLMODE[Secure Sockets Layer (SSL) mode].
 <4> Optional: Provide the value only if you need a TLS connection for your PostgreSQL instance.
 
-. Create a `Backstage` custom resource (CR):
+. Create a `{product-custom-resource-type}` custom resource (CR):
 +
-[source,terminal]
+[source,terminal,subs="+attributes,+quotes"]
 ----
-cat <<EOF | oc -n <your-namespace> create -f -
+cat <<EOF | oc -n {my-product-namespace} create -f -
 apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
@@ -90,11 +90,11 @@ spec:
     extraFiles:
       mountPath: <path> # e g /opt/app-root/src
       secrets:
-        - name: <crt-secret> <2>
-          key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in <crt-secret> Secret
+        - name: {my-product-database-certificates-secrets} <2>
+          key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in {my-product-database-certificates-secrets} Secret
     extraEnvs:
       secrets:
-        - name: <cred-secret> <3>
+        - name: {my-product-database-secrets} <3>
         # ...
 ----
 <1> Set the value of the `enableLocalDb` parameter to `false` to disable creating local PostgreSQL instances.
@@ -106,4 +106,4 @@ spec:
 The environment variables listed in the `Backstage` CR work with the Operator default configuration. If you have changed the Operator default configuration, you must reconfigure the `Backstage` CR accordingly.
 ====
 
-. Apply the `Backstage` CR to the namespace where you have deployed the {product-very-short} instance.
+. Apply the `{product-custom-resource-type}` CR to the namespace where you have deployed the {product-short} instance.

modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc

@@ -91,11 +91,11 @@ spec:
   # ...
     extraFiles:
       secrets:
-        - name: <crt-secret>
-          key: postgres-crt.pem # key name as in <crt-secret> Secret
+        - name: {my-product-database-certificates-secrets}
+          key: postgres-crt.pem # key name as in {my-product-database-certificates-secrets} Secret
     extraEnvs:
       secrets:
-        - name: <cred-secret>
+        - name: {my-product-database-secrets}
 # ...
 ----
 +

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

@@ -61,11 +61,11 @@ spec:
     extraEnvs:
       secrets:
          - name: {my-product-secrets}
-         - name: cred-secret
+         - name: {my-product-database-secrets}
     extraFiles:
       mountPath: /opt/app-root/src
       secrets:
-        - name: crt-secret
+        - name: {my-product-database-certificates-secrets}
           key: postgres-crt.pem, postgres-ca.pem, postgres-key.key
     replicas: 1
     route:
@@ -139,7 +139,7 @@ spec:
 ----
 ====
 +
-.Register the `{my-product-secrets}` and `cred-secret` secrets
+.Register the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
 ====
 [source,yaml,subs="+attributes,+quotes"]
 ----
@@ -148,22 +148,22 @@ spec:
     extraEnvs:
       secrets:
          - name: {my-product-secrets}
-         - name: cred-secret
+         - name: {my-product-database-secrets}
 ----
 ====
 
 spec.application.extraFiles.secrets::
 Enter your certificates files secret name and files list.
 +
-.Register the `crt-secret` secret containing the `postgres-crt.pem`, `postgres-ca.pem`, and `postgres-key.key` files
+.Register the `{my-product-database-certificates-secrets}` secret containing the `postgres-crt.pem`, `postgres-ca.pem`, and `postgres-key.key` files
 [source,yaml,subs="+attributes,+quotes"]
 ----
 spec:
   application:
     extraFiles:
       mountPath: /opt/app-root/src
       secrets:
-        - name: crt-secret
+        - name: {my-product-database-certificates-secrets}
           key: postgres-crt.pem, postgres-ca.pem, postgres-key.key
 ----