Support ipFamilies on services

Signed-off-by: Arend Lapere <[email protected]>
opensearch-project · Mar 23, 2023 · a52861a · a52861a
1 parent 9d9949c
commit a52861a
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 2 deletions.
diff --git a/charts/opensearch-dashboards/CHANGELOG.md b/charts/opensearch-dashboards/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2.9.2]
 ### Added
 - Support setting ipFamilyPolicy on Service
+- Support setting ipFamilies on Service
 ---
 ## [2.9.1]
 ### Added

diff --git a/charts/opensearch-dashboards/README.md b/charts/opensearch-dashboards/README.md
@@ -73,6 +73,7 @@
 | `service.transportPortName`        | The name of the transport port within the service                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `transport`                                     |
 | `service.type`                     | OpenSearch [Service Types][]                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | `ClusterIP`                                     |
 | `service.ipFamilyPolicy`           | This sets the preferred ip addresses in case of a dual-stack server, there are three options [PreferDualStack, SingleStack, RequireDualStack], [more information on dual stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/)                                                                                                                                                                                                                                                 | `""`                                            |
+| `service.ipFamilies`               | Sets the preferred IP variants and in which order they are preferred, the first family you list is used for the legacy .spec.ClusterIP field, [more information on dual stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/)                                                                                                                                                                                                                                                  | `""`                                            |
 | `tolerations`                      | Configurable [tolerations][]                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | `[]`                                            |
 | `updateStrategy`                   | The [updateStrategy][] for the StatefulSet. By default Kubernetes will wait for the cluster to be green after upgrading each pod. Setting this to `OnDelete` will allow you to manually delete each pod during upgrades                                                                                                                                                                                                                                                                              | `RollingUpdate`                                 |
 | `extraObjects`                     | Array of extra K8s manifests to deploy                                                                                                                                                                                                                                                                                                                                                                                                                                                               | list `[]`                                       |

diff --git a/charts/opensearch-dashboards/templates/service.yaml b/charts/opensearch-dashboards/templates/service.yaml
@@ -14,8 +14,13 @@ metadata:
 spec:
   type: {{ .Values.service.type }}
   {{- if (semverCompare ">= 1.23-0" .Capabilities.KubeVersion.Version) }}
+  {{- if .Values.service.ipFamilyPolicy }}
   ipFamilyPolicy: {{ .Values.service.ipFamilyPolicy }}
   {{- end }}
+  {{- if .Values.service.ipFamilies }}
+  ipFamilies: {{ .Values.service.ipFamilies }}
+  {{- end }}
+  {{- end }}
 {{- if .Values.service.loadBalancerIP }}
   loadBalancerIP: {{ .Values.service.loadBalancerIP }}
 {{- end }}

diff --git a/charts/opensearch-dashboards/values.yaml b/charts/opensearch-dashboards/values.yaml
@@ -145,7 +145,13 @@ serverHost: "0.0.0.0"
 
 service:
   type: ClusterIP
-  ipFamilyPolicy: SingleStack
+  # The IP family and IP families options are to set the behaviour in a dual-stack environment
+  # Omitting these values will let the service fall back to whatever the CNI dictates the defaults
+  # should be
+  #
+  # ipFamilyPolicy: SingleStack
+  # ipFamilies:
+  # - IPv4
   port: 5601
   loadBalancerIP: ""
   nodePort: ""

diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2.11.3]
 ### Added
 - Support setting ipFamilyPolicy on Service
+- Support setting ipFamilies on Service
 ---
 ## [2.11.2]
 ### Added

diff --git a/charts/opensearch/README.md b/charts/opensearch/README.md
@@ -101,6 +101,7 @@ helm uninstall my-release
 | `service.transportPortName`        | The name of the transport port within the service                                                                                                                                                                                                         | `transport`                                     |
 | `service.type`                     | OpenSearch [Service Types][]                                                                                                                                                                                                                           | `ClusterIP`                                     |
 | `service.ipFamilyPolicy`           | This sets the preferred ip addresses in case of a dual-stack server, there are three options [PreferDualStack, SingleStack, RequireDualStack], [more information on dual stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/)      | `""`                                            |
+| `service.ipFamilies`               | Sets the preferred IP variants and in which order they are preferred, the first family you list is used for the legacy .spec.ClusterIP field, [more information on dual stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/)       | `""`                                            |
 | `sidecarResources`                 | Allows you to set the [resources][] for the sidecar containers in the StatefulSet                                                                                                                                                                         | {}                                              |
 | `sysctlInit`              | Allows you to enable the `sysctlInit` to set sysctl vm.max_map_count through privileged `initContainer`.                                                                                                                                        | `enabled: false`                                 |
 | `sysctlVmMaxMapCount`              | Sets the [vm.max_map_count][] needed for OpenSearch                                                                                                                                                                                            | `262144`                                        |

diff --git a/charts/opensearch/templates/service.yaml b/charts/opensearch/templates/service.yaml
@@ -13,8 +13,13 @@ metadata:
 spec:
   type: {{ .Values.service.type }}
   {{- if (semverCompare ">= 1.23-0" .Capabilities.KubeVersion.Version) }}
+  {{- if .Values.service.ipFamilyPolicy }}
   ipFamilyPolicy: {{ .Values.service.ipFamilyPolicy }}
   {{- end }}
+  {{- if .Values.service.ipFamilies }}
+  ipFamilies: {{ .Values.service.ipFamilies }}
+  {{- end }}
+  {{- end }}
   selector:
     {{- include "opensearch.selectorLabels" . | nindent 4 }}
   ports:

diff --git a/charts/opensearch/values.yaml b/charts/opensearch/values.yaml
@@ -270,7 +270,13 @@ service:
   headless:
     annotations: {}
   type: ClusterIP
-  ipFamilyPolicy: SingleStack
+  # The IP family and IP families options are to set the behaviour in a dual-stack environment
+  # Omitting these values will let the service fall back to whatever the CNI dictates the defaults
+  # should be
+  #
+  # ipFamilyPolicy: SingleStack
+  # ipFamilies:
+  # - IPv4
   nodePort: ""
   annotations: {}
   httpPortName: http