Skip to content

Commit c7089a8

Browse files
tumidotumido
authored
docs: Fix value descriptions for helm docs (#30)
Signed-off-by: Tomas Coufal <tcoufal@redhat.com>
1 parent 29ca4d3 commit c7089a8

3 files changed

Lines changed: 207 additions & 183 deletions

File tree

‎charts/backstage/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.10.0
18+
version: 0.10.1
1919

2020
dependencies:
2121
- name: common

‎charts/backstage/README.md‎

Lines changed: 60 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Backstage Helm Chart
33

4-
![Version: 0.10.0](https://img.shields.io/badge/Version-0.10.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
4+
![Version: 0.10.1](https://img.shields.io/badge/Version-0.10.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
55

66
A Helm chart for deploying a Backstage application
77

@@ -85,49 +85,54 @@ The command removes all the Kubernetes components associated with the chart and
8585

8686
| Key | Description | Type | Default |
8787
|-----|-------------|------|---------|
88+
| backstage | Backstage parameters | object | See below |
8889
| backstage.appConfig | Generates ConfigMap and configures it in the Backstage pods | object | `{}` |
89-
| backstage.args | | list | `[]` |
90-
| backstage.command[0] | | string | `"node"` |
91-
| backstage.command[1] | | string | `"packages/backend"` |
92-
| backstage.containerPorts.backend | | int | `7007` |
93-
| backstage.containerSecurityContext | | object | `{}` |
94-
| backstage.extraAppConfig | | list | `[]` |
95-
| backstage.extraContainers | | list | `[]` |
96-
| backstage.extraEnvVars | | list | `[]` |
97-
| backstage.extraEnvVarsSecrets | | string | `nil` |
98-
| backstage.extraVolumeMounts | | list | `[]` |
99-
| backstage.extraVolumes | | list | `[]` |
100-
| backstage.image.debug | | bool | `false` |
101-
| backstage.image.pullPolicy | | string | `"Always"` |
102-
| backstage.image.pullSecrets | | list | `[]` |
103-
| backstage.image.registry | | string | `"ghcr.io"` |
104-
| backstage.image.repository | | string | `"backstage/backstage"` |
105-
| backstage.image.tag | | string | `"latest"` |
106-
| backstage.initContainers | | list | `[]` |
107-
| backstage.podSecurityContext | | object | `{}` |
108-
| backstage.resources | resource requests/limits ref: https://kubernetes.io/docs/user-guide/compute-resources/ # E.g. # resources: # limits: # memory: 1Gi # cpu: 1000m # requests: # memory: 250Mi # cpu: 100m | object | `{}` |
109-
| clusterDomain | | string | `"cluster.local"` |
110-
| commonAnnotations | | object | `{}` |
111-
| commonLabels | | object | `{}` |
112-
| diagnosticMode.args[0] | | string | `"infinity"` |
113-
| diagnosticMode.command[0] | | string | `"sleep"` |
114-
| diagnosticMode.enabled | | bool | `false` |
115-
| extraDeploy | | list | `[]` |
116-
| fullnameOverride | | string | `""` |
117-
| global.imagePullSecrets | | list | `[]` |
118-
| global.imageRegistry | | string | `""` |
119-
| ingress.annotations | | object | `{}` |
120-
| ingress.className | | string | `""` |
121-
| ingress.enabled | | bool | `false` |
122-
| ingress.host | | string | `""` |
123-
| ingress.tls.enabled | | bool | `false` |
124-
| ingress.tls.secretName | | string | `""` |
125-
| kubeVersion | | string | `""` |
126-
| nameOverride | | string | `""` |
127-
| networkPolicy.egressRules.customRules | | list | `[]` |
128-
| networkPolicy.enabled | | bool | `false` |
129-
| networkPolicy.externalAccess.from | | list | `[]` |
130-
| postgresql | PostgreSQL [chart configuration](https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml) | object | `{"architecture":"standalone","auth":{"existingSecret":"","password":"","secretKeys":{"adminPasswordKey":"admin-password","replicationPasswordKey":"replication-password","userPasswordKey":"user-password"},"username":"bn_backstage"},"enabled":false}` |
90+
| backstage.args | Backstage container command arguments | list | `[]` |
91+
| backstage.command | Backstage container command | list | `["node","packages/backend"]` |
92+
| backstage.containerPorts | Container ports on the Deployment | object | `{"backend":7007}` |
93+
| backstage.containerSecurityContext | Security settings for a Container. <br /> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container | object | `{}` |
94+
| backstage.extraAppConfig | Extra app configuration files to inline into command arguments | list | `[]` |
95+
| backstage.extraContainers | Deployment sidecars | list | `[]` |
96+
| backstage.extraEnvVars | Backstage container environment variables | list | `[]` |
97+
| backstage.extraEnvVarsSecrets | Backstage container environment variables from Secrets | list | `[]` |
98+
| backstage.extraVolumeMounts | Backstage container additional volume mounts | list | `[]` |
99+
| backstage.extraVolumes | Backstage container additional volumes | list | `[]` |
100+
| backstage.image.debug | Set to true if you would like to see extra information on logs | bool | `false` |
101+
| backstage.image.pullPolicy | Specify a imagePullPolicy. Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent' <br /> Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images | string | `"Always"` |
102+
| backstage.image.pullSecrets | Optionally specify an array of imagePullSecrets. Secrets must be manually created in the namespace. <br /> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ <br /> E.g: `pullSecrets: [myRegistryKeySecretName]` | list | `[]` |
103+
| backstage.image.registry | Backstage image registry | string | `"ghcr.io"` |
104+
| backstage.image.repository | Backstage image repository | string | `"backstage/backstage"` |
105+
| backstage.image.tag | Backstage image tag (immutable tags are recommended) | string | `"latest"` |
106+
| backstage.initContainers | Backstage container init containers | list | `[]` |
107+
| backstage.podSecurityContext | Security settings for a Pod. The security settings that you specify for a Pod apply to all Containers in the Pod. <br /> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod | object | `{}` |
108+
| backstage.resources | Resource requests/limits <br /> Ref: https://kubernetes.io/docs/user-guide/compute-resources/ <!-- E.g. resources: limits: memory: 1Gi cpu: 1000m requests: memory: 250Mi cpu: 100m --> | object | `{}` |
109+
| clusterDomain | Default Kubernetes cluster domain | string | `"cluster.local"` |
110+
| commonAnnotations | Annotations to add to all deployed objects | object | `{}` |
111+
| commonLabels | Labels to add to all deployed objects | object | `{}` |
112+
| diagnosticMode | Enable diagnostic mode in the Deployment | object | `{"args":["infinity"],"command":["sleep"],"enabled":false}` |
113+
| diagnosticMode.args | Args to override all containers in the Deployment | list | `["infinity"]` |
114+
| diagnosticMode.command | Command to override all containers in the Deployment | list | `["sleep"]` |
115+
| diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | bool | `false` |
116+
| extraDeploy | Array of extra objects to deploy with the release | list | `[]` |
117+
| fullnameOverride | String to fully override common.names.fullname | string | `""` |
118+
| global | Global parameters Global Docker image parameters Please, note that this will override the image parameters, including dependencies, configured to use the global value Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass | object | See below |
119+
| global.imagePullSecrets | Global Docker registry secret names as an array </br> E.g. `imagePullSecrets: [myRegistryKeySecretName]` | list | `[]` |
120+
| global.imageRegistry | Global Docker image registry | string | `""` |
121+
| ingress | Ingress parameters | object | `{"annotations":{},"className":"","enabled":false,"host":"","tls":{"enabled":false,"secretName":""}}` |
122+
| ingress.annotations | Additional annotations for the Ingress resource | object | `{}` |
123+
| ingress.className | Name of the IngressClass cluster resource which defines which controller will implement the resource (e.g nginx) | string | `""` |
124+
| ingress.enabled | Enable the creation of the ingress resource | bool | `false` |
125+
| ingress.host | Hostname to be used to expose the route to access the backstage application (e.g: backstage.IP.nip.io) | string | `""` |
126+
| ingress.tls | Ingress TLS parameters | object | `{"enabled":false,"secretName":""}` |
127+
| ingress.tls.enabled | Enable TLS configuration for the host defined at `ingress.host` parameter | bool | `false` |
128+
| ingress.tls.secretName | The name to which the TLS Secret will be called | string | `""` |
129+
| kubeVersion | Override Kubernetes version | string | `""` |
130+
| nameOverride | String to partially override common.names.fullname | string | `""` |
131+
| networkPolicy | Network policies <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/ | object | `{"egressRules":{"customRules":[]},"enabled":false,"externalAccess":{"from":[]}}` |
132+
| networkPolicy.egressRules | Custom network policy rule | object | `{"customRules":[]}` |
133+
| networkPolicy.egressRules.customRules | Additional custom egress rules e.g: customRules: - to: - namespaceSelector: matchLabels: label: example | list | `[]` |
134+
| networkPolicy.enabled | networkPolicy.enabled Specifies whether a NetworkPolicy should be created | bool | `false` |
135+
| postgresql | PostgreSQL [chart configuration](https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml) | object | See below |
131136
| postgresql.architecture | PostgreSQL architecture (`standalone` or `replication`) | string | `"standalone"` |
132137
| postgresql.auth | The authentication details of the Postgres database | object | `{"existingSecret":"","password":"","secretKeys":{"adminPasswordKey":"admin-password","replicationPasswordKey":"replication-password","userPasswordKey":"user-password"},"username":"bn_backstage"}` |
133138
| postgresql.auth.existingSecret | Name of existing secret to use for PostgreSQL credentials | string | `""` |
@@ -138,17 +143,18 @@ The command removes all the Kubernetes components associated with the chart and
138143
| postgresql.auth.secretKeys.userPasswordKey | The key in which Postgres will look for, for the user password, in the existing Secret | string | `"user-password"` |
139144
| postgresql.auth.username | Name for a custom user to create | string | `"bn_backstage"` |
140145
| postgresql.enabled | Switch to enable or disable the PostgreSQL helm chart | bool | `false` |
141-
| service.annotations | | object | `{}` |
142-
| service.clusterIP | | string | `""` |
143-
| service.externalTrafficPolicy | | string | `"Cluster"` |
144-
| service.extraPorts | | list | `[]` |
145-
| service.loadBalancerIP | | string | `""` |
146-
| service.loadBalancerSourceRanges | | list | `[]` |
147-
| service.nodePorts.backend | | string | `""` |
148-
| service.ports.backend | | int | `7007` |
149-
| service.sessionAffinity | | string | `"None"` |
150-
| service.type | | string | `"ClusterIP"` |
151-
| serviceAccount | Service Account Configuration | object | `{"annotations":{},"automountServiceAccountToken":true,"create":false,"labels":{},"name":""}` |
146+
| service | Service parameters | object | See below |
147+
| service.annotations | Additional custom annotations for Backstage service | object | `{}` |
148+
| service.clusterIP | Backstage service Cluster IP <br /> E.g `clusterIP: None` | string | `""` |
149+
| service.externalTrafficPolicy | Backstage service external traffic policy Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip | string | `"Cluster"` |
150+
| service.extraPorts | Extra ports to expose in the Backstage service (normally used with the `sidecar` value) | list | `[]` |
151+
| service.loadBalancerIP | Backstage service Load Balancer IP <br /> Ref: https://kubernetes.io/docs/user-guide/services/#type-loadbalancer | string | `""` |
152+
| service.loadBalancerSourceRanges | Load Balancer sources <br /> Ref: https://kubernetes.io/docs/tasks/access-application-cluster/cnfigure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service <br /> E.g `loadBalancerSourceRanges: [10.10.10.0/24]` | list | `[]` |
153+
| service.nodePorts | Node port for the Backstage client connections Choose port between `30000-32767` | object | `{"backend":""}` |
154+
| service.ports | Backstage svc port for client connections | object | `{"backend":7007}` |
155+
| service.sessionAffinity | Control where client requests go, to the same pod or round-robin (values: `ClientIP` or `None`) <br /> Ref: https://kubernetes.io/docs/user-guide/services/ | string | `"None"` |
156+
| service.type | Kubernetes Service type | string | `"ClusterIP"` |
157+
| serviceAccount | Service Account Configuration | object | See below |
152158
| serviceAccount.annotations | Additional custom annotations for the ServiceAccount. | object | `{}` |
153159
| serviceAccount.automountServiceAccountToken | Auto-mount the service account token in the pod | bool | `true` |
154160
| serviceAccount.create | Enable the creation of a ServiceAccount for Backstage pods | bool | `false` |

0 commit comments

Comments
 (0)