Skip to content

Commit

Permalink
RHIDP-2384: Apply SME feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
linfraze committed May 23, 2024
1 parent 1c2edf1 commit 8d2ca4b
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions modules/installation/proc-config-rhdh-custom-resource.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
[id="proc-config-rhdh-custom-resource_{context}"]
= Configuring the {product-short} Custom Resource

You can change the configuration of the Custom Resource (CR) for your {product} instance.
// Explain why a user would want/need to do this.

[NOTE]
====
Updates to the Backstage CR are automatically handled by the {product} Operator. However, updates to resources referenced by the CR, such as ConfigMaps or Secrets, are not updated automatically unless the CR itself is updated. If you want to update resources referenced by the CR, then you must manually delete the Backstage Deployment so that the Operator can re-create it with the updated resources.
====

// .Prerequisites
// You have an administrative role in {product}
You can change the configuration of the Custom Resource (CR) to program the way that the Operator manages your {product} instance.

.Procedure

To configure your {product-short} CR file, complete the following steps:

. Add a custom application configuration file to {ocp-short} and reference it in the CR. In {ocp-short}, you can use the following example as a base template to create a ConfigMap, such as `app-config-rhdh.yaml`:
. In the CR file, reference the custom application configuration file in {ocp-short}. In {ocp-short}, you can use the following example as a base template to create a ConfigMap, such as `app-config-rhdh.yaml`:
+
[source,yaml,subs="attributes+"]
----
Expand All @@ -28,14 +19,14 @@ data:
"app-config-rhdh.yaml": |
app:
title: {product}
baseUrl: https://backstage-developer-hub-my-ns.apps.ci-ln-vtkzr22-72292.origin-ci-int-gce.dev.rhcloud.com
baseUrl: https://backstage-<CUSTOM_RESOURCE_NAME>-<NAMESPACE_NAME>.<OPENSHIFT_INGRESS_DOMAIN>
backend:
auth:
keys:
- secret: "${BACKEND_SECRET}"
baseUrl: https://backstage-backstage-sample-my-ns.apps.ci-ln-vtkzr22-72292.origin-ci-int-gce.dev.rhcloud.com
baseUrl: https://backstage-<CUSTOM_RESOURCE_NAME>-<NAMESPACE_NAME>.<OPENSHIFT_INGRESS_DOMAIN>
cors:
origin: https://backstage-backstage-sample-my-ns.apps.ci-ln-vtkzr22-72292.origin-ci-int-gce.dev.rhcloud.com
origin: https://backstage-<CUSTOM_RESOURCE_NAME>-<NAMESPACE_NAME>.<OPENSHIFT_INGRESS_DOMAIN>
----
+
. Use the mandatory backend authentication key for {product} to reference an environment variable defined in an {ocp-short} Secret.
Expand Down

0 comments on commit 8d2ca4b

Please sign in to comment.