Skip to content

Commit 4674de0

Browse files
openshift-cherrypick-robotGitHub Actions
andauthored
[release-1.7] RHDHBUGS-2056 Missing steps in the orchestrator installment downstream docs (#1397)
* Update the steps for installing the orchestrator * Update the steps for installing the orchestrator * Update the steps for installing the orchestrator --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent af6d900 commit 4674de0

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

modules/orchestrator/proc-enable-orchestrator-plugin.adoc

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy
1717
- package: "@redhat/backstage-plugin-orchestrator@<plugin_version>"
1818
disabled: false
1919
----
20-
20+
+
2121
.Example: Complete configuration of the Orchestrator plugin
2222
[source,yaml]
2323
----
@@ -53,5 +53,60 @@ spec:
5353
dynamicPluginsConfigMapName: orchestrator-plugin
5454
----
5555
56+
. Create a secret containing the `BACKEND_SECRET` value as shown in the following example:
57+
+
58+
[source,yaml]
59+
----
60+
apiVersion: v1
61+
kind: ConfigMap
62+
metadata:
63+
name: app-config-rhdh
64+
data:
65+
app-config-rhdh.yaml: |-
66+
auth:
67+
environment: development
68+
providers:
69+
guest:
70+
# using the guest user to query the '/api/dynamic-plugins-info/loaded-plugins' endpoint.
71+
dangerouslyAllowOutsideDevelopment: true
72+
backend:
73+
auth:
74+
externalAccess:
75+
- type: static
76+
options:
77+
token: ${BACKEND_SECRET}
78+
subject: orchestrator
79+
---
80+
apiVersion: v1
81+
kind: Secret
82+
metadata:
83+
name: backend-auth-secret
84+
stringData:
85+
# generated with the command below (from https://backstage.io/docs/auth/service-to-service-auth/#setup):
86+
# node -p 'require("crypto").randomBytes(24).toString("base64")'
87+
# notsecret
88+
BACKEND_SECRET: "R2FxRVNrcmwzYzhhN3l0V1VRcnQ3L1pLT09WaVhDNUEK"
89+
----
90+
91+
. Configure your {product-custom-resource-type} CR to update the secret name in the `extraEnvs` field as shown in the following example:
92+
+
93+
[source,yaml]
94+
----
95+
apiVersion: rhdh.redhat.com/v1alpha4
96+
kind: Backstage
97+
metadata:
98+
name: orchestrator
99+
spec:
100+
application:
101+
appConfig:
102+
configMaps:
103+
- name: app-config-rhdh
104+
dynamicPluginsConfigMapName: orchestrator-plugin
105+
extraEnvs:
106+
secrets:
107+
# secret that contains the BACKEND_SECRET key
108+
- name: backend-auth-secret
109+
----
110+
56111
.Verification
57112
* In the {product-very-short} console, confirm that the Orchestrator frontend and backend features are available.

0 commit comments

Comments
 (0)