Skip to content

Commit 438f3db

Browse files
committed
fix: documentation bug for backstage chart readme, in orchestrator
1 parent 0ef375e commit 438f3db

3 files changed

Lines changed: 28 additions & 16 deletions

File tree

charts/backstage/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ sources:
4444
# This is the chart version. This version number should be incremented each time you make changes
4545
# to the chart and its templates, including the app version.
4646
# Versions are expected to follow Semantic Versioning (https://semver.org/)
47-
version: 4.0.1
47+
version: 4.0.2

charts/backstage/README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# RHDH Backstage Helm Chart for OpenShift (Community Version)
33

44
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/rhdh-chart&style=flat-square)](https://artifacthub.io/packages/search?repo=rhdh-chart)
5-
![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square)
5+
![Version: 4.0.2](https://img.shields.io/badge/Version-4.0.2-informational?style=flat-square)
66
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
77

88
A Helm chart for deploying Red Hat Developer Hub.
@@ -338,19 +338,25 @@ upstream:
338338
## Installing RHDH with Orchestrator
339339

340340
Orchestrator brings serverless workflows into Backstage, focusing on the journey for application migration to the cloud, on boarding developers ,and user-made workflows of Backstage actions or external systems.
341-
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the folloing way:
341+
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the following way:
342342

343-
1. Have an admin install the orchestrator-infra helm chart, which will install the pre-requisites required to install RHDH flavored Orchestrator. This proccess will include installing cluster-wide resources, so should be done with admin privileges
343+
1. Have an admin install the [orchestrator-infra helm chart](https://github.com/redhat-developer/rhdh-chart/tree/main/charts/orchestrator-infra#readme), which will install the pre-requisites required to install RHDH flavored Orchestrator. This proccess will include installing cluster-wide resources, so should be done with admin privileges
344344
```
345-
helm install <release_name> charts/orchestrator-infra
345+
helm install <release_name> rhdh-developer/orchestrator-infra
346346
```
347347
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed.
348-
3. Install backstage chart with helm, setting orchestrator to be enabled.
349-
4. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
348+
3. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
349+
4. Install backstage chart with helm, setting orchestrator to be enabled, like so:
350+
351+
```
352+
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true
353+
```
350354
351355
### Enablement of Notifications Plugin
352356
357+
The orchestrator has a dependency on the Notifications plugin.
353358
To enable the notifications and signals plugin, please edit the dynamic plugin configmap after the installation and add the following:
359+
354360
```
355361
- disabled: false
356362
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
@@ -373,8 +379,8 @@ and populate the following values in the values.yaml:
373379
```
374380
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.
375381

376-
Finally, install the helm chart:
382+
Finally, install the helm chart (including setting up the external DB):
377383
```
378-
helm install <release_name> charts/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
384+
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
379385
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
380386
```

charts/backstage/README.md.gotmpl

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -273,19 +273,25 @@ upstream:
273273
## Installing RHDH with Orchestrator
274274

275275
Orchestrator brings serverless workflows into Backstage, focusing on the journey for application migration to the cloud, on boarding developers ,and user-made workflows of Backstage actions or external systems.
276-
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the folloing way:
276+
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the following way:
277277

278-
1. Have an admin install the orchestrator-infra helm chart, which will install the pre-requisites required to install RHDH flavored Orchestrator. This proccess will include installing cluster-wide resources, so should be done with admin privileges
278+
1. Have an admin install the [orchestrator-infra helm chart](https://github.com/redhat-developer/rhdh-chart/tree/main/charts/orchestrator-infra#readme), which will install the pre-requisites required to install RHDH flavored Orchestrator. This proccess will include installing cluster-wide resources, so should be done with admin privileges
279279
```
280-
helm install <release_name> charts/orchestrator-infra
280+
helm install <release_name> rhdh-developer/orchestrator-infra
281281
```
282282
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed.
283-
3. Install backstage chart with helm, setting orchestrator to be enabled.
284-
4. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
283+
3. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
284+
4. Install backstage chart with helm, setting orchestrator to be enabled, like so:
285+
286+
```
287+
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true
288+
```
285289

286290
### Enablement of Notifications Plugin
287291

292+
The orchestrator has a dependency on the Notifications plugin.
288293
To enable the notifications and signals plugin, please edit the dynamic plugin configmap after the installation and add the following:
294+
289295
```
290296
- disabled: false
291297
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
@@ -308,8 +314,8 @@ and populate the following values in the values.yaml:
308314
```
309315
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.
310316

311-
Finally, install the helm chart:
317+
Finally, install the helm chart (including setting up the external DB):
312318
```
313-
helm install <release_name> charts/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
319+
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
314320
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
315321
```

0 commit comments

Comments
 (0)