Skip to content

Commit e01fac2

Browse files
committed
update tests instructions for common troubleshooting
1 parent d36f1c0 commit e01fac2

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

tests/README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,30 @@ This directory contains the tests for NGINX Gateway Fabric. The tests are divide
1111
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1212
## Table of Contents
1313

14-
- [Prerequisites](#prerequisites)
15-
- [Common steps for all tests](#common-steps-for-all-tests)
16-
- [Step 1 - Create a Kubernetes cluster](#step-1---create-a-kubernetes-cluster)
17-
- [Step 2 - Build and Load Images](#step-2---build-and-load-images)
18-
- [Conformance Testing](#conformance-testing)
19-
- [Step 1 - Install NGINX Gateway Fabric to configured kind cluster](#step-1---install-nginx-gateway-fabric-to-configured-kind-cluster)
20-
- [Option 1 - Build and install NGINX Gateway Fabric from local to configured kind cluster](#option-1---build-and-install-nginx-gateway-fabric-from-local-to-configured-kind-cluster)
21-
- [Option 2 - Install NGINX Gateway Fabric from local already built image to configured kind cluster](#option-2---install-nginx-gateway-fabric-from-local-already-built-image-to-configured-kind-cluster)
22-
- [Step 2 - Build conformance test runner image](#step-2---build-conformance-test-runner-image)
23-
- [Step 3 - Run Gateway conformance tests](#step-3---run-gateway-conformance-tests)
24-
- [Step 4 - Cleanup the conformance test fixtures and uninstall NGINX Gateway Fabric](#step-4---cleanup-the-conformance-test-fixtures-and-uninstall-nginx-gateway-fabric)
25-
- [Step 5 - Revert changes to Go modules](#step-5---revert-changes-to-go-modules)
26-
- [Step 6 - Delete kind cluster](#step-6---delete-kind-cluster)
27-
- [System Testing](#system-testing)
28-
- [Logging in tests](#logging-in-tests)
29-
- [Step 1 - Run the tests](#step-1---run-the-tests)
30-
- [Run the functional tests locally](#run-the-functional-tests-locally)
31-
- [Run the NFR tests on a GKE cluster from a GCP VM](#run-the-nfr-tests-on-a-gke-cluster-from-a-gcp-vm)
32-
- [Longevity testing](#longevity-testing)
33-
- [Common test amendments](#common-test-amendments)
34-
- [Step 2 - Cleanup](#step-2---cleanup)
14+
- [NGINX Gateway Fabric Testing](#nginx-gateway-fabric-testing)
15+
- [Overview](#overview)
16+
- [Table of Contents](#table-of-contents)
17+
- [Prerequisites](#prerequisites)
18+
- [Common steps for all tests](#common-steps-for-all-tests)
19+
- [Step 1 - Create a Kubernetes cluster](#step-1---create-a-kubernetes-cluster)
20+
- [Step 2 - Build and Load Images](#step-2---build-and-load-images)
21+
- [Conformance Testing](#conformance-testing)
22+
- [Step 1 - Install NGINX Gateway Fabric to configured kind cluster](#step-1---install-nginx-gateway-fabric-to-configured-kind-cluster)
23+
- [Option 1 - Build and install NGINX Gateway Fabric from local to configured kind cluster](#option-1---build-and-install-nginx-gateway-fabric-from-local-to-configured-kind-cluster)
24+
- [Option 2 - Install NGINX Gateway Fabric from local already built image to configured kind cluster](#option-2---install-nginx-gateway-fabric-from-local-already-built-image-to-configured-kind-cluster)
25+
- [Step 2 - Build conformance test runner image](#step-2---build-conformance-test-runner-image)
26+
- [Step 3 - Run Gateway conformance tests](#step-3---run-gateway-conformance-tests)
27+
- [Step 4 - Cleanup the conformance test fixtures and uninstall NGINX Gateway Fabric](#step-4---cleanup-the-conformance-test-fixtures-and-uninstall-nginx-gateway-fabric)
28+
- [Step 5 - Revert changes to Go modules](#step-5---revert-changes-to-go-modules)
29+
- [Step 6 - Delete kind cluster](#step-6---delete-kind-cluster)
30+
- [System Testing](#system-testing)
31+
- [Logging in tests](#logging-in-tests)
32+
- [Step 1 - Run the tests](#step-1---run-the-tests)
33+
- [Run the functional tests locally](#run-the-functional-tests-locally)
34+
- [Run the NFR tests on a GKE cluster from a GCP VM](#run-the-nfr-tests-on-a-gke-cluster-from-a-gcp-vm)
35+
- [Longevity testing](#longevity-testing)
36+
- [Common test amendments](#common-test-amendments)
37+
- [Step 2 - Cleanup](#step-2---cleanup)
3538

3639
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3740

0 commit comments

Comments
 (0)