edit kind cluster creation with dual stack

Author: salonichf5

Makefile

@@ -7,6 +7,7 @@ MANIFEST_DIR = $(CURDIR)/deploy/manifests
 CHART_DIR = $(SELF_DIR)charts/nginx-gateway-fabric
 NGINX_CONF_DIR = internal/mode/static/nginx/conf
 NJS_DIR = internal/mode/static/nginx/modules/src
+KIND_CONFIG_FILE = $(SELF_DIR)config/cluster/kind-cluster.yaml
 NGINX_DOCKER_BUILD_PLUS_ARGS = --secret id=nginx-repo.crt,src=nginx-repo.crt --secret id=nginx-repo.key,src=nginx-repo.key
 BUILD_AGENT=local
 PLUS_ENABLED ?= false
@@ -160,7 +161,7 @@ deps: ## Add missing and remove unused modules, verify deps and download them to
 .PHONY: create-kind-cluster
 create-kind-cluster: ## Create a kind cluster
 	$(eval KIND_IMAGE=$(shell grep -m1 'FROM kindest/node' <$(SELF_DIR)tests/Dockerfile | awk -F'[ ]' '{print $$2}'))
-	kind create cluster --image $(KIND_IMAGE)
+	kind create cluster --image $(KIND_IMAGE) --config $(KIND_CONFIG_FILE)
 
 .PHONY: delete-kind-cluster
 delete-kind-cluster: ## Delete kind cluster

apis/v1alpha1/nginxproxy_types.go

@@ -31,6 +31,7 @@ type NginxProxyList struct {
 // IPFamilyType specifies the IP family to be used by NGINX.
 //
 // +kubebuilder:validation:Enum=dual;ipv4;ipv6
+// +kubebuilder:default:=dual
 type IPFamilyType string
 
 const (

apis/v1alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,9 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+networking:
+  ipFamily: dual
+  # ipFamily: ipv6
+  # ipFamily: ipv4
+  apiServerAddress: 127.0.0.1

config/cluster/kind-cluster.yaml

@@ -114,29 +114,24 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
 
 1. Create a `kind` cluster:
 
-   To create a `kind` cluster with IPv4 enabled:
+   To create a `kind` cluster with dual (IPv4 and IPv6) enabled:
 
    ```makefile
    make create-kind-cluster
    ```
 
-   To create a `kind` cluster with IPv6 or Dual IPFamily enabled, use this `config.yaml`:
+   To create a `kind` cluster with IPv6 or IPv4 only, edit kind cluster config located at `nginx-gateway-fabric/config/cluster/kind-cluster.yaml`:
 
    ```yaml
    kind: Cluster
    apiVersion: kind.x-k8s.io/v1alpha4
    nodes:
    - role: control-plane
    networking:
-     ipFamily: dual
-     # ipFamily: ipv6
+     ipFamily: ipv6
      apiServerAddress: 127.0.0.1
    ```
 
-   ```shell
-   kind create cluster --config ~/cluster.yaml
-   ```
-
 2. Load the previously built images onto your `kind` cluster:
 
    ```shell

docs/developer/quickstart.md

@@ -299,44 +299,44 @@ NginxProxySpec
 <table class="table table-bordered table-striped">
 <tr>
 <td>
-<code>telemetry</code><br/>
+<code>ipFamily</code><br/>
 <em>
-<a href="#gateway.nginx.org/v1alpha1.Telemetry">
-Telemetry
+<a href="#gateway.nginx.org/v1alpha1.IPFamilyType">
+IPFamilyType
 </a>
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>Telemetry specifies the OpenTelemetry configuration.</p>
+<p>IPFamily specifies the IP family to be used by the server.
+Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>disableHTTP2</code><br/>
+<code>telemetry</code><br/>
 <em>
-bool
+<a href="#gateway.nginx.org/v1alpha1.Telemetry">
+Telemetry
+</a>
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>DisableHTTP2 defines if http2 should be disabled for all servers.
-Default is false, meaning http2 will be enabled for all servers.</p>
+<p>Telemetry specifies the OpenTelemetry configuration.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>ipFamily</code><br/>
+<code>disableHTTP2</code><br/>
 <em>
-<a href="#gateway.nginx.org/v1alpha1.IPFamilyType">
-IPFamilyType
-</a>
+bool
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>IPFamily specifies the IP family to be used by the server.
-Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
+<p>DisableHTTP2 defines if http2 should be disabled for all servers.
+Default is false, meaning http2 will be enabled for all servers.</p>
 </td>
 </tr>
 </table>
@@ -921,44 +921,44 @@ Logging
 <tbody>
 <tr>
 <td>
-<code>telemetry</code><br/>
+<code>ipFamily</code><br/>
 <em>
-<a href="#gateway.nginx.org/v1alpha1.Telemetry">
-Telemetry
+<a href="#gateway.nginx.org/v1alpha1.IPFamilyType">
+IPFamilyType
 </a>
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>Telemetry specifies the OpenTelemetry configuration.</p>
+<p>IPFamily specifies the IP family to be used by the server.
+Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>disableHTTP2</code><br/>
+<code>telemetry</code><br/>
 <em>
-bool
+<a href="#gateway.nginx.org/v1alpha1.Telemetry">
+Telemetry
+</a>
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>DisableHTTP2 defines if http2 should be disabled for all servers.
-Default is false, meaning http2 will be enabled for all servers.</p>
+<p>Telemetry specifies the OpenTelemetry configuration.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>ipFamily</code><br/>
+<code>disableHTTP2</code><br/>
 <em>
-<a href="#gateway.nginx.org/v1alpha1.IPFamilyType">
-IPFamilyType
-</a>
+bool
 </em>
 </td>
 <td>
 <em>(Optional)</em>
-<p>IPFamily specifies the IP family to be used by the server.
-Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
+<p>DisableHTTP2 defines if http2 should be disabled for all servers.
+Default is false, meaning http2 will be enabled for all servers.</p>
 </td>
 </tr>
 </tbody>