Skip to content

Latest commit

 

History

History
187 lines (128 loc) · 4.97 KB

DEVELOPMENT.md

File metadata and controls

187 lines (128 loc) · 4.97 KB
Raw

Development

This doc explains how to setup a development environment so you can get started contributing to Knative net-gateway-api. Also take a look at:

Getting started

  1. Create a GitHub account
  2. Setup GitHub access via SSH
  3. Install requirements
  4. Set up your shell environment
  5. Create and checkout a repo fork

Before submitting a PR, see also CONTRIBUTING.md.

Requirements

You must install these tools:

  1. go: The language Knative net-gateway-api is built in
  2. git: For source control
  3. 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=...

  2. $GOPATH/bin on PATH: This is so that tooling installed via go get will work properly.

.bashrc example:

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.

To check out this repository:

  1. Create your own fork of this repo

  2. Clone it to your machine:

mkdir -p ${GOPATH}/src/knative.dev
cd ${GOPATH}/src/knative.dev
git clone [email protected]:${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.

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 or 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 -f config/100-gateway-api.yaml

Deploy Istio

Run the following command to install Istio:

NOTE You can find the Istio version to be installed in ./hack/test-env.sh.

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

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 knative-extensions#23.

Test with Contour

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.

kubectl apply -f "https://raw.githubusercontent.com/projectcontour/contour-operator/${CONTOUR_VERSION}/examples/operator/operator.yaml"

Deploy GatewayClass and Gateway

ko resolve -f ./third_party/contour/gateway/gateway-external.yaml | \
  sed 's/LoadBalancerService/NodePortService/g' | \
  kubectl apply -f -

ko resolve -f ./third_party/contour/gateway/gateway-internal.yaml | \
  kubectl apply -f -

Execute test

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}') )

go test -v -tags=e2e -count=1  ./test/conformance/ingressv2/  -run "TestIngressConformance/hosts/basics" \
  --ingressClass=contour \
  --ingressendpoint="${IPS[0]}"

Some tests are still not available. Please see knative-extensions#36.