Skip to content

Commit df1d5e8

Browse files
RedlineTriadRedlineTriad
authored
feat: allow extra ports to be added to the backend service (#237)
This is useful when prometheus metrics are exposed on a different port. This resolves #236. Signed-off-by: RedlineTriad <[email protected]>
1 parent 5129443 commit df1d5e8

File tree

6 files changed

+64
-9
lines changed

6 files changed

+64
-9
lines changed

‎charts/backstage/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ sources:
3838
# This is the chart version. This version number should be incremented each time you make changes
3939
# to the chart and its templates, including the app version.
4040
# Versions are expected to follow Semantic Versioning (https://semver.org/)
41-
version: 2.2.0
41+
version: 2.3.0

‎charts/backstage/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Backstage Helm Chart
33

44
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/backstage)](https://artifacthub.io/packages/search?repo=backstage)
5-
![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square)
5+
![Version: 2.3.0](https://img.shields.io/badge/Version-2.3.0-informational?style=flat-square)
66
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
77

88
A Helm chart for deploying a Backstage application
@@ -125,6 +125,7 @@ Kubernetes: `>= 1.19.0-0`
125125
| backstage.extraEnvVars | Backstage container environment variables | list | `[]` |
126126
| backstage.extraEnvVarsCM | Backstage container environment variables from existing ConfigMaps | list | `[]` |
127127
| backstage.extraEnvVarsSecrets | Backstage container environment variables from existing Secrets | list | `[]` |
128+
| backstage.extraPorts | Backstage container additional ports | list | `[]` |
128129
| backstage.extraVolumeMounts | Backstage container additional volume mounts | list | `[]` |
129130
| backstage.extraVolumes | Backstage container additional volumes | list | `[]` |
130131
| backstage.hostAliases | Host Aliases for the pod <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/ | list | `[]` |

‎charts/backstage/templates/backstage-deployment.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,9 @@ spec:
162162
- name: backend
163163
containerPort: {{ .Values.backstage.containerPorts.backend }}
164164
protocol: TCP
165+
{{- if .Values.backstage.extraPorts }}
166+
{{- include "common.tplvalues.render" ( dict "value" .Values.backstage.extraPorts "context" $) | nindent 12 }}
167+
{{- end }}
165168
{{- if (or .Values.backstage.extraAppConfig .Values.backstage.appConfig (and .Values.backstage.extraVolumeMounts .Values.backstage.extraVolumes)) }}
166169
volumeMounts:
167170
{{- range .Values.backstage.extraAppConfig }}

‎charts/backstage/values.schema.json

+36
Original file line numberDiff line numberDiff line change
@@ -2389,6 +2389,42 @@
23892389
"title": "Backstage container environment variables from existing Secrets",
23902390
"type": "array"
23912391
},
2392+
"extraPorts": {
2393+
"default": [],
2394+
"items": {
2395+
"description": "ContainerPort represents a network port in a single container.",
2396+
"properties": {
2397+
"containerPort": {
2398+
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
2399+
"format": "int32",
2400+
"type": "integer"
2401+
},
2402+
"hostIP": {
2403+
"description": "What host IP to bind the external port to.",
2404+
"type": "string"
2405+
},
2406+
"hostPort": {
2407+
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
2408+
"format": "int32",
2409+
"type": "integer"
2410+
},
2411+
"name": {
2412+
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
2413+
"type": "string"
2414+
},
2415+
"protocol": {
2416+
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
2417+
"type": "string"
2418+
}
2419+
},
2420+
"required": [
2421+
"containerPort"
2422+
],
2423+
"type": "object"
2424+
},
2425+
"title": "Extra ports to expose in the Backstage container",
2426+
"type": "array"
2427+
},
23922428
"extraVolumeMounts": {
23932429
"default": [],
23942430
"items": {

‎charts/backstage/values.schema.tmpl.json

+19-7
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,14 @@
404404
]
405405
]
406406
},
407+
"extraPorts": {
408+
"title": "Extra ports to expose in the Backstage container",
409+
"type": "array",
410+
"items": {
411+
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort"
412+
},
413+
"default": []
414+
},
407415
"extraVolumeMounts": {
408416
"title": "Backstage container additional volume mounts",
409417
"type": "array",
@@ -457,10 +465,10 @@
457465
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
458466
"default": {
459467
"httpGet": {
460-
"path": "/.backstage/health/v1/readiness",
461-
"port": 7007,
462-
"scheme": "HTTP"
463-
}
468+
"path": "/.backstage/health/v1/readiness",
469+
"port": 7007,
470+
"scheme": "HTTP"
471+
}
464472
},
465473
"examples": [
466474
{
@@ -879,13 +887,17 @@
879887
"description": "The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitely specificed. OpenTelemetry's default port is 9464.",
880888
"title": "ServiceMonitor endpoint port",
881889
"anyOf": [
882-
{ "type": "string" },
883-
{ "type": "integer" }
890+
{
891+
"type": "string"
892+
},
893+
{
894+
"type": "integer"
895+
}
884896
]
885897
}
886898
}
887899
}
888900
}
889901
}
890902
}
891-
}
903+
}

‎charts/backstage/values.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@ backstage:
158158
# -- Backstage container environment variables from existing Secrets
159159
extraEnvVarsSecrets: []
160160

161+
# -- Backstage container additional ports
162+
extraPorts: []
163+
161164
# -- Backstage container additional volume mounts
162165
extraVolumeMounts: []
163166

0 commit comments

Comments
 (0)