Skip to content

Commit 49dc80c

Browse files
committed
Added changes after review
1 parent 7cb155a commit 49dc80c

3 files changed

Lines changed: 38 additions & 24 deletions

File tree

charts/backstage/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ sources: []
4747
# This is the chart version. This version number should be incremented each time you make changes
4848
# to the chart and its templates, including the app version.
4949
# Versions are expected to follow Semantic Versioning (https://semver.org/)
50-
version: 4.2.0
50+
version: 4.2.1

charts/backstage/README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# RHDH Backstage Helm Chart for OpenShift (Community Version)
33

4-
![Version: 4.2.0](https://img.shields.io/badge/Version-4.2.0-informational?style=flat-square)
4+
![Version: 4.2.1](https://img.shields.io/badge/Version-4.2.1-informational?style=flat-square)
55
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
66

77
A Helm chart for deploying Red Hat Developer Hub.
@@ -324,16 +324,19 @@ upstream:
324324

325325
## Installing RHDH with Orchestrator
326326

327-
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.
328-
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the following way:
327+
Orchestrator brings serverless workflows into Backstage, focusing on the journey for application migration to the cloud, onboarding developers, and user-made workflows of Backstage actions or external systems.
328+
Orchestrator is a flavor of RHDH, and can be installed alongside RHDH in the same namespace and in the following way:
329329

330-
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
330+
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 prerequisites required to deploy the Orchestrator-flavored RHDH. This process will include installing cluster-wide resources, so should be done with admin privileges:
331331
```
332-
helm install <release_name> rhdh-developer/orchestrator-infra
332+
helm repo add bitnami https://charts.bitnami.com/bitnami
333+
helm repo add backstage https://backstage.github.io/charts
334+
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart
335+
336+
helm install <release_name> rhdh-developer/redhat-developer-hub-orchestrator-infra
333337
```
334-
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed.
335-
3. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
336-
4. Install backstage chart with helm, setting orchestrator to be enabled, like so:
338+
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed. To do so, follow the post-install notes given by the chart, or see them [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/orchestrator-infra/templates/NOTES.txt)
339+
3. Install the `backstage` chart with Helm, enabling orchestrator, serverlessLogicOperator, and serverlessOperator, like so:
337340
338341
```
339342
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true
@@ -364,10 +367,14 @@ and populate the following values in the values.yaml:
364367
externalDBsecretRef: <cred-secret>
365368
externalDBName: ""
366369
```
367-
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.
370+
Please note that `externalDBName` is the name of the user-configured existing database, not the database that the orchestrator and sonataflow resources will use.
368371

369-
Finally, install the helm chart (including setting up the external DB):
372+
Finally, install the Helm Chart (including [setting up the external DB](https://github.com/redhat-developer/rhdh-chart/blob/main/docs/external-db.md)):
370373
```
371-
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
372-
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
374+
helm install <release_name> rhdh-developer/backstage \
375+
--set orchestrator.enabled=true \
376+
--set orchestrator.serverlessLogicOperator.enabled=true \
377+
--set orchestrator.serverlessOperator.enabled=true \
378+
--set orchestrator.sonataflowPlatform.externalDBsecretRef=<cred-secret> \
379+
--set orchestrator.sonataflowPlatform.externalDBName=example
373380
```

charts/backstage/README.md.gotmpl

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -264,16 +264,19 @@ upstream:
264264

265265
## Installing RHDH with Orchestrator
266266

267-
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.
268-
Orchestrator is a flavor of RHDH, and can be installed alongside the RHDH in the same namespace and in the following way:
267+
Orchestrator brings serverless workflows into Backstage, focusing on the journey for application migration to the cloud, onboarding developers, and user-made workflows of Backstage actions or external systems.
268+
Orchestrator is a flavor of RHDH, and can be installed alongside RHDH in the same namespace and in the following way:
269269

270-
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
270+
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 prerequisites required to deploy the Orchestrator-flavored RHDH. This process will include installing cluster-wide resources, so should be done with admin privileges:
271271
```
272-
helm install <release_name> rhdh-developer/orchestrator-infra
272+
helm repo add bitnami https://charts.bitnami.com/bitnami
273+
helm repo add backstage https://backstage.github.io/charts
274+
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart
275+
276+
helm install <release_name> rhdh-developer/redhat-developer-hub-orchestrator-infra
273277
```
274-
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed.
275-
3. Enable serverlessLogicOperator and serverlessOperator in the backstage values.
276-
4. Install backstage chart with helm, setting orchestrator to be enabled, like so:
278+
2. Manually approve the Install Plans created by the chart, and wait for the Openshift Serverless and Openshift Serverless Logic Operators to be deployed. To do so, follow the post-install notes given by the chart, or see them [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/orchestrator-infra/templates/NOTES.txt)
279+
3. Install the `backstage` chart with Helm, enabling orchestrator, serverlessLogicOperator, and serverlessOperator, like so:
277280

278281
```
279282
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true
@@ -304,10 +307,14 @@ and populate the following values in the values.yaml:
304307
externalDBsecretRef: <cred-secret>
305308
externalDBName: ""
306309
```
307-
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.
310+
Please note that `externalDBName` is the name of the user-configured existing database, not the database that the orchestrator and sonataflow resources will use.
308311

309-
Finally, install the helm chart (including setting up the external DB):
312+
Finally, install the Helm Chart (including [setting up the external DB](https://github.com/redhat-developer/rhdh-chart/blob/main/docs/external-db.md)):
310313
```
311-
helm install <release_name> rhdh-developer/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
312-
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
314+
helm install <release_name> rhdh-developer/backstage \
315+
--set orchestrator.enabled=true \
316+
--set orchestrator.serverlessLogicOperator.enabled=true \
317+
--set orchestrator.serverlessOperator.enabled=true \
318+
--set orchestrator.sonataflowPlatform.externalDBsecretRef=<cred-secret> \
319+
--set orchestrator.sonataflowPlatform.externalDBName=example
313320
```

0 commit comments

Comments
 (0)