Skip to content

Commit 421e980

Browse files
rm3ljenniferubah
andauthored
[release-1.7] doc: add backend_secret config to orchestrator (#1567) (#1571)
Co-authored-by: Jennifer Ubah <10870059+jenniferubah@users.noreply.github.com>
1 parent 932a6ff commit 421e980

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/orchestrator.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,9 @@ To enable the orchestrator plugin, you should refer the dynamic plugins ConfigMa
7979
disabled: false
8080
```
8181
82-
See [example](/examples/orchestrator.yaml) for a complete configuration of the orchestrator plugin.
82+
See [example](/examples/orchestrator.yaml) for a complete configuration of the orchestrator plugin.
83+
Ensure to add a secret with the BACKEND_SECRET key/value and update
84+
the secret name in the `Backstage` CR under the `extraEnvs` field.
8385

8486
#### Plugin registry
8587

examples/orchestrator.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ data:
3030
guest:
3131
# using the guest user to query the '/api/dynamic-plugins-info/loaded-plugins' endpoint.
3232
dangerouslyAllowOutsideDevelopment: true
33+
backend:
34+
auth:
35+
externalAccess:
36+
- type: static
37+
options:
38+
token: ${BACKEND_SECRET}
39+
subject: orchestrator
40+
---
41+
apiVersion: v1
42+
kind: Secret
43+
metadata:
44+
name: backend-auth-secret
45+
stringData:
46+
# generated with the command below (from https://backstage.io/docs/auth/service-to-service-auth/#setup):
47+
# node -p 'require("crypto").randomBytes(24).toString("base64")'
48+
BACKEND_SECRET: "R2FxRVNrcmwzYzhhN3l0V1VRcnQ3L1pLT09WaVhDNUEK" # notsecret
3349
---
3450
apiVersion: rhdh.redhat.com/v1alpha3
3551
kind: Backstage
@@ -41,3 +57,6 @@ spec:
4157
configMaps:
4258
- name: app-config-rhdh
4359
dynamicPluginsConfigMapName: orchestrator-plugin
60+
extraEnvs:
61+
secrets:
62+
- name: backend-auth-secret # secret that contains the BACKEND_SECRET key

0 commit comments

Comments
 (0)