Skip to content

Commit 660a029

Browse files
committed
update makefile and readme
1 parent f248ffb commit 660a029

File tree

3 files changed

+45
-54
lines changed

3 files changed

+45
-54
lines changed

conformance/README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,30 @@ make
1616
```
1717

1818
```text
19-
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
20-
cleanup-gcp Cleanup all GCP resources
21-
cleanup-router Delete the GKE router
22-
cleanup-vm Delete the test GCP VM and delete the firewall rule
23-
create-and-setup-vm Create and setup a GCP VM for tests
24-
create-gke-cluster Create a GKE cluster
25-
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
26-
create-kind-cluster Create a kind cluster
27-
delete-gke-cluster Delete the GKE cluster
28-
delete-kind-cluster Delete kind cluster
29-
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
30-
functional-test Run the functional tests with NGINX against your default k8s cluster
31-
help Display this help
32-
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
33-
load-images Load NGF and NGINX images on configured kind cluster
34-
run-tests-on-vm Run the tests on a GCP VM
35-
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
36-
test Run the system tests against your default k8s cluster
37-
update-go-modules Update the gateway-api go modules to latest main version
38-
update-ngf-manifest-with-plus Update the NGF deployment manifest image names and imagePullPolicies including nginx-plus
39-
update-ngf-manifest Update the NGF deployment manifest image names and imagePullPolicies
19+
build-images-with-plus Build NGF and NGINX Plus images
20+
build-images Build NGF and NGINX images
21+
build-test-runner-image Build conformance test runner image
22+
cleanup-conformance-tests Clean up conformance tests fixtures
23+
create-kind-cluster Create a kind cluster
24+
delete-kind-cluster Delete kind cluster
25+
deploy-updated-provisioner Update provisioner manifest and deploy to the configured kind cluster
26+
help Display this help
27+
install-ngf-edge Install NGF with provisioner from edge on configured kind cluster
28+
install-ngf-local-build-with-plus Install NGF with Plus from local build with provisioner on configured kind cluster
29+
install-ngf-local-build Install NGF from local build with provisioner on configured kind cluster
30+
install-ngf-local-no-build-with-plus Install NGF with Plus from local build with provisioner on configured kind cluster but do not build the NGF image
31+
install-ngf-local-no-build Install NGF from local build with provisioner on configured kind cluster but do not build the NGF image
32+
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
33+
load-images Load NGF and NGINX images on configured kind cluster
34+
prepare-ngf-dependencies-with-plus Install NGF dependencies with Plus on configured kind cluster
35+
prepare-ngf-dependencies Install NGF dependencies on configured kind cluster
36+
reset-go-modules Reset the go modules changes
37+
run-conformance-tests Run conformance tests
38+
undo-manifests-update Undo the changes in the manifest files
39+
uninstall-ngf Uninstall NGF on configured kind cluster and undo manifest changes
40+
update-go-modules Update the gateway-api go modules to latest main version
41+
update-ngf-manifest-with-plus Update the NGF deployment manifest image names and imagePullPolicies including nginx-plus
42+
update-ngf-manifest Update the NGF deployment manifest image names and imagePullPolicies
4043
```
4144

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

tests/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ test: ## Run the system tests against your default k8s cluster
4545
--gateway-api-prev-version=$(GW_API_PREV_VERSION) --image-tag=$(TAG) --version-under-test=$(NGF_VERSION) \
4646
--plus-enabled=$(PLUS_ENABLED) --ngf-image-repo=$(PREFIX) --nginx-image-repo=$(NGINX_PREFIX) \
4747
--pull-policy=$(PULL_POLICY) --k8s-version=$(K8S_VERSION) --service-type=$(GW_SERVICE_TYPE) \
48-
--is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL) --ginkgo.vv
48+
--is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL)
4949

5050
.PHONY: functional-test
5151
functional-test: ## Run the functional tests with NGINX against your default k8s cluster

tests/README.md

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,24 @@ make
3737
```
3838

3939
```text
40-
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
41-
cleanup-gcp Cleanup all GCP resources
42-
cleanup-router Delete the GKE router
43-
cleanup-vm Delete the test GCP VM and delete the firewall rule
44-
create-and-setup-vm Create and setup a GCP VM for tests
45-
create-gke-cluster Create a GKE cluster
46-
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
47-
create-kind-cluster Create a kind cluster
48-
delete-gke-cluster Delete the GKE cluster
49-
delete-kind-cluster Delete kind cluster
50-
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
51-
functional-test Run the functional tests with NGINX against your default k8s cluster
52-
help Display this help
53-
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
54-
load-images Load NGF and NGINX images on configured kind cluster
55-
run-tests-on-vm Run the tests on a GCP VM
56-
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
57-
test Run the system tests against your default k8s cluster
40+
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
41+
cleanup-gcp Cleanup all GCP resources
42+
cleanup-router Delete the GKE router
43+
cleanup-vm Delete the test GCP VM and delete the firewall rule
44+
create-and-setup-vm Create and setup a GCP VM for tests
45+
create-gke-cluster Create a GKE cluster
46+
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
47+
create-kind-cluster Create a kind cluster
48+
delete-gke-cluster Delete the GKE cluster
49+
delete-kind-cluster Delete kind cluster
50+
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
51+
functional-test Run the functional tests with NGINX against your default k8s cluster
52+
help Display this help
53+
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
54+
load-images Load NGF and NGINX images on configured kind cluster
55+
run-tests-on-vm Run the tests on a GCP VM
56+
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
57+
test Run the system tests against your default k8s cluster
5858
```
5959

6060
**Note:** The following variables are configurable when running the below `make` commands:
@@ -128,7 +128,7 @@ make build-images-with-plus load-images-with-plus TAG=$(whoami)
128128

129129
## Step 3 - Run the tests
130130

131-
### 3a - Run all the tests locally
131+
### 3a - Run the tests locally
132132

133133
```makefile
134134
make test TAG=$(whoami)
@@ -140,19 +140,7 @@ Or, to run the tests with NGINX Plus enabled:
140140
make test TAG=$(whoami) PLUS_ENABLED=true
141141
```
142142

143-
### 3b - Run the functional tests locally
144-
145-
```makefile
146-
make functional-test TAG=$(whoami)
147-
```
148-
149-
Or, to run the tests with NGINX Plus enabled:
150-
151-
```makefile
152-
make functional-test-nginx-plus TAG=$(whoami)
153-
```
154-
155-
### 3c - Run the tests on a GKE cluster from a GCP VM
143+
### 3b - Run the tests on a GKE cluster from a GCP VM
156144

157145
This step only applies if you would like to run the tests on a GKE cluster from a GCP based VM.
158146

0 commit comments

Comments
 (0)