Run Go fmt and test in CI

Author: stefanprodan

.github/workflows/build.yml

@@ -1,13 +1,23 @@
-name: CI
+name: build
 
 on: [push, pull_request]
 
 jobs:
-  kustomize:
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - name: Validate manifests
+      - name: Go fmt
+        uses: stefanprodan/kube-tools@v1
+        with:
+          command: |
+            make go-fmt
+      - name: Go test
+        uses: stefanprodan/kube-tools@v1
+        with:
+          command: |
+            make test
+      - name: Validate kustomization
         uses: stefanprodan/kube-tools@v1
         with:
           command: |
@@ -17,7 +27,7 @@ jobs:
             kustomize build ./kustomize/test | kubeval --strict --ignore-missing-schemas
   build:
     runs-on: ubuntu-latest
-    needs: [kustomize]
+    needs: [test]
     steps:
       - uses: actions/checkout@v1
       - name: Build container

.github/workflows/release.yml

@@ -1,6 +1,11 @@
-name: PUSH
+name: release
 
-on: [push]
+on:
+  push:
+    branches-ignore:
+      - '**'
+    tags:
+      - 'v*.*.*'
 
 jobs:
   push-container:

Dockerfile

@@ -8,8 +8,6 @@ COPY . .
 
 RUN go mod download
 
-RUN go test -v -race ./...
-
 RUN CGO_ENABLED=0 GOOS=linux go build -a -o bin/appmesh-gateway cmd/appmesh-gateway/*
 
 FROM alpine:3.10

Makefile

@@ -10,6 +10,9 @@ build:
 test:
 	go test -v -race ./...
 
+go-fmt:
+	gofmt -l pkg/* | grep ".*\.go"; if [ "$$?" = "0" ]; then exit 1; fi;
+
 run:
 	go run cmd/appmesh-gateway/*.go --kubeconfig=$$HOME/.kube/config -v=4 \
 	--gateway-mesh=appmesh --gateway-name=gateway --gateway-namespace=appmesh-gateway

README.md

@@ -1,5 +1,5 @@
 # appmesh-gateway
-[![CI](https://github.com/stefanprodan/appmesh-gateway/workflows/CI/badge.svg)](https://github.com/stefanprodan/appmesh-gateway/actions)
+[![CI](https://github.com/stefanprodan/appmesh-gateway/workflows/build/badge.svg)](https://github.com/stefanprodan/appmesh-gateway/actions)
 [![report](https://goreportcard.com/badge/github.com/stefanprodan/appmesh-gateway)](https://goreportcard.com/report/github.com/stefanprodan/appmesh-gateway)
 
 App Mesh Gateway is an edge load balancer that exposes applications outside the mesh.
@@ -32,12 +32,35 @@ The gateway registers/de-registers virtual services automatically as they come a
 
 ### Install
 
+Requirements:
+* App Mesh CRDs, controller and inject [installed](https://github.com/aws/eks-charts#app-mesh)
+* A mesh called `appmesh`
+
 Install the API Gateway as NLB in `appmesh-gateway` namespace:
 
 ```sh
 kubectl apply -k github.com/stefanprodan/appmesh-gateway//kustomize/appmesh-gateway
 ```
 
+Wait for the deployment rollout to finish:
+
+```sh
+kubectl -n appmesh-gateway rollout status deploy/appmesh-gateway
+```
+
+When the gateway starts it will create a virtual node. You can verify the install with:
+
+```text
+watch kubectl -n appmesh-gateway describe virtualnode appmesh-gateway
+
+Status:
+  Conditions:
+    Status:                True
+    Type:                  VirtualNodeActive
+```
+
+### Example
+
 Deploy podinfo in the `test` namespace:
 
 ```sh
@@ -61,3 +84,12 @@ Access podinfo on its custom domain:
 ```sh
 curl -vH 'Host: podinfo.internal' localhost:8080
 ```
+
+Access podinfo using the gateway NLB address:
+
+```sh
+URL="http://$(kubectl -n appmesh-gateway get svc/appmesh-gateway -ojson | \
+jq -r ".status.loadBalancer.ingress[].hostname")"
+
+curl -vH 'Host: podinfo.internal' $URL
+```