Skip to content

Added documentation for MAX_ENTRY_SIZE override #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
elai-shalev wants to merge 2 commits into from
Closed

Added documentation for MAX_ENTRY_SIZE override #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81f3001
Added documentation for MAX_ENRY_SIZE override
elai-shalev Apr 29, 2025
d40cb91
chart bump
elai-shalev Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/backstage/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ sources:
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 4.0.0
version: 4.0.1
36 changes: 33 additions & 3 deletions charts/backstage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# RHDH Backstage Helm Chart for OpenShift (Community Version)

[![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)
![Version: 4.0.0](https://img.shields.io/badge/Version-4.0.0-informational?style=flat-square)
![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A Helm chart for deploying Red Hat Developer Hub.
Expand Down Expand Up @@ -348,6 +348,33 @@ helm install <release_name> charts/orchestrator-infra
3. Install backstage chart with helm, setting orchestrator to be enabled.
4. Enable serverlessLogicOperator and serverlessOperator in the backstage values.

### Additional value configurations

To install orchestrator, you must edit the values.yaml to include the follwing MAX_ENTRY_SIZE enviroment variable in the install-dynamic-plugins init container:
```env:
- name: NPM_CONFIG_USERCONFIG
value: /opt/app-root/src/.npmrc.dynamic-plugins
- name: MAX_ENTRY_SIZE
value: '30000000'
```
You can do this by editing and overriding the base values.yaml for the backstage chart, which can be found [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml)

### Enablement of Notifications Plugin
To enable the notifications and signals plugin, please edit the dynamic plugin configmap post-installation and add the following:
```
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-signals"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
```
Enabling these plugins will allow to recieve notifications from workflows running with Orchestrator.

### Using Orchestrator while configuring an ExternalDB

To use orchestrator with an external DB, please follow the instructions in [our documentation](https://github.com/redhat-developer/rhdh-chart/blob/main/docs/external-db.md)
and populate the following values in the values.yaml:
```bash
Expand All @@ -356,8 +383,11 @@ and populate the following values in the values.yaml:
```
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.

To avoid setting varialbles inline in the helm command, you can prepeare an alternatve values file, like <orchestrator-overriding-values.yaml> that will encapsulate all value changes that are required smoothly install Orchestrator via the backstage helm chart.
The default values.yaml can be found [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml)
Finally, install the helm chart:

```
helm install <release_name> charts/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
helm install <release_name> backstage/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
--set externalDBsecretRef=<cred-secret> --set externalDBName=example --values=<orchestrator-overriding-values.yaml>
Comment thread
rm3l marked this conversation as resolved.
```
34 changes: 32 additions & 2 deletions charts/backstage/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,33 @@ helm install <release_name> charts/orchestrator-infra
3. Install backstage chart with helm, setting orchestrator to be enabled.
4. Enable serverlessLogicOperator and serverlessOperator in the backstage values.

### Additional value configurations

To install orchestrator, you must edit the values.yaml to include the follwing MAX_ENTRY_SIZE enviroment variable in the install-dynamic-plugins init container:
```env:
- name: NPM_CONFIG_USERCONFIG
value: /opt/app-root/src/.npmrc.dynamic-plugins
- name: MAX_ENTRY_SIZE
value: '30000000'
```
You can do this by editing and overriding the base values.yaml for the backstage chart, which can be found [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml)

### Enablement of Notifications Plugin
To enable the notifications and signals plugin, please edit the dynamic plugin configmap post-installation and add the following:
```
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-signals"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
- disabled: false
package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
```
Enabling these plugins will allow to recieve notifications from workflows running with Orchestrator.

### Using Orchestrator while configuring an ExternalDB

To use orchestrator with an external DB, please follow the instructions in [our documentation](https://github.com/redhat-developer/rhdh-chart/blob/main/docs/external-db.md)
and populate the following values in the values.yaml:
```bash
Expand All @@ -291,8 +318,11 @@ and populate the following values in the values.yaml:
```
Please note that externalDBName is the name of the user-configured existing database, not the database that orchestrator and sonataflow resources will use.

To avoid setting varialbles inline in the helm command, you can prepeare an alternatve values file, like <orchestrator-overriding-values.yaml> that will encapsulate all value changes that are required smoothly install Orchestrator via the backstage helm chart.
The default values.yaml can be found [here](https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml)
Finally, install the helm chart:

```
helm install <release_name> charts/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
--set externalDBsecretRef=<cred-secret> --set externalDBName=example
helm install <release_name> backstage/backstage --set orchestrator.enabled=true --set orchestrator.serverlessLogicOperator.enabled=true --set orchestrator.serverlessOperator.enabled=true \
--set externalDBsecretRef=<cred-secret> --set externalDBName=example --values=<orchestrator-overriding-values.yaml>
```
Loading