flagger-appmesh-gateway

KO | EN

gitlite — search

#react #javascript #postgresql #html #python #deno #github-actions #unity #nextjs #api #serverless #vite

flagger-appmesh-gateway

★ 44 Open GitHub ↗

A Kubernetes API Gateway for AWS App Mesh powered by Envoy

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# flagger-appmesh-gateway
[![build](https://github.com/stefanprodan/flagger-appmesh-gateway/workflows/build/badge.svg)](https://github.com/stefanprodan/flagger-appmesh-gateway/actions)
[![e2e](https://github.com/stefanprodan/flagger-appmesh-gateway/workflows/e2e/badge.svg)](https://github.com/stefanprodan/flagger-appmesh-gateway/actions)
[![report](https://goreportcard.com/badge/github.com/stefanprodan/flagger-appmesh-gateway)](https://goreportcard.com/report/github.com/stefanprodan/flagger-appmesh-gateway)
[![release](https://img.shields.io/github/release/stefanprodan/flagger-appmesh-gateway/all.svg)](https://github.com/stefanprodan/flagger-appmesh-gateway/releases)

Flagger Gateway for AWS App Mesh is an edge L7 load balancer that exposes applications outside the mesh.

**Note** this project has been deprecated in favour of the official [AWS AppMesh Gateway](https://aws.amazon.com/about-aws/whats-new/2020/07/aws-app-mesh-launches-ingress-support-for-virtual-gateways/).

Features:
* allows running canary deployments and A/B testing with [Flagger](https://flagger.app) 
for user-facing web applications and APIs
* allows binding a public or internal domain to a mesh address
* enables App Mesh client load-balancing for AWS NLB, ALB and Amazon API Gateway
* allows setting retries polices and timeouts for each service
* exports metrics in Prometheus format (request rate, error rate and latency)
* provides access logging for ingress traffic
* tags incoming requests and facilitates distributed tracing

The gateway is composed of:
* [Envoy](https://www.envoyproxy.io/) proxy
* Envoy control plane (xDS gRPC server)
* Kubernetes controller (service discovery)

![flagger-appmesh-gateway](https://raw.githubusercontent.com/stefanprodan/flagger-appmesh-gateway/master/docs/appmesh-gateway-diagram.png)

An application running on App Mesh can be exposed outside the mesh by annotating its virtual service with:

```yaml
apiVersion: appmesh.k8s.aws/v1beta1
kind: VirtualService
metadata:
  name: frontend.test
  annotations:
    gateway.appmesh.k8s.aws/expose: "true"
    gateway.appmesh.k8s.aws/retries: "5"
    gateway.appmesh.k8s.aws/timeout: "25s"
    gateway.appmesh.k8s.aws/domain: "example.com,www.example.com"
```

If you want to expose the service inside the Kubernetes cluster you can omit the domain annotation.
By default the gateway exposes a virtual service by its name,
a service can be accessed by setting the host HTTP header e.g.:
```sh
curl -H 'Host: frontend.test' http://<gateway-host>/
```

The gateway registers/de-registers virtual services automatically as they come and go in the cluster.

## 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/flagger-appmesh-gateway//kustomize/nlb
```

To run the gateway behind an ALB you can install the NodePort version:

```sh
kubectl apply -k github.com/stefanprodan/flagger-appmesh-gateway//kustomize/nodeport
```

Wait for the deployment rollout to finish:

```sh
kubectl -n appmesh-gateway rollout status deploy/flagger-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 flagger-appmesh-gateway

Status:
  Conditions:
    Status:                True
    Type:                  VirtualNodeActive
```

## Example

Deploy podinfo in the `test` namespace:

```sh
kubectl -n test apply -k github.com/stefanprodan/flagger-appmesh-gateway//kustomize/test
```

Port forward to the gateway:

```sh
kubectl -n appmesh-gateway port-forward svc/flagger-appmesh-gateway 8080:80
```

Access the podinfo API by setting the host header to `podinfo.test`:

```sh
curl -vH 'Host: podinfo.test' localhost:8080
```

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/flagger-appmesh-gateway -ojson | \
jq -r ".status.loadBalancer.ingress[].hostname")"

curl -vH 'Host: podinfo.internal' $URL
```

## Contributing

App Mesh Gateway is Apache 2.0 licensed and accepts contributions via GitHub pull requests.

flagger-appmesh-gateway

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README