forked from knative-extensions/net-gateway-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DRY test scripts + improve documentation
Closes knative-extensions#322. Closes knative-extensions#292. Think along the lines on how to refactor and organize for having tests for multiple vendors. This is only a start.
- Loading branch information
Showing
7 changed files
with
195 additions
and
287 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,187 +1,40 @@ | ||
| # Development | ||
|
|
||
| This doc explains how to setup a development environment so you can get started | ||
| [contributing](https://www.knative.dev/contributing/) to Knative | ||
| `net-gateway-api`. Also take a look at: | ||
| contributing to Knative `net-gateway-api`. | ||
|
|
||
| Before submitting a PR, see also: | ||
| - [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
| - [The pull request workflow](https://knative.dev/community/contributing/reviewing/) | ||
|
|
||
| ## Getting started | ||
| __NOTE__ If you use the konk script to setup your cluster, your cluster will be named `knative`. However, most of the scripts expect it to be the default `kind` name. Set the kind cluster name env `export KIND_CLUSTER_NAME=knative` to point to `knative` cluster. KO requires a registry which if you are developing locally you could use `export KO_DOCKER_REPO=kind.local` to use the local one on kind. Please see official [KO documentation](https://github.com/google/ko#local-publishing-options) for more information. | ||
|
|
||
| 1. Create [a GitHub account](https://github.com/join) | ||
| 1. Setup | ||
| [GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) | ||
| 1. Install [requirements](#requirements) | ||
| 1. Set up your [shell environment](#environment-setup) | ||
| 1. [Create and checkout a repo fork](#checkout-your-fork) | ||
| __NOTE__ Versions to be installed are listed in `./hack/test-env.sh`. | ||
|
|
||
| Before submitting a PR, see also [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
| __NOTE__ Tests are currently wip. Please see [README#tests](README.md#tests) | ||
|
|
||
| ### Requirements | ||
| 1. A Kind cluster | ||
| 1. [Knative serving installed](README.md#install-knative-serving) | ||
| 1. [`ko`](https://github.com/google/ko): For development. | ||
| 1. [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/): For managing development environments. | ||
|
|
||
| You must install these tools: | ||
|
|
||
| 1. [`go`](https://golang.org/doc/install): The language Knative `net-gateway-api` | ||
| is built in | ||
| 1. [`git`](https://help.github.com/articles/set-up-git/): For source control | ||
| 1. [`dep`](https://github.com/golang/dep): For managing external dependencies. | ||
|
|
||
| ### Environment setup | ||
|
|
||
| To get started you'll need to set these environment variables (we recommend | ||
| adding them to your `.bashrc`): | ||
|
|
||
| 1. `GOPATH`: If you don't have one, simply pick a directory and add | ||
| `export GOPATH=...` | ||
|
|
||
| 1. `$GOPATH/bin` on `PATH`: This is so that tooling installed via `go get` will | ||
| work properly. | ||
|
|
||
| `.bashrc` example: | ||
|
|
||
| ```shell | ||
| export GOPATH="$HOME/go" | ||
| export PATH="${PATH}:${GOPATH}/bin" | ||
| ``` | ||
|
|
||
| ### Checkout your fork | ||
|
|
||
| The Go tools require that you clone the repository to the | ||
| `src/knative.dev/net-gateway-api` directory in your | ||
| [`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH). | ||
|
|
||
| To check out this repository: | ||
|
|
||
| 1. Create your own | ||
| [fork of this repo](https://help.github.com/articles/fork-a-repo/) | ||
|
|
||
| 1. Clone it to your machine: | ||
|
|
||
| ```shell | ||
| mkdir -p ${GOPATH}/src/knative.dev | ||
| cd ${GOPATH}/src/knative.dev | ||
| git clone git@github.com:${YOUR_GITHUB_USERNAME}/net-gateway-api.git | ||
| cd net-gateway-api | ||
| git remote add upstream https://github.com/knative-sandbox/net-gateway-api.git | ||
| git remote set-url --push upstream no_push | ||
| ``` | ||
|
|
||
| _Adding the `upstream` remote sets you up nicely for regularly | ||
| [syncing your fork](https://help.github.com/articles/syncing-a-fork/)._ | ||
|
|
||
| Once you reach this point you are ready to do a full build and deploy as | ||
| described below. | ||
|
|
||
| ### Execute conformance tests | ||
|
|
||
| Currently this repo tests with Istio and Contour. Please follow | ||
| [Test with Istio](#test-with-istio) or [Test with Contour](#test-with-contour). | ||
|
|
||
| ### Test with Istio | ||
|
|
||
| #### Prepare test resources such as namespaces | ||
|
|
||
| ``` | ||
| kubectl apply -f test/config/ | ||
| ``` | ||
|
|
||
| #### Load tested environment versions | ||
|
|
||
| ``` | ||
| source ./hack/test-env.sh | ||
| ``` | ||
|
|
||
| #### Install Gateway API CRDs | ||
|
|
||
| ``` | ||
| kubectl apply -k "github.com/kubernetes-sigs/gateway-api/config/crd?ref=${GATEWAY_API_VERSION}" | ||
| ``` | ||
|
|
||
| #### Deploy Istio | ||
|
|
||
| Run the following command to install Istio: | ||
|
|
||
| __NOTE__ You can find the Istio version to be installed in `./hack/test-env.sh`. | ||
|
|
||
| ```shell | ||
| curl -sL https://istio.io/downloadIstioctl | sh - | ||
| $HOME/.istioctl/bin/istioctl install -y | ||
| ``` | ||
|
|
||
| #### Deploy GatewayClass and Gateway | ||
|
|
||
| ``` | ||
| kubectl apply -f ./third_party/istio/gateway/ | ||
| ``` | ||
|
|
||
| #### Execute test | ||
|
|
||
| ```shell | ||
| GATEWAY_OVERRIDE=istio-ingressgateway | ||
| GATEWAY_NAMESPACE_OVERRIDE=istio-system | ||
| IPS=( $(kubectl get nodes -lkubernetes.io/hostname!=kind-control-plane -ojsonpath='{.items[*].status.addresses[?(@.type=="InternalIP")].address}') ) | ||
|
|
||
| go test -v -tags=e2e -count=1 ./test/conformance/ingressv2/ -run "TestIngressConformance/basics" \ | ||
| --ingressClass=istio \ | ||
| --ingressendpoint="${IPS[0]}" | ||
| ``` | ||
|
|
||
| Some tests are still not available. Please see | ||
| https://github.com/knative-sandbox/net-gateway-api/issues/23. | ||
|
|
||
| ### Test with Contoour | ||
|
|
||
| #### Prepare test resources such as namespaces | ||
|
|
||
| ``` | ||
| kubectl apply -f test/config/ | ||
| ``` | ||
|
|
||
| #### Load tested environment versions | ||
|
|
||
| ``` | ||
| source ./hack/test-env.sh | ||
| ``` | ||
|
|
||
| #### Install Gateway API CRDs | ||
|
|
||
| This step is not necessary for Contour as contour operator installs Gateway API | ||
| CRDs. | ||
|
|
||
| #### Deploy Contour | ||
|
|
||
| Run the following command to install Contour and its operator. | ||
|
|
||
| __NOTE__ You can find the Contour version to be installed in `./hack/test-env.sh`. | ||
| ## Testing | ||
| Currently this repo contains Knative conformance tests that run with Istio and Contour. | ||
|
|
||
| ```shell | ||
| kubectl apply -f "https://raw.githubusercontent.com/projectcontour/contour-operator/${CONTOUR_VERSION}/examples/operator/operator.yaml" | ||
| ``` | ||
| ### Conformance | ||
| #### Istio | ||
|
|
||
| #### Deploy GatewayClass and Gateway | ||
| `./test/kind-conformance-istio.sh` | ||
|
|
||
| ``` | ||
| ko resolve -f ./third_party/contour/gateway/gateway-external.yaml | \ | ||
| sed 's/LoadBalancerService/NodePortService/g' | \ | ||
| kubectl apply -f - | ||
| #### Contour | ||
|
|
||
| ko resolve -f ./third_party/contour/gateway/gateway-internal.yaml | \ | ||
| kubectl apply -f - | ||
| ``` | ||
| `./test/kind-conformance-contour.sh` | ||
|
|
||
| #### Execute test | ||
| ### e2e | ||
| #### Istio | ||
|
|
||
| ```shell | ||
| GATEWAY_OVERRIDE=envoy | ||
| GATEWAY_NAMESPACE_OVERRIDE=contour-external | ||
| LOCAL_GATEWAY_OVERRIDE=envoy | ||
| LOCAL_GATEWAY_NAMESPACE_OVERRIDE=contour-internal | ||
| IPS=( $(kubectl get nodes -lkubernetes.io/hostname!=kind-control-plane -ojsonpath='{.items[*].status.addresses[?(@.type=="InternalIP")].address}') ) | ||
| `./test/kind-e2e-istio.sh` | ||
|
|
||
| go test -v -tags=e2e -count=1 ./test/conformance/ingressv2/ -run "TestIngressConformance/hosts/basics" \ | ||
| --ingressClass=contour \ | ||
| --ingressendpoint="${IPS[0]}" | ||
| ``` | ||
| #### Contour | ||
|
|
||
| Some tests are still not available. Please see | ||
| https://github.com/knative-sandbox/net-gateway-api/issues/36. | ||
| `./test/kind-e2e-contour.sh` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.