ysawa0 / envoylint

envoylint.com takes an Envoy config and validates it for you.

envoylint

envoylint.com takes an Envoy config and validates it for you.

Frontend

The frontend is a static React site deployed via Netlify. Netlify is synced to this repo.

The site calls the Lamba backend to do the config validation.

Run locally:

cd frontend
yarn install
yarn start

Backend

Deployed via Serverless Framework to AWS Lambda.

Each Lambda calls an Envoy binary in validate mode to check a config. The binary is stored in a Lambda Layer.

There is a Lambda Layer for each Envoy version.

Deploy to AWS

cd backend
npm install -g serverless
sls plugin install -n serverless-python-requirements
sls deploy --stage dev

How to get Envoy binary for Lambda Layer

docker run envoyproxy/envoy:v1.17.1
docker cp $(docker ps -q):/usr/local/bin/envoy .
# Convinence script can be used to the same effect:
# sh get_envoy_binary.sh 1.17.1

How to build config_load_check_tool for Lambda

Spin up a EC2 instance using Amazon Linux (t3a.xlarge or larger recommended for manageable build time and enough memory)

Then run

sudo yum update -y; sudo yum install git tmux -y; git clone https://github.com/envoyproxy/envoy.git
sudo amazon-linux-extras install docker -y; sudo service docker start; sudo usermod -a -G docker ec2-user
sudo yum groupinstall "Development Tools" -y

# Log out then log back in to apply usermod

cd envoy; tmux new; ./ci/run_envoy_docker.sh 'tail -f /dev/null'

# Docker exec into CI container then run
git clone https://github.com/envoyproxy/envoy.git; cd envoy
bazel build //test/tools/config_load_check:config_load_check_tool

envoylint's Issues

Use envoy-contrib image

Feature request from a user:

One feature suggestion: since Envoy 1.20 the project now releases envoy-contrib images, which have a different set of extensions enabled. It would be great if the tool could validate also envoy-contrib configuration. It might even be a one-line fix if you don’t want separate validation for contrib and non-contrib images: just replace envoy image with envoy-contrib image, because envoy image is a subset of envoy-contrib image.