Skip to content

Commit 2df03a9

Browse files
rm3lrm3l
authored
feat: Allow configuring the Service IP Family policy to make it dual-stack (#252)
* feat: Allow configuring the Service IP Family policy to make it dual-stack Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services Signed-off-by: Armel Soro <[email protected]> * Bump the Chart version Signed-off-by: Armel Soro <[email protected]> * Update values schema Signed-off-by: Armel Soro <[email protected]> * Add test values file for CI Signed-off-by: Armel Soro <[email protected]> * Run pre-commit hooks Signed-off-by: Armel Soro <[email protected]> --------- Signed-off-by: Armel Soro <[email protected]>
1 parent 174eb0e commit 2df03a9

File tree

9 files changed

+75
-5
lines changed

9 files changed

+75
-5
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Backstage unifies all your infrastructure tooling, services, and documentation t
1111

1212
This chart focuses on providing users the same experience and functionality no matter what flavor of Kubernetes they use. This chart will support only patterns that are either customary for all Kubernetes flavors, are commonly used in the Bitnami charts ecosystem, and recognized as Backstage official patterns.
1313

14-
We welcome other, more specialized, charts to use this cannonical chart as a direct dependency, expanding the feature set further, beyond this scope.
14+
We welcome other, more specialized, charts to use this canonical chart as a direct dependency, expanding the feature set further, beyond this scope.
1515

1616
A list of derived charts:
1717
- OpenShift specialized chart: [Red Hat Developer Hub Helm chart](https://github.com/redhat-developer/rhdh-chart/tree/main/charts/backstage)

‎charts/backstage/Chart.yaml

Lines changed: 1 addition & 1 deletion
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.3.1
41+
version: 2.4.0

‎charts/backstage/README.md

Lines changed: 4 additions & 2 deletions
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.3.1](https://img.shields.io/badge/Version-2.3.1-informational?style=flat-square)
5+
![Version: 2.4.0](https://img.shields.io/badge/Version-2.4.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
@@ -51,7 +51,7 @@ This chart bootstraps a [Backstage](https://backstage.io/docs/deployment/docker)
5151

5252
This chart focuses on providing users the same experience and functionality no matter what flavor of Kubernetes they use. This chart will support only patterns that are either customary for all Kubernetes flavors, are commonly used in the Bitnami charts ecosystem, and recognized as Backstage official patterns.
5353

54-
We welcome other, more specialized, charts to use this cannonical chart as a direct dependency, expanding the feature set further, beyond this scope.
54+
We welcome other, more specialized, charts to use this canonical chart as a direct dependency, expanding the feature set further, beyond this scope.
5555

5656
A list of derived charts:
5757
- OpenShift specialized chart: [Janus Backstage Helm chart](https://github.com/janus-idp/helm-backstage/tree/main/charts/backstage)
@@ -204,6 +204,8 @@ Kubernetes: `>= 1.19.0-0`
204204
| service.clusterIP | Backstage service Cluster IP <br /> E.g `clusterIP: None` | string | `""` |
205205
| 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"` |
206206
| service.extraPorts | Extra ports to expose in the Backstage service (normally used with the `sidecar` value) | list | `[]` |
207+
| service.ipFamilies | IP Families <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack | list | `[]` |
208+
| service.ipFamilyPolicy | IP Family Policy <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack | string | `""` |
207209
| service.loadBalancerIP | Backstage service Load Balancer IP <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer | string | `""` |
208210
| service.loadBalancerSourceRanges | Load Balancer sources <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer <br /> E.g `loadBalancerSourceRanges: [10.10.10.0/24]` | list | `[]` |
209211
| service.nodePorts | Node port for the Backstage client connections Choose port between `30000-32767` | object | `{"backend":""}` |

‎charts/backstage/README.md.gotmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This chart bootstraps a [Backstage](https://backstage.io/docs/deployment/docker)
4545

4646
This chart focuses on providing users the same experience and functionality no matter what flavor of Kubernetes they use. This chart will support only patterns that are either customary for all Kubernetes flavors, are commonly used in the Bitnami charts ecosystem, and recognized as Backstage official patterns.
4747

48-
We welcome other, more specialized, charts to use this cannonical chart as a direct dependency, expanding the feature set further, beyond this scope.
48+
We welcome other, more specialized, charts to use this canonical chart as a direct dependency, expanding the feature set further, beyond this scope.
4949

5050
A list of derived charts:
5151
- OpenShift specialized chart: [Janus Backstage Helm chart](https://github.com/janus-idp/helm-backstage/tree/main/charts/backstage)

‎charts/backstage/ci/service-dualstack-ip-family-values.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
service:
2+
ipFamilyPolicy: PreferDualStack
3+
ipFamilies:
4+
- IPv4

‎charts/backstage/templates/service.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ spec:
3434
{{- if .Values.service.sessionAffinity }}
3535
sessionAffinity: {{ .Values.service.sessionAffinity }}
3636
{{- end }}
37+
{{- if .Values.service.ipFamilyPolicy }}
38+
ipFamilyPolicy: {{ .Values.service.ipFamilyPolicy }}
39+
{{- end }}
40+
{{- with .Values.service.ipFamilies }}
41+
ipFamilies:
42+
{{- toYaml . | nindent 4 }}
43+
{{- end }}
3744
ports:
3845
- name: {{ .Values.service.ports.name }}
3946
port: {{ .Values.service.ports.backend }}

‎charts/backstage/values.schema.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7051,6 +7051,31 @@
70517051
"title": "Extra ports to expose in the Backstage service",
70527052
"type": "array"
70537053
},
7054+
"ipFamilies": {
7055+
"default": [],
7056+
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services",
7057+
"items": {
7058+
"enum": [
7059+
"IPv4",
7060+
"IPv6"
7061+
],
7062+
"type": "string"
7063+
},
7064+
"title": "Backstage service IP families",
7065+
"type": "array"
7066+
},
7067+
"ipFamilyPolicy": {
7068+
"default": "",
7069+
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services",
7070+
"enum": [
7071+
"",
7072+
"SingleStack",
7073+
"PreferDualStack",
7074+
"RequireDualStack"
7075+
],
7076+
"title": "Backstage service IP family policy",
7077+
"type": "string"
7078+
},
70547079
"loadBalancerIP": {
70557080
"default": "",
70567081
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,28 @@
730730
"type": "object"
731731
},
732732
"default": []
733+
},
734+
"ipFamilyPolicy": {
735+
"title": "Backstage service IP family policy",
736+
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services",
737+
"type": "string",
738+
"default": "",
739+
"enum": [
740+
"",
741+
"SingleStack",
742+
"PreferDualStack",
743+
"RequireDualStack"
744+
]
745+
},
746+
"ipFamilies": {
747+
"title": "Backstage service IP families",
748+
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services",
749+
"type": "array",
750+
"items": {
751+
"type": "string",
752+
"enum": ["IPv4", "IPv6"]
753+
},
754+
"default": []
733755
}
734756
}
735757
},

‎charts/backstage/values.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,16 @@ service:
352352
# -- Extra ports to expose in the Backstage service (normally used with the `sidecar` value)
353353
extraPorts: []
354354

355+
# -- IP Family Policy
356+
#
357+
# <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack
358+
ipFamilyPolicy: ""
359+
360+
# -- IP Families
361+
#
362+
# <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack
363+
ipFamilies: []
364+
355365
## @section NetworkPolicy parameters
356366
##
357367
networkPolicy:

0 commit comments

Comments
 (0)