Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/blank.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/chore.md

This file was deleted.

5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/enhancement.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/epic.md

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/on-new-issue.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2022 The Janus-IDP Authors
Copyright 2022 The RHDH Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion charts/backstage/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ sources: []
# Versions are expected to follow Semantic Versioning (https://semver.org/)
# Note that when this chart is published to https://github.com/openshift-helm-charts/charts
# it will follow the RHDH versioning 1.y.z
version: 5.0.0
version: 5.0.1
24 changes: 11 additions & 13 deletions charts/backstage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# RHDH Backstage Helm Chart for OpenShift

![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square)
![Version: 5.0.1](https://img.shields.io/badge/Version-5.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, which is a Red Hat supported version of Backstage.
Expand Down Expand Up @@ -30,7 +30,7 @@ helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add backstage https://backstage.github.io/charts
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart

helm install my-backstage redhat-developer/backstage --version 5.0.0
helm install my-backstage redhat-developer/backstage --version 5.0.1
```

## Introduction
Expand Down Expand Up @@ -92,8 +92,6 @@ helm upgrade -i <release_name> redhat-developer/backstage

### Installing from an OCI Registry

Note: this repo replaces https://github.com/janus-idp/helm-backstage, which has been deprecated in Feb 2024.

Charts are also available in OCI format. The list of available releases can be found [here](https://quay.io/repository/rhdh/chart?tab=tags).

Install one of the available versions:
Expand Down Expand Up @@ -175,7 +173,7 @@ Kubernetes: `>= 1.27.0-0`
| global.catalogIndex | Catalog index configuration for automatic plugin discovery. The `install-dynamic-plugins.py` script pulls this image if the `CATALOG_INDEX_IMAGE` environment variable is set. The `dynamic-plugins.default.yaml` file will be extracted and written to `dynamic-plugins-root` volume mount. | object | `{"image":{"registry":"quay.io","repository":"rhdh/plugin-catalog-index","tag":"1.9"}}` |
| global.clusterRouterBase | Shorthand for users who do not want to specify a custom HOSTNAME. Used ONLY with the DEFAULT upstream.backstage.appConfig value and with OCP Route enabled. | string | `"apps.example.com"` |
| global.dynamic.includes | Array of YAML files listing dynamic plugins to include with those listed in the `plugins` field. Relative paths are resolved from the working directory of the initContainer that will install the plugins (`/opt/app-root/src`). | list | `["dynamic-plugins.default.yaml"]` |
| global.dynamic.includes[0] | List of dynamic plugins included inside the `janus-idp/backstage-showcase` container image, some of which are disabled by default. This file ONLY works with the `janus-idp/backstage-showcase` container image. | string | `"dynamic-plugins.default.yaml"` |
| global.dynamic.includes[0] | List of dynamic plugins included inside the `rhdh` container image, some of which are disabled by default. This file ONLY works with the `rhdh` container image. | string | `"dynamic-plugins.default.yaml"` |
| global.dynamic.plugins | List of dynamic plugins, possibly overriding the plugins listed in `includes` files. Every item defines the plugin `package` as a [NPM package spec](https://docs.npmjs.com/cli/v10/using-npm/package-spec), an optional `pluginConfig` with plugin-specific backstage configuration, and an optional `disabled` flag to disable/enable a plugin listed in `includes` files. It also includes an `integrity` field that is used to verify the plugin package [integrity](https://w3c.github.io/webappsec-subresource-integrity/#integrity-metadata-description). | list | `[]` |
| global.host | Custom hostname shorthand, overrides `global.clusterRouterBase`, `upstream.ingress.host`, `route.host`, and url values in `upstream.backstage.appConfig`. | string | `""` |
| nameOverride | | string | `"developer-hub"` |
Expand Down Expand Up @@ -222,19 +220,19 @@ Kubernetes: `>= 1.27.0-0`
| upstream.backstage.extraVolumes[0] | Ephemeral volume that will contain the dynamic plugins installed by the initContainer below at start. | object | `{"ephemeral":{"volumeClaimTemplate":{"spec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"5Gi"}}}}},"name":"dynamic-plugins-root"}` |
| upstream.backstage.extraVolumes[0].ephemeral.volumeClaimTemplate.spec.resources.requests.storage | Size of the volume that will contain the dynamic plugins. It should be large enough to contain all the plugins. | string | `"5Gi"` |
| upstream.backstage.extraVolumes[5] | Ephemeral volume used by the install-dynamic-plugins init container to extract catalog entities from the catalog index image. Mounted at the /extensions path in the backstage-backend main container for automatic discovery by the extension catalog backend providers. | object | `{"emptyDir":{},"name":"extensions-catalog"}` |
| upstream.backstage.initContainers[0].image | Image used by the initContainer to install dynamic plugins into the `dynamic-plugins-root` volume mount. It could be replaced by a custom image based on this one. | string | `quay.io/janus-idp/backstage-showcase:latest` |
| upstream.backstage.initContainers[0].image | Image used by the initContainer to install dynamic plugins into the `dynamic-plugins-root` volume mount. It could be replaced by a custom image based on this one. | string | `quay.io/rhdh-community/rhdh:next` |

## Opinionated Backstage deployment

This chart defaults to an opinionated deployment of Backstage that provides user with a usable Backstage instance out of the box.

Features enabled by the default chart configuration:

1. Uses [janus-idp/backstage-showcase](https://github.com/janus-idp/backstage-showcase/) that pre-loads a lot of useful plugins and features
1. Uses [rhdh](https://github.com/redhat-developer/rhdh/) that pre-loads a lot of useful plugins and features
2. Exposes a `Route` for easy access to the instance
3. Enables OpenShift-compatible PostgreSQL database storage

For additional instance features please consult the [documentation for `janus-idp/backstage-showcase`](https://github.com/janus-idp/backstage-showcase/tree/main/showcase-docs).
For additional instance features please consult the [documentation for `rhdh`](https://github.com/redhat-developer/rhdh/tree/main/showcase-docs).

Additional features can be enabled by extending the default configuration at:

Expand All @@ -249,10 +247,10 @@ upstream:

## Features

This charts defaults to using the [latest Janus-IDP Backstage Showcase image](https://quay.io/janus-idp/backstage-showcase:latest) that is OpenShift compatible:
This charts defaults to using the [RHDH image](https://quay.io/rhdh-community/rhdh:next) that is OpenShift compatible:

```console
quay.io/janus-idp/backstage-showcase:latest
quay.io/rhdh-community/rhdh:next
```

Additionally this chart enhances the upstream Backstage chart with following OpenShift-specific features:
Expand Down Expand Up @@ -295,11 +293,11 @@ upstream:
backstage:
appConfig:
app:
baseUrl: 'https://{{- include "janus-idp.hostname" . }}'
baseUrl: 'https://{{- include "rhdh.hostname" . }}'
backend:
baseUrl: 'https://{{- include "janus-idp.hostname" . }}'
baseUrl: 'https://{{- include "rhdh.hostname" . }}'
cors:
origin: 'https://{{- include "janus-idp.hostname" . }}'
origin: 'https://{{- include "rhdh.hostname" . }}'
```

### Catalog Index Configuration
Expand Down
16 changes: 7 additions & 9 deletions charts/backstage/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,6 @@ helm upgrade -i <release_name> redhat-developer/backstage

### Installing from an OCI Registry

Note: this repo replaces https://github.com/janus-idp/helm-backstage, which has been deprecated in Feb 2024.

Charts are also available in OCI format. The list of available releases can be found [here](https://quay.io/repository/rhdh/chart?tab=tags).

Install one of the available versions:
Expand Down Expand Up @@ -162,11 +160,11 @@ This chart defaults to an opinionated deployment of Backstage that provides user

Features enabled by the default chart configuration:

1. Uses [janus-idp/backstage-showcase](https://github.com/janus-idp/backstage-showcase/) that pre-loads a lot of useful plugins and features
1. Uses [rhdh](https://github.com/redhat-developer/rhdh/) that pre-loads a lot of useful plugins and features
2. Exposes a `Route` for easy access to the instance
3. Enables OpenShift-compatible PostgreSQL database storage

For additional instance features please consult the [documentation for `janus-idp/backstage-showcase`](https://github.com/janus-idp/backstage-showcase/tree/main/showcase-docs).
For additional instance features please consult the [documentation for `rhdh`](https://github.com/redhat-developer/rhdh/tree/main/showcase-docs).

Additional features can be enabled by extending the default configuration at:

Expand All @@ -181,10 +179,10 @@ upstream:

## Features

This charts defaults to using the [latest Janus-IDP Backstage Showcase image](https://quay.io/janus-idp/backstage-showcase:latest) that is OpenShift compatible:
This charts defaults to using the [RHDH image](https://quay.io/rhdh-community/rhdh:next) that is OpenShift compatible:

```console
quay.io/janus-idp/backstage-showcase:latest
quay.io/rhdh-community/rhdh:next
```

Additionally this chart enhances the upstream Backstage chart with following OpenShift-specific features:
Expand Down Expand Up @@ -227,11 +225,11 @@ upstream:
backstage:
appConfig:
app:
baseUrl: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}'
baseUrl: 'https://{{"{{"}}- include "rhdh.hostname" . {{"}}"}}'
backend:
baseUrl: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}'
baseUrl: 'https://{{"{{"}}- include "rhdh.hostname" . {{"}}"}}'
cors:
origin: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}'
origin: 'https://{{"{{"}}- include "rhdh.hostname" . {{"}}"}}'
```

### Catalog Index Configuration
Expand Down
34 changes: 31 additions & 3 deletions charts/backstage/templates/_helpers.tpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{/*
Returns custom hostname
*/}}
{{- define "janus-idp.hostname" -}}
{{- define "rhdh.hostname" -}}
{{- if .Values.global.host -}}
{{- .Values.global.host -}}
{{- else if .Values.global.clusterRouterBase -}}
Expand All @@ -14,7 +14,7 @@ Returns custom hostname
{{/*
Returns a secret name for service to service auth
*/}}
{{- define "janus-idp.backend-secret-name" -}}
{{- define "rhdh.backend-secret-name" -}}
{{- if .Values.global.auth.backend.existingSecret -}}
{{- .Values.global.auth.backend.existingSecret -}}
{{- else -}}
Expand All @@ -25,7 +25,7 @@ Returns a secret name for service to service auth
{{/*
Sets the secretKeyRef name for Backstage to the PostgreSQL existing secret if it present
*/}}
{{- define "janus-idp.postgresql.secretName" -}}
{{- define "rhdh.postgresql.secretName" -}}
{{- if ((((.Values).global).postgresql).auth).existingSecret -}}
{{- .Values.global.postgresql.auth.existingSecret -}}
{{- else if .Values.postgresql.auth.existingSecret -}}
Expand All @@ -47,4 +47,32 @@ Referenced from: https://github.com/bitnami/charts/blob/main/bitnami/postgresql/
{{- else -}}
{{- printf "%s" (include "common.names.fullname" .) -}}
{{- end -}}
{{- end -}}

{{/*
DEPRECATED: The following templates are deprecated. Please use the corresponding "rhdh.*" templates instead.
*/}}

{{/*
DEPRECATED: Use "rhdh.hostname" instead.
Returns custom hostname
*/}}
{{- define "janus-idp.hostname" -}}
{{- include "rhdh.hostname" . -}}
{{- end -}}

{{/*
DEPRECATED: Use "rhdh.backend-secret-name" instead.
Returns a secret name for service to service auth
*/}}
{{- define "janus-idp.backend-secret-name" -}}
{{- include "rhdh.backend-secret-name" . -}}
{{- end -}}

{{/*
DEPRECATED: Use "rhdh.postgresql.secretName" instead.
Sets the secretKeyRef name for Backstage to the PostgreSQL existing secret if it present
*/}}
{{- define "janus-idp.postgresql.secretName" -}}
{{- include "rhdh.postgresql.secretName" . -}}
{{- end -}}
2 changes: 1 addition & 1 deletion charts/backstage/templates/route.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
{{- if $host }}
host: {{ $host }}
{{- else }}
host: {{ include "janus-idp.hostname" . }}
host: {{ include "rhdh.hostname" . }}
{{- end }}
{{- if .Values.route.path }}
path: {{ .Values.route.path }}
Expand Down
10 changes: 5 additions & 5 deletions charts/backstage/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -1209,7 +1209,7 @@
"appConfig": {
"default": {
"app": {
"baseUrl": "https://{{- include \"janus-idp.hostname\" . }}"
"baseUrl": "https://{{- include \"rhdh.hostname\" . }}"
},
"auth": {
"providers": {}
Expand All @@ -1226,9 +1226,9 @@
}
]
},
"baseUrl": "https://{{- include \"janus-idp.hostname\" . }}",
"baseUrl": "https://{{- include \"rhdh.hostname\" . }}",
"cors": {
"origin": "https://{{- include \"janus-idp.hostname\" . }}"
"origin": "https://{{- include \"rhdh.hostname\" . }}"
},
"database": {
"connection": {
Expand Down Expand Up @@ -2716,7 +2716,7 @@
"valueFrom": {
"secretKeyRef": {
"key": "backend-secret",
"name": "{{ include \"janus-idp.backend-secret-name\" $ }}"
"name": "{{ include \"rhdh.backend-secret-name\" $ }}"
}
}
},
Expand All @@ -2725,7 +2725,7 @@
"valueFrom": {
"secretKeyRef": {
"key": "postgres-password",
"name": "{{- include \"janus-idp.postgresql.secretName\" . }}"
"name": "{{- include \"rhdh.postgresql.secretName\" . }}"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions charts/backstage/values.schema.tmpl.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
"backstage": {
"image": {
"registry": "quay.io",
"repository": "janus-idp/redhat-backstage-build",
"tag": "latest",
"repository": "rhdh-community/rhdh",
"tag": "next",
"pullPolicy": ""
}
}
Expand Down
Loading
Loading