From d64ab710e03be77f1920a41e6f7bbc6617cb28a0 Mon Sep 17 00:00:00 2001 From: Nick Boldt Date: Fri, 2 Feb 2024 15:03:46 -0400 Subject: [PATCH] update links and version to 2.13.0 (#1) Signed-off-by: Nick Boldt --- README.md | 51 ++++++++++++++++++++---- charts/backstage/Chart.yaml | 16 ++++---- charts/backstage/README.md | 22 +++++----- charts/backstage/README.md.gotmpl | 15 ++++--- charts/backstage/values.schema.json | 2 +- charts/backstage/values.schema.tmpl.json | 2 +- 6 files changed, 75 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 9df3382a..c13044da 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ -# Backstage Helm Chart for OpenShift - +# RHDH Backstage Helm Chart for OpenShift + +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/janus-idp&style=flat-square)](https://artifacthub.io/packages/search?repo=janus-idp) +![Version: 2.13.0](https://img.shields.io/badge/Version-2.13.0-informational?style=flat-square) +![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + +A Helm chart for deploying RHDH (a Backstage application) + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Red Hat Developer Hub Team | | | + +## Source Code + +* +* + +--- + +RHDH Backstage chart is an opinionated flavor of the upstream chart located at [backstage/charts](https://github.com/backstage/charts). It extends the upstream chart with additional OpenShift specific functionality and provides opinionated values. + [Backstage](https://backstage.io) is an open platform for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy. Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end. @@ -12,8 +35,8 @@ This chart extends all the features in the upstream chart in addition to includi Charts are available in the following formats: -* [Chart Repository](https://helm.sh/docs/topics/chart_repository/) -* [OCI Artifacts](https://helm.sh/docs/topics/registries/) +- [Chart Repository](https://helm.sh/docs/topics/chart_repository/) +- [OCI Artifacts](https://helm.sh/docs/topics/registries/) ### Installing from the Chart Repository @@ -25,7 +48,17 @@ helm repo add backstage https://backstage.github.io/charts helm repo add janus-idp https://janus-idp.github.io/helm-backstage ``` -Once the chart has been added, install one of the available charts: +Once the chart has been added, install this chart. However before doing so, please review the default `values.yaml` and adjust as needed. + +- If your cluster doesn't provide PVCs, you should disable PostgreSQL persistence via: + + ```yaml + upstream: + postgresql: + primary: + persistence: + enabled: false + ``` ```console helm upgrade -i janus-idp/backstage @@ -33,12 +66,14 @@ helm upgrade -i janus-idp/backstage ### Installing from an OCI Registry -Charts are also available in OCI format. The list of available charts can be found [here](https://github.com/orgs/janus-idp?tab=packages&repo_name=helm-backstage). +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://github.com/orgs/redhat-developer/packages/container/package/rhdh-chart%2Fbackstage). -Install one of the available charts: +Install one of the available versions: ```shell -helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version= +helm upgrade -i oci://ghcr.io/redhat-developer/rhdh-chart/backstage --version= ``` ## Backstage Chart diff --git a/charts/backstage/Chart.yaml b/charts/backstage/Chart.yaml index 2d04ca6e..0c352481 100644 --- a/charts/backstage/Chart.yaml +++ b/charts/backstage/Chart.yaml @@ -3,16 +3,16 @@ annotations: artifacthub.io/license: Apache-2.0 artifacthub.io/links: | - name: support - url: https://github.com/janus-idp/helm-backstage/issues + url: https://github.com/redhat-developer/rhdh-chart/issues - name: Chart Source - url: https://github.com/janus-idp/helm-backstage + url: https://github.com/redhat-developer/rhdh-chart - name: Default Image Source url: https://github.com/janus-idp/backstage-showcase charts.openshift.io/name: Backstage charts.openshift.io/provider: Janus-IDP - charts.openshift.io/supportURL: https://github.com/janus-idp/helm-backstage/issues + charts.openshift.io/supportURL: https://github.com/redhat-developer/rhdh-chart/issues apiVersion: v2 -description: A Helm chart for deploying a Backstage application +description: A Helm chart for deploying RHDH (a Backstage application) dependencies: - name: common repository: https://charts.bitnami.com/bitnami @@ -31,14 +31,14 @@ keywords: - janus-idp kubeVersion: ">= 1.19.0-0" maintainers: - - name: Janus-IDP - url: https://janus-idp.io + - name: Red Hat Developer Hub Team + url: https://github.com/redhat-developer/rhdh-chart name: backstage type: application sources: - - https://github.com/janus-idp/helm-backstage + - https://github.com/redhat-developer/rhdh-chart - https://github.com/janus-idp/backstage-showcase # 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: 2.12.4 +version: 2.13.0 diff --git a/charts/backstage/README.md b/charts/backstage/README.md index 76481baa..46f6ce09 100644 --- a/charts/backstage/README.md +++ b/charts/backstage/README.md @@ -1,11 +1,11 @@ -# Janus-IDP Backstage Helm Chart +# RHDH Backstage Helm Chart for OpenShift [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/janus-idp&style=flat-square)](https://artifacthub.io/packages/search?repo=janus-idp) -![Version: 2.12.4](https://img.shields.io/badge/Version-2.12.4-informational?style=flat-square) +![Version: 2.13.0](https://img.shields.io/badge/Version-2.13.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) -A Helm chart for deploying a Backstage application +A Helm chart for deploying RHDH (a Backstage application) **Homepage:** @@ -13,16 +13,16 @@ A Helm chart for deploying a Backstage application | Name | Email | Url | | ---- | ------ | --- | -| Janus-IDP | | | +| Red Hat Developer Hub Team | | | ## Source Code -* +* * --- -[Janus-IDP](https://janus-idp.io/) Backstage chart is an opinionated flavor of the upstream chart located at [backstage/charts](https://github.com/backstage/charts). It extends the upstream chart with additional OpenShift specific functionality and provides opinionated values. +RHDH Backstage chart is an opinionated flavor of the upstream chart located at [backstage/charts](https://github.com/backstage/charts). It extends the upstream chart with additional OpenShift specific functionality and provides opinionated values. [Backstage](https://backstage.io) is an open platform for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy. @@ -55,7 +55,7 @@ This chart bootstraps a [Backstage](https://backstage.io/docs/deployment/docker) ## Usage -Chart is available in the following formats: +Charts are available in the following formats: - [Chart Repository](https://helm.sh/docs/topics/chart_repository/) - [OCI Artifacts](https://helm.sh/docs/topics/registries/) @@ -65,6 +65,8 @@ Chart is available in the following formats: The following command can be used to add the chart repository: ```console +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo add backstage https://backstage.github.io/charts helm repo add janus-idp https://janus-idp.github.io/helm-backstage ``` @@ -86,12 +88,14 @@ helm upgrade -i janus-idp/backstage ### Installing from an OCI Registry -Chart is also available in OCI format. The list of available releases can be found [here](https://github.com/janus-idp/helm-backstage/pkgs/container/charts%2Fbackstage). +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://github.com/orgs/redhat-developer/packages/container/package/rhdh-chart%2Fbackstage). Install one of the available versions: ```shell -helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version= +helm upgrade -i oci://ghcr.io/redhat-developer/rhdh-chart/backstage --version= ``` > **Tip**: List all releases using `helm list` diff --git a/charts/backstage/README.md.gotmpl b/charts/backstage/README.md.gotmpl index 78fc45c2..2eac76a8 100644 --- a/charts/backstage/README.md.gotmpl +++ b/charts/backstage/README.md.gotmpl @@ -1,4 +1,4 @@ -# Janus-IDP Backstage Helm Chart +# RHDH Backstage Helm Chart for OpenShift {{ template "chart.deprecationWarning" . }} @@ -16,7 +16,7 @@ --- -[Janus-IDP](https://janus-idp.io/) Backstage chart is an opinionated flavor of the upstream chart located at [backstage/charts](https://github.com/backstage/charts). It extends the upstream chart with additional OpenShift specific functionality and provides opinionated values. +RHDH Backstage chart is an opinionated flavor of the upstream chart located at [backstage/charts](https://github.com/backstage/charts). It extends the upstream chart with additional OpenShift specific functionality and provides opinionated values. [Backstage](https://backstage.io) is an open platform for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy. @@ -49,7 +49,7 @@ This chart bootstraps a [Backstage](https://backstage.io/docs/deployment/docker) ## Usage -Chart is available in the following formats: +Charts are available in the following formats: - [Chart Repository](https://helm.sh/docs/topics/chart_repository/) - [OCI Artifacts](https://helm.sh/docs/topics/registries/) @@ -59,6 +59,8 @@ Chart is available in the following formats: The following command can be used to add the chart repository: ```console +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo add backstage https://backstage.github.io/charts helm repo add janus-idp https://janus-idp.github.io/helm-backstage ``` @@ -80,12 +82,14 @@ helm upgrade -i janus-idp/backstage ### Installing from an OCI Registry -Chart is also available in OCI format. The list of available releases can be found [here](https://github.com/janus-idp/helm-backstage/pkgs/container/charts%2Fbackstage). +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://github.com/orgs/redhat-developer/packages/container/package/rhdh-chart%2Fbackstage). Install one of the available versions: ```shell -helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version= +helm upgrade -i oci://ghcr.io/redhat-developer/rhdh-chart/backstage --version= ``` > **Tip**: List all releases using `helm list` @@ -184,7 +188,6 @@ upstream: origin: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}' ``` - ### Vanilla Kubernetes compatibility mode In order to deploy this chart on vanilla Kubernetes or any other non-OCP platform, please make sure to apply the following changes. Note that further customizations may be required, depending on your exact Kubernetes setup: diff --git a/charts/backstage/values.schema.json b/charts/backstage/values.schema.json index 4cad8ca9..9bf88e5b 100644 --- a/charts/backstage/values.schema.json +++ b/charts/backstage/values.schema.json @@ -1,5 +1,5 @@ { - "$id": "https://raw.githubusercontent.com/janus-idp/helm-backstage/main/charts/backstage/values.schema.json", + "$id": "https://raw.githubusercontent.com/redhat-developer/rhdh-chart/main/charts/backstage/values.schema.json", "properties": { "global": { "properties": { diff --git a/charts/backstage/values.schema.tmpl.json b/charts/backstage/values.schema.tmpl.json index e60f9a36..f0a9e864 100644 --- a/charts/backstage/values.schema.tmpl.json +++ b/charts/backstage/values.schema.tmpl.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/janus-idp/helm-backstage/main/charts/backstage/values.schema.json", + "$id": "https://raw.githubusercontent.com/redhat-developer/rhdh-chart/main/charts/backstage/values.schema.json", "type": "object", "title": "Root Schema", "properties": {