|
| 1 | +# backstage |
| 2 | + |
| 3 | +  |
| 4 | + |
| 5 | +A helm chart for deploying Backstage |
| 6 | + |
| 7 | +**Homepage:** <https://github.com/janus-idp/helm-backstage> |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +This chart can be installed to an individual namespace by first adding the chart repository, creating a new namespace (or using an existing namespace) and installing the chart by executing the following commands: |
| 12 | + |
| 13 | +```shell |
| 14 | +helm repo add janus-idp-backstage https://janus-idp.github.io/helm-backstage |
| 15 | +helm create namespace backstage |
| 16 | +helm upgrade -i backstage -n backstage janus-idp-backstage/backstage --set backstage.baseUrl=<BASE_URL> |
| 17 | +``` |
| 18 | + |
| 19 | +The preceding command will create a new namespace called `backstage` and install the chart with a release name of `backstage`. At a minimum, the required parameter `backstage.baseUrl` refers to the URL that should be used to access the Backstage user interface. |
| 20 | + |
| 21 | +## Uninstallation |
| 22 | + |
| 23 | +To remove a previously installed chart, execute the following command: |
| 24 | + |
| 25 | +```shell |
| 26 | +helm uninstall <RELEASE> |
| 27 | +``` |
| 28 | + |
| 29 | +Replace `<RELEASE>` with the name of the Helm release that was used when installing the chart. |
| 30 | + |
| 31 | +## Values |
| 32 | + |
| 33 | +| Key | Type | Default | Description | |
| 34 | +|-----|------|---------|-------------| |
| 35 | +| additionalConfig | object | `{}` | | |
| 36 | +| backstage.baseUrl | string | `""` | | |
| 37 | +| backstage.catalog.locations[0].target | string | `"https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-components.yaml"` | | |
| 38 | +| backstage.catalog.locations[0].type | string | `"url"` | | |
| 39 | +| backstage.catalog.rules[0].allow[0] | string | `"Component"` | | |
| 40 | +| backstage.catalog.rules[0].allow[1] | string | `"System"` | | |
| 41 | +| backstage.catalog.rules[0].allow[2] | string | `"API"` | | |
| 42 | +| backstage.catalog.rules[0].allow[3] | string | `"Resource"` | | |
| 43 | +| backstage.catalog.rules[0].allow[4] | string | `"Location"` | | |
| 44 | +| backstage.companyname | string | `"Red Hat Backstage Helm Chart"` | | |
| 45 | +| fullnameOverride | string | `""` | | |
| 46 | +| image.pullPolicy | string | `"Always"` | | |
| 47 | +| image.registry | string | `"ghcr.io"` | | |
| 48 | +| image.repository | string | `"janus-idp/redhat-backstage-build"` | | |
| 49 | +| image.version | string | `"latest"` | | |
| 50 | +| imagePullSecrets | list | `[]` | | |
| 51 | +| ingress.className | string | `""` | | |
| 52 | +| ingress.enabled | bool | `false` | | |
| 53 | +| ingress.tls.secretName | string | `""` | | |
| 54 | +| name | string | `"backstage"` | | |
| 55 | +| nameOverride | string | `""` | | |
| 56 | +| postgres.database_host | string | `""` | | |
| 57 | +| postgres.database_name | string | `"postgres"` | | |
| 58 | +| postgres.database_password | string | `""` | | |
| 59 | +| postgres.database_port | int | `5432` | | |
| 60 | +| postgres.database_user | string | `"postgres"` | | |
| 61 | +| postgres.existingSecret | string | `""` | | |
| 62 | +| postgres.external | bool | `false` | | |
| 63 | +| postgres.image.pullPolicy | string | `"Always"` | | |
| 64 | +| postgres.image.registry | string | `"quay.io"` | | |
| 65 | +| postgres.image.repository | string | `"fedora/postgresql-13"` | | |
| 66 | +| postgres.image.version | string | `"13"` | | |
| 67 | +| postgres.resources.limits.cpu | string | `"400m"` | | |
| 68 | +| postgres.resources.limits.memory | string | `"596Mi"` | | |
| 69 | +| postgres.resources.requests.cpu | string | `"100m"` | | |
| 70 | +| postgres.resources.requests.memory | string | `"128Mi"` | | |
| 71 | +| postgres.secretKeys.adminPasswordKey | string | `""` | | |
| 72 | +| postgres.serviceAccount.annotations | object | `{}` | | |
| 73 | +| postgres.serviceAccount.create | bool | `true` | | |
| 74 | +| postgres.serviceAccount.name | string | `""` | | |
| 75 | +| postgres.storage.enabled | bool | `true` | | |
| 76 | +| postgres.storage.size | string | `"2Gi"` | | |
| 77 | +| replicaCount | int | `1` | | |
| 78 | +| resources | object | `{}` | | |
| 79 | +| route.annotations | object | `{}` | | |
| 80 | +| route.enabled | bool | `true` | | |
| 81 | +| route.termination | string | `"edge"` | | |
| 82 | +| securityContext | object | `{}` | | |
| 83 | +| service.port | int | `8080` | | |
| 84 | +| service.targetPort | int | `7007` | | |
| 85 | +| service.type | string | `"ClusterIP"` | | |
| 86 | +| serviceAccount.annotations | object | `{}` | | |
| 87 | +| serviceAccount.create | bool | `true` | | |
| 88 | +| serviceAccount.name | string | `""` | | |
0 commit comments