README.md

Running Gateway Conformance Tests in kind

Prerequisites:

• kind.
• Docker.
• Golang.
• yq

Note: all commands in steps below are executed from the conformance directory

List available commands:

$ make

build-nkg-image                Build NKG container and load it and NGINX container on configured kind cluster
build-test-runner-image        Build conformance test runner image
cleanup-conformance-tests      Clean up conformance tests fixtures
create-kind-cluster            Create a kind cluster
delete-kind-cluster            Delete kind cluster
deploy-updated-provisioner     Update provisioner manifest and deploy to the configured kind cluster
help                           Display this help
install-nkg-edge               Install NKG with provisioner from edge on configured kind cluster
install-nkg-local-build        Install NKG from local build with provisioner on configured kind cluster
install-nkg-local-no-build     Install NKG from local build with provisioner on configured kind cluster but do not build the NKG image
load-images                    Load NKG and NGINX containers on configured kind cluster
preload-nginx-container        Preload NGINX container on configured kind cluster
prepare-nkg-dependencies       Install NKG dependencies on configured kind cluster
run-conformance-tests          Run conformance tests
undo-image-update              Undo the NKG image name and tag in deployment manifest
uninstall-nkg                  Uninstall NKG on configured kind cluster
update-nkg-manifest            Update the NKG deployment manifest image name and imagePullPolicy

Note: The following variables are configurable when running the below make commands:

Variable	Default	Description
TAG	latest	The tag for the conformance test image
PREFIX	conformance-test-runner	The prefix for the conformance test image
NKG_TAG	edge	The tag for the locally built NKG image
NKG_PREFIX	nginx-kubernetes-gateway	The prefix for the locally built NKG image
KIND_KUBE_CONFIG	~/.kube/kind/config	The location of the kubeconfig
GATEWAY_CLASS	nginx	The gateway class that should be used for the tests
SUPPORTED_FEATURES	HTTPRoute,HTTPRouteQueryParamMatching, HTTPRouteMethodMatching,HTTPRoutePortRedirect, HTTPRouteSchemeRedirect	The supported features that should be tested by the conformance tests. Ensure the list is comma separated with no spaces.
EXEMPT_FEATURES	ReferenceGrant	The features that should not be tested by the conformance tests
NGINX_IMAGE	as defined in the ../deploy/manifests/deployment.yaml file	The NGINX image for the NKG deployments
NKG_DEPLOYMENT_MANIFEST	../deploy/manifests/deployment.yaml	The location of the NKG deployment manifest

Step 1 - Create a kind Cluster

$ make create-kind-cluster

Step 2 - Install Nginx Kubernetes Gateway to configured kind cluster

Option 1 Build and install Nginx Kubernetes Gateway from local to configured kind cluster

$ make install-nkg-local-build

Option 2 Install Nginx Kubernetes Gateway from local already built image to configured kind cluster

$ make install-nkg-local-no-build

Note: You can optionally skip the actual build step. However, if choosing this option, the following step must be completed manually before the build step:

• Set NKG_PREFIX=<nkg_repo_name> NKG_TAG=<nkg_image_tag> to preferred values.
• Navigate to deploy/manifests and update values in deployment.yaml as specified in below code-block.
• Save the changes.

.
..
containers:
- image: <nkg_repo_name>:<nkg_image_tag>
  imagePullPolicy: Never
..
.

Option 3 Install Nginx Kubernetes Gateway from edge to configured kind cluster

You can also skip the build NKG image step and prepare the environment to instead use the edge image

$ make install-nkg-edge

Step 3 - Build conformance test runner image

$ make build-test-runner-image

Step 4 - Run Gateway conformance tests

$ make run-conformance-tests

Step 5 - Cleanup the conformance test fixtures and uninstall Nginx Kubernetes Gateway

$ make cleanup-conformance-tests
$ make uninstall-nkg

Step 6 - Revert changes to the NKG deployment manifest

Optional Not required if using edge image Warning: make undo-image-update will hard reset changes to the deploy/manifests/deployment.yaml file!

$ make undo-image-update

Step 7 - Delete kind cluster

$ make delete-kind-cluster