Skip to content

Commit

Permalink
update makefile and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@salonichf5
salonichf5 committed Mar 8, 2024
1 parent f248ffb commit 660a029
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 54 deletions.
45 changes: 24 additions & 21 deletions conformance/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,30 @@ make
```

```text
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
cleanup-gcp Cleanup all GCP resources
cleanup-router Delete the GKE router
cleanup-vm Delete the test GCP VM and delete the firewall rule
create-and-setup-vm Create and setup a GCP VM for tests
create-gke-cluster Create a GKE cluster
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
create-kind-cluster Create a kind cluster
delete-gke-cluster Delete the GKE cluster
delete-kind-cluster Delete kind cluster
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
functional-test Run the functional tests with NGINX against your default k8s cluster
help Display this help
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
load-images Load NGF and NGINX images on configured kind cluster
run-tests-on-vm Run the tests on a GCP VM
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
test Run the system tests against your default k8s cluster
update-go-modules Update the gateway-api go modules to latest main version
update-ngf-manifest-with-plus Update the NGF deployment manifest image names and imagePullPolicies including nginx-plus
update-ngf-manifest Update the NGF deployment manifest image names and imagePullPolicies
build-images-with-plus Build NGF and NGINX Plus images
build-images Build NGF and NGINX images
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-ngf-edge Install NGF with provisioner from edge on configured kind cluster
install-ngf-local-build-with-plus Install NGF with Plus from local build with provisioner on configured kind cluster
install-ngf-local-build Install NGF from local build with provisioner on configured kind cluster
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
install-ngf-local-no-build Install NGF from local build with provisioner on configured kind cluster but do not build the NGF image
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
load-images Load NGF and NGINX images on configured kind cluster
prepare-ngf-dependencies-with-plus Install NGF dependencies with Plus on configured kind cluster
prepare-ngf-dependencies Install NGF dependencies on configured kind cluster
reset-go-modules Reset the go modules changes
run-conformance-tests Run conformance tests
undo-manifests-update Undo the changes in the manifest files
uninstall-ngf Uninstall NGF on configured kind cluster and undo manifest changes
update-go-modules Update the gateway-api go modules to latest main version
update-ngf-manifest-with-plus Update the NGF deployment manifest image names and imagePullPolicies including nginx-plus
update-ngf-manifest Update the NGF deployment manifest image names and imagePullPolicies
```

**Note:** The following variables are configurable when running the below `make` commands:
Expand Down
2 changes: 1 addition & 1 deletion tests/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ test: ## Run the system tests against your default k8s cluster
--gateway-api-prev-version=$(GW_API_PREV_VERSION) --image-tag=$(TAG) --version-under-test=$(NGF_VERSION) \
--plus-enabled=$(PLUS_ENABLED) --ngf-image-repo=$(PREFIX) --nginx-image-repo=$(NGINX_PREFIX) \
--pull-policy=$(PULL_POLICY) --k8s-version=$(K8S_VERSION) --service-type=$(GW_SERVICE_TYPE) \
--is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL) --ginkgo.vv
--is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL)

.PHONY: functional-test
functional-test: ## Run the functional tests with NGINX against your default k8s cluster
Expand Down
52 changes: 20 additions & 32 deletions tests/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,24 @@ make
```

```text
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
cleanup-gcp Cleanup all GCP resources
cleanup-router Delete the GKE router
cleanup-vm Delete the test GCP VM and delete the firewall rule
create-and-setup-vm Create and setup a GCP VM for tests
create-gke-cluster Create a GKE cluster
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
create-kind-cluster Create a kind cluster
delete-gke-cluster Delete the GKE cluster
delete-kind-cluster Delete kind cluster
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
functional-test Run the functional tests with NGINX against your default k8s cluster
help Display this help
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
load-images Load NGF and NGINX images on configured kind cluster
run-tests-on-vm Run the tests on a GCP VM
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
test Run the system tests against your default k8s cluster
add-local-ip-to-cluster Add local IP to the GKE cluster master-authorized-networks
cleanup-gcp Cleanup all GCP resources
cleanup-router Delete the GKE router
cleanup-vm Delete the test GCP VM and delete the firewall rule
create-and-setup-vm Create and setup a GCP VM for tests
create-gke-cluster Create a GKE cluster
create-gke-router Create a GKE router to allow egress traffic from private nodes (allows for external image pulls)
create-kind-cluster Create a kind cluster
delete-gke-cluster Delete the GKE cluster
delete-kind-cluster Delete kind cluster
functional-test-nginx-plus Run the functional tests with NGINX Plus against your default k8s cluster
functional-test Run the functional tests with NGINX against your default k8s cluster
help Display this help
load-images-with-plus Load NGF and NGINX Plus images on configured kind cluster
load-images Load NGF and NGINX images on configured kind cluster
run-tests-on-vm Run the tests on a GCP VM
setup-gcp-and-run-tests Create and setup a GKE router and GCP VM for tests and run the tests
test Run the system tests against your default k8s cluster
```

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

## Step 3 - Run the tests

### 3a - Run all the tests locally
### 3a - Run the tests locally

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

### 3b - Run the functional tests locally

```makefile
make functional-test TAG=$(whoami)
```

Or, to run the tests with NGINX Plus enabled:

```makefile
make functional-test-nginx-plus TAG=$(whoami)
```

### 3c - Run the tests on a GKE cluster from a GCP VM
### 3b - Run the tests on a GKE cluster from a GCP VM

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

Expand Down

0 comments on commit 660a029

Please sign in to comment.