Skip to content

Commit bb6d7bf

Browse files
jmagakGitHub Actions
andauthored
RHDHBUGS-2056 Missing steps in the orchestrator installment downstream docs (#1395)
* 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 6e2826d commit bb6d7bf

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
@@ -18,7 +18,7 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy
1818
- package: "@redhat/backstage-plugin-orchestrator@<plugin_version>"
1919
disabled: false
2020
----
21-
21+
+
2222
.Example: Complete configuration of the Orchestrator plugin
2323
[source,yaml]
2424
----
@@ -54,5 +54,60 @@ spec:
5454
dynamicPluginsConfigMapName: orchestrator-plugin
5555
----
5656

57+
. Create a secret containing the `BACKEND_SECRET` value as shown in the following example:
58+
+
59+
[source,yaml]
60+
----
61+
apiVersion: v1
62+
kind: ConfigMap
63+
metadata:
64+
name: app-config-rhdh
65+
data:
66+
app-config-rhdh.yaml: |-
67+
auth:
68+
environment: development
69+
providers:
70+
guest:
71+
# using the guest user to query the '/api/dynamic-plugins-info/loaded-plugins' endpoint.
72+
dangerouslyAllowOutsideDevelopment: true
73+
backend:
74+
auth:
75+
externalAccess:
76+
- type: static
77+
options:
78+
token: ${BACKEND_SECRET}
79+
subject: orchestrator
80+
---
81+
apiVersion: v1
82+
kind: Secret
83+
metadata:
84+
name: backend-auth-secret
85+
stringData:
86+
# generated with the command below (from https://backstage.io/docs/auth/service-to-service-auth/#setup):
87+
# node -p 'require("crypto").randomBytes(24).toString("base64")'
88+
# notsecret
89+
BACKEND_SECRET: "R2FxRVNrcmwzYzhhN3l0V1VRcnQ3L1pLT09WaVhDNUEK"
90+
----
91+
92+
. Configure your {product-custom-resource-type} CR to update the secret name in the `extraEnvs` field as shown in the following example:
93+
+
94+
[source,yaml]
95+
----
96+
apiVersion: rhdh.redhat.com/v1alpha4
97+
kind: Backstage
98+
metadata:
99+
name: orchestrator
100+
spec:
101+
application:
102+
appConfig:
103+
configMaps:
104+
- name: app-config-rhdh
105+
dynamicPluginsConfigMapName: orchestrator-plugin
106+
extraEnvs:
107+
secrets:
108+
# secret that contains the BACKEND_SECRET key
109+
- name: backend-auth-secret
110+
----
111+
57112
.Verification
58113
* In the {product-very-short} console, confirm that the Orchestrator frontend and backend features are available.

0 commit comments

Comments
 (0)