Add support for hostAliases (backstage#234)

* Add support for hostAliases Signed-off-by: Joel Damata <[email protected]> * bump chart version and run pre-commit Signed-off-by: Corey Daley <[email protected]> --------- Signed-off-by: Joel Damata <[email protected]> Signed-off-by: Corey Daley <[email protected]> Co-authored-by: Joel Damata <[email protected]>
connyay · Nov 13, 2024 · b0e982d · b0e982d
1 parent 560f425
commit b0e982d
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 2 deletions.
diff --git a/charts/backstage/Chart.yaml b/charts/backstage/Chart.yaml
@@ -38,4 +38,4 @@ sources:
 # 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.1.0
+version: 2.2.0
diff --git a/charts/backstage/README.md b/charts/backstage/README.md
@@ -2,7 +2,7 @@
 # Backstage Helm Chart
 
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/backstage)](https://artifacthub.io/packages/search?repo=backstage)
-![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square)
+![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.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
@@ -127,6 +127,7 @@ Kubernetes: `>= 1.19.0-0`
 | backstage.extraEnvVarsSecrets | Backstage container environment variables from existing Secrets | list | `[]` |
 | backstage.extraVolumeMounts | Backstage container additional volume mounts | list | `[]` |
 | backstage.extraVolumes | Backstage container additional volumes | list | `[]` |
+| 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 | `[]` |
 | backstage.image.digest | Backstage image digest (digest takes precedence over image tag) | string | `""` |
 | backstage.image.pullPolicy | Specify a imagePullPolicy. Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent' <br /> Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy | string | `"Always"` |
 | 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 | `[]` |

diff --git a/charts/backstage/templates/backstage-deployment.yaml b/charts/backstage/templates/backstage-deployment.yaml
@@ -59,6 +59,10 @@ spec:
       tolerations:
         {{- include "common.tplvalues.render" ( dict "value" .Values.backstage.tolerations "context" $) | nindent 8 }}
       {{- end }}
+      {{- if .Values.backstage.hostAliases }}
+      hostAliases:
+        {{- include "common.tplvalues.render" ( dict "value" .Values.backstage.hostAliases "context" $) | nindent 8 }}
+      {{- end }}
       volumes:
         {{- if (or .Values.backstage.extraAppConfig (and .Values.backstage.extraVolumeMounts .Values.backstage.extraVolumes)) }}
         {{- range .Values.backstage.extraAppConfig }}

diff --git a/charts/backstage/values.schema.json b/charts/backstage/values.schema.json
@@ -1430,6 +1430,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -1620,6 +1621,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -2002,6 +2004,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -2979,6 +2982,7 @@
                                                         "x-kubernetes-map-type": "atomic"
                                                     },
                                                     "dataSourceRef": {
+                                                        "description": "TypedObjectReference contains enough information to let you locate the typed referenced object",
                                                         "properties": {
                                                             "apiGroup": {
                                                                 "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
@@ -3978,6 +3982,33 @@
                     "title": "Backstage container additional volumes",
                     "type": "array"
                 },
+                "hostAliases": {
+                    "default": [],
+                    "description": "Ref: https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/#adding-additional-entries-with-hostaliases",
+                    "items": {
+                        "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
+                        "properties": {
+                            "hostnames": {
+                                "description": "Hostnames for the above IP address.",
+                                "items": {
+                                    "type": "string"
+                                },
+                                "type": "array",
+                                "x-kubernetes-list-type": "atomic"
+                            },
+                            "ip": {
+                                "description": "IP address of the host file entry.",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "ip"
+                        ],
+                        "type": "object"
+                    },
+                    "title": "Adding entries to a Pod's /etc/hosts file provides Pod-level override of hostname resolution when DNS and other options are not applicable",
+                    "type": "array"
+                },
                 "image": {
                     "additionalProperties": false,
                     "properties": {
@@ -4480,6 +4511,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -4670,6 +4702,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -5052,6 +5085,7 @@
                                         "type": "integer"
                                     },
                                     "grpc": {
+                                        "description": "GRPCAction specifies an action involving a GRPC service.",
                                         "properties": {
                                             "port": {
                                                 "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -5310,6 +5344,7 @@
                             "type": "integer"
                         },
                         "grpc": {
+                            "description": "GRPCAction specifies an action involving a GRPC service.",
                             "properties": {
                                 "port": {
                                     "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -5631,6 +5666,7 @@
                             "type": "integer"
                         },
                         "grpc": {
+                            "description": "GRPCAction specifies an action involving a GRPC service.",
                             "properties": {
                                 "port": {
                                     "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -5846,6 +5882,7 @@
                             "type": "integer"
                         },
                         "grpc": {
+                            "description": "GRPCAction specifies an action involving a GRPC service.",
                             "properties": {
                                 "port": {
                                     "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",

diff --git a/charts/backstage/values.schema.tmpl.json b/charts/backstage/values.schema.tmpl.json
@@ -574,6 +574,15 @@
                     },
                     "default": []
                 },
+                "hostAliases": {
+                    "title": "Adding entries to a Pod's /etc/hosts file provides Pod-level override of hostname resolution when DNS and other options are not applicable",
+                    "description": "Ref: https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/#adding-additional-entries-with-hostaliases",
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.HostAlias"
+                    },
+                    "default": []
+                },
                 "podAnnotations": {
                     "title": "Annotations to add to the backend deployment pods",
                     "type": "object",

diff --git a/charts/backstage/values.yaml b/charts/backstage/values.yaml
@@ -278,6 +278,10 @@ backstage:
   #    value: "value"
   #    effect: "NoSchedule|PreferNoSchedule|NoExecute"
 
+  # -- Host Aliases for the pod
+  # <br /> Ref: https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
+  hostAliases: []
+
   # -- Annotations to add to the backend deployment pods
   podAnnotations: {}