Helm Chart configuration reference
Configure and customize your RHDH deployment with Helm Chart.
Abstract
1. Helm Chart configuration reference
Use the overview of default Helm Chart values to configure and customize your RHDH deployment.
The values are organized into five main categories, which cover the key namespaces that organize the chart’s hierarchical configuration structure:
- Global
- Orchestrator
- Route
- Test
- Upstream
1.1. Display a complete list of Helm Chart values with Helm CLI
Use the available options to configure Red Hat Developer Hub with Helm Charts: the Helm deployment method specific configuration files.
Procedure
Pull the released RHDH Helm Chart, including all its dependencies:
$ helm pull redhat-developer-hub \ --repo https://charts.openshift.io \ --version {product-chart-version} \ --untarView default values:
View default values of the RHDH Chart.
$ helm show values redhat-developer-hub
View default values of the upstream Backstage Chart. The fields can be set under the
upstreamscope when deploying the RHDH Chart.$ helm show values redhat-developer-hub/charts/backstage
OPTIONAL: View default values of the upstream PostgreSQL Chart, which is a dependency of the upstream Backstage Chart.
ImportantUsing the local PostgreSQL database is not recommended for production, as you should be using your own external database. However, it allows for visibility into the local database.
The fields can be set under the
upstream.postgresqlscope when deploying the RHDH Chart.$ helm show values redhat-developer-hub/charts/backstage/charts/postgresql
1.2. Root namespace value
Use the root namespace value to customize resource names.
|
Key |
Description |
Type |
Default |
|
|
Lets you customize resource names. Can be used at the root level and upstream level. |
string |
|
1.3. Global namespace values
Use the global namespace values to define cross-cutting configurations that affect multiple chart components.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
Enables service authentication within Backstage instance. |
object |
|
|
|
Backend service to service authentication. |
object |
|
|
|
Enables backend service to service authentication. Generates a secret value unless configured otherwise. |
bool |
|
|
|
Uses an existing secret. |
string |
|
|
|
Uses a specified value. |
string |
|
|
|
Catalog index configuration for automatic plugin discovery. The |
object |
|
|
|
Catalog index image registry. |
string |
|
|
|
Catalog index image repository. |
string |
|
|
|
Catalog index image tag or digest. |
string |
|
|
|
Shorthand for users who do not want to specify a custom hostname. Used only with the default upstream.backstage.appConfig value and with OpenShift Container Platform Route enabled. |
string |
|
|
|
Array of |
list |
|
|
|
List of dynamic plugins included inside the |
string |
|
|
|
List of dynamic plugins. Every plugin package is defined as an NPM package name specifier. This list can potentially override the list of plugins in include files. |
list |
|
|
|
Custom hostname shorthand that overrides |
string |
|
|
|
Global Docker registry secret names as an array. |
list |
|
|
|
Global Docker image registry. |
string |
|
1.4. Orchestrator namespace values
Use orchestrator namespace values to configure the orchestrator subsystem.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
Enables orchestrator integration. |
bool |
|
|
|
List of orchestrator plugins and their configuration. |
list |
default list of orchestrator plugins to enable when |
|
|
Enables |
bool |
|
|
|
Image for the container used by the |
string |
|
|
|
Image for the container used by the SonataFlow data index. [NOTE] ==== This is an optional image for disconnected environments. ==== |
string |
|
|
|
Specifies which broker to integrate into SonataFlow event-driven workflows. |
string |
|
|
|
Specifies the Kubernetes namespace that contains the broker resource to integrate into SonataFlow event-driven workflows. |
string |
|
|
|
Host for the user-configured external database. |
string |
|
|
|
Name for the user-configured external database. |
string |
|
|
|
Port for the user-configured external database. |
string |
|
|
|
Name for the user-created secret to connect an external database. |
string |
|
|
|
Image for the |
string |
|
|
|
Image for the container used by the SonataFlow jobs service. [NOTE] === This is an optional value used for disconnected environments. ==== |
string |
|
|
|
Controls if monitoring is enabled for SonataFlow when using the Orchestrator. |
bool |
|
|
|
Sets the maximum CPU allocation for SonataFlow’s build resources. |
string |
|
|
|
Sets the maximum memory allocation for SonataFlow’s build resources. |
string |
|
|
|
Sets the minimum CPU allocation for SonataFlow’s build resources. |
string |
|
|
|
Sets the minimum memory allocation for SonataFlow’s build resources. |
string |
|
1.5. Route namespace values
Use route namespace values to configure OpenShift Container Platform route-specific settings.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
OpenShift Route parameters. |
object |
|
|
|
Route-specific annotations. |
object |
|
|
|
Enables the creation of the route resource. |
bool |
|
|
|
Sets the host attribute to a custom value. If not set, the value is generated by Openshift. Important
Make sure the value matches your |
string |
|
|
|
Path that the router watches for to route traffic to the service. |
string |
|
|
|
Route TLS parameters. |
object |
|
|
|
Optional value. Cert authority certificate contents. |
string |
|
|
|
Certificate contents. |
string |
|
|
|
CA certificate contents of the final destination. Used by routers for health checks on the secure connection. Important
Provide this file path if you use reencrypt termination. If not specified, the router might provide its own destination CA and perform hostname validation using the short service name ( |
string |
|
|
|
Enable TLS configuration for the host defined with the |
bool |
|
|
|
Indicates the desired behavior for insecure connections to a route. |
string |
|
|
|
Key file contents. |
string |
|
|
|
Specifies TLS termination. |
string |
|
|
|
Wildcard policy for the route. |
string |
|
1.6. Test namespace values
Use test namespace values to configure parameters that run when tests are initiated to verify RHDH deployment.
| Test | Description | Object | Default |
|---|---|---|---|
|
|
Tests pod parameters. |
object |
|
|
|
Enables the test-connection pod used for testing the release using |
bool |
|
|
|
Tests connection pod image registry. |
string |
|
|
|
Test connection pod image repository. Note
The image must contain both the |
string |
|
|
|
Tests connection pod image tag. Note
The image must contain both the |
string |
|
|
|
Injects a fake dynamic plugins Important This value is only used for testing purposes and should not be used in production. |
bool |
|
1.7. Upstream namespace values
Use the upstream namespace values for configurations that are passed to the upstream Backstage Helm chart.
Specific upstream namespace values are also used in the global configuration of RHDH. Changing these values in the upstream namespace can override the global configuration.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
Upstream Backstage chart configuration. |
object |
Openshift-compatible settings |
|
|
Ephemeral volume that contains the dynamic plugins installed by the |
object |
|
|
|
Size of the ephemeral volume that contains the dynamic plugins. |
string |
|
|
|
Image used by the |
string |
value of ‘upstream.backstage.image’ |
1.8. Additional upstream Backstage Chart values
Add the following Backstage Chart values to the upstream namespace to customize your RHDH configuration further.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
Backstage parameters. |
object |
see below |
|
|
Pod assignment affinity. |
object |
|
|
|
Additional custom annotations for the Deployment resource. |
object |
|
|
|
Generates a |
object |
|
|
|
Backstage container command arguments. |
list |
|
|
|
Autoscaling configuration. |
object |
|
|
|
Backstage container command. |
list |
|
|
|
Deployment container ports. |
object |
|
|
|
Container security settings. |
object |
|
|
|
Extra app configuration files to inline into command arguments. |
list |
|
|
|
Deployment sidecars. |
list |
|
|
|
Backstage container environment variables. |
list |
|
|
|
Backstage container environment variables from existing |
list |
|
|
|
Backstage container environment variables from existing secrets. |
list |
|
|
|
Backstage container additional ports. |
list |
|
|
|
Backstage container additional volume mounts. |
list |
|
|
|
Backstage container additional volumes. |
list |
|
|
|
Host Aliases for the pod. |
list |
|
|
|
Backstage image digest. Takes precedence over image tag. Important The image digest must match the repository used for RHDH. |
string |
|
|
|
Specifies the image pull policy. |
string |
|
|
|
Specifies an array of Important Secrets must be manually created in the namespace. |
list |
|
|
|
Backstage image registry. |
string |
|
|
|
Backstage image repository. |
string |
|
|
|
Backstage image tag. Note It is recommended to use immutable tags. |
string |
|
|
|
Backstage container init containers. |
list |
|
|
|
Directory containing the backstage installation. Important
Before using this value, check that there are no restrictions placed on customizing |
string |
|
|
|
Liveness probe. |
object |
|
|
|
Node labels for pod assignment. |
object |
|
|
|
Pod disruption budget configuration. |
object |
|
|
|
Annotations added to the backend deployment pods. |
object |
|
|
|
Labels added to the backend deployment pods. |
object |
|
|
|
Pod security settings. They apply to all containers in the pod. Important Before using this value, check the Openshift security policy. |
object |
|
|
|
Readiness probe. |
object |
|
|
|
Number of deployment replicas. |
int |
|
|
|
Resource requests and limits. |
object |
|
|
|
Defines the count of deployment revisions to be kept. Note
For GitOps deployment, the count might be set to |
int |
|
|
|
Startup probe. |
object |
|
|
|
Node tolerations for server scheduling to nodes with taints. |
list |
|
|
|
Topology spread constraints for pod assignment. |
list |
|
|
|
Default Kubernetes cluster domain. Important Use this value only if the underlying Backstage chart exposes and uses it. |
string |
|
|
|
Annotations to add to all deployed objects. |
object |
|
|
|
Labels to add to all deployed objects. |
object |
|
|
|
Enables diagnostic mode in the deployment. |
object |
|
|
|
Arguments to override all containers in the deployment. |
list |
|
|
|
Command to override all containers in the deployment. |
list |
|
|
|
Enables diagnostic mode. |
bool |
|
|
|
Array of extra objects to deploy with the release. |
list |
|
|
|
String to fully override |
string |
|
|
|
Ingress parameters. |
object |
|
|
|
Additional annotations for the Ingress resource. |
object |
|
|
|
Name of the |
string |
|
|
|
Enables the creation of the Ingress resource. |
bool |
|
|
|
List of additional hostnames to be covered with this Ingress record, such as |
list |
|
|
|
The TLS configuration for additional hostnames to be covered with this Ingress record. |
list |
|
|
|
Hostname to be used to expose the route to access the Backstage application, such as |
string |
|
|
|
Path to be used to expose the full route to access the Backstage application, such as |
string |
|
|
|
Ingress TLS parameters. |
object |
|
|
|
Enables TLS configuration for the host defined at |
bool |
|
|
|
The name to which the TLS Secret is called. |
string |
|
|
|
Overrides Kubernetes version. |
string |
|
|
|
Metrics configuration. |
object |
|
|
|
Prometheus Operator |
object |
|
|
|
|
object |
|
|
|
Creates a Important Before you enable this value, you must install Prometheus Operator in your cluster. |
bool |
|
|
|
|
string |
|
|
|
Additional |
object |
|
|
|
Important
The |
string |
|
|
|
Important
If you use OpenTelemetry, the port must be explicitly specified. The default port for OpenTelemetry is |
string |
|
|
|
String to partially override |
string |
|
|
|
Additional custom egress rules. |
list |
|
|
|
Denies external connections. Important Do not enable this value when working with external databases. |
bool |
|
|
|
Specifies if a |
bool |
|
|
|
Additional custom Ingress rules. |
list |
|
|
|
Namespace selector label allowed to access the Backstage instance. |
object |
|
|
|
Pod selector label allowed to access the Backstage instance. |
object |
|
|
|
PostgreSQL chart configuration. |
object |
see below |
|
|
PostgreSQL architecture. |
string |
|
|
|
Authentication details of the PostgreSQL database. |
object |
|
|
|
Name of existing secret used for PostgreSQL credentials. |
string |
|
|
|
Password created by custom user. |
string |
|
|
|
The secret keys PostgreSQL looks for to retrieve the relevant password. |
object |
|
|
|
The key in the existing secret where PostgreSQL looks for the admin password. |
string |
|
|
|
The key in the existing secret where PostgreSQL looks for the replication password. |
string |
|
|
|
The key in the existing secret where PostgreSQL looks for the user password. |
string |
|
|
|
Creates a name for a custom user. |
string |
|
|
|
Enables the PostgreSQL helm chart. Note PostgreSQL has many values you can use in RHDH. However, using your own external database is recommended for production. |
bool |
|
|
|
Changes default PostgreSQL image location. |
object |
|
|
|
Service parameters. |
object |
see below |
|
|
Additional custom annotations for Backstage service. |
object |
|
|
|
Backstage service cluster IP. |
string |
|
|
|
Backstage service external traffic policy. |
string |
|
|
|
Extra ports to expose in the Backstage service. Typically used with the sidecar value. |
list |
|
|
|
IP families. |
list |
|
|
|
IP family policy. |
string |
|
|
|
Backstage service Load Balancer IP. |
string |
|
|
|
Load Balancer sources. |
list |
|
|
|
Node port for the Backstage client connections. Note Choose a port between 30000-32767. |
object |
|
|
|
Backstage SVC port for client connections. |
object |
|
|
|
Backstage SVC port name. |
string |
|
|
|
Backstage SVC target port referencing receiving pod container port. |
string |
|
|
|
Controls where client requests go: either the same pod or round-robin. |
string |
|
|
|
Kubernetes service type. |
string |
|
|
|
Service account configuration. |
object |
see below |
|
|
Additional custom annotations for the |
object |
|
|
|
Auto-mounts the service account token in the pod. |
bool |
|
|
|
Enable the creation of a |
bool |
|
|
|
Additional custom labels for the |
object |
|
|
|
Name of the ServiceAccount to use. Note
If you do not set this value set and |
string |
|
2. Helm Chart Orchestrator infrastructure reference
Use the overview of default Helm Chart values to configure and customize your Orchestrator infrastructure on OpenShift Container Platform.
2.1. Display a complete list of Orchestrator infrastructure values with Helm CLI
Use the available options to configure Orchestrator infrastructure with Helm Chart: the Helm deployment method specific configuration files.
Procedure
Pull the released RHDH Orchestrator Infrastructure Helm Chart, including all its dependencies:
helm show values redhat-developer-hub-orchestrator-infra \ --repo https://charts.openshift.io \ --version {product-chart-version}
2.2. Orchestrator infrastructure Helm Chart values
Use these Helm Chart values to deploy the Orchestrator infrastructure on OpenShift Container Platform.
| Key | Description | Type | Default |
|---|---|---|---|
|
|
Specifies if operator is deployed by the Helm chart. |
bool |
|
|
|
Specifies the namespace where the operator is deployed. |
string |
|
|
|
Specifies the channel of an operator package to subscribe to. |
string |
|
|
|
Specifies if update should be installed automatically. |
string |
|
|
|
Name of the operator package. |
string |
|
|
|
Name of the catalog source. |
string |
|
|
|
Name of the catalog source namespace. |
string |
|
|
|
Specifies the initial version of the operator. Important The version must match the custom resource definitions (CRDs) installed by the chart. |
string |
|
|
|
Specifies if the operator is deployed by the chart. |
bool |
|
|
|
Specifies the namespace where the operator is deployed. |
string |
|
|
|
Specifies the channel of an operator package to subscribe to. |
string |
|
|
|
Specifies if the update is installed automatically. |
string |
|
|
|
Name of the operator package. |
string |
|
|
|
Name of the catalog source. |
string |
|
|
|
Name of the catalog source namespace. |
string |
|
|
|
Specifies if the test pod used for testing the release with helm test is created. |
bool |
|
|
|
Test pod image. |
string |
|