envoyproxy/envoy

Minimal gRPC service-to-service config example with health checking

Open

#865 opened on Apr 30, 2017

View on GitHub
 (16 comments) (11 reactions) (2 assignees)C++ (5,373 forks)batch import
area/docsbeginnerhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Envoy is impressive, and its documentation is far-reaching, but the wealth of configuration options means its difficult to know if you're setting things up right. In my case, all I want is automatic health-check driven connection draining to ensure zero-downtime deploys. Yet after setting up an SDS server, health check listeners, retry policies, and more I still see requests being forwarded to Envoy servers that are returning 503's.

Has anyone put together a minimal configuration example that provides what I'm looking for? I know that gRPC is a bit of a special case but I suspect many folks would love something simple to start with, as opposed to the extremely complex configs on the documentation website.

I should note that I'm running Envoy on both the client and server.

Contributor guide

Research direction
Study Envoy health check filter configuration in the documentation and create a minimal example for gRPC service to service communication with health checking.
Tech stack
grpccpp
Domain
backendnetworking
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
EnvoygRPCYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65