envoyproxy/envoy

add listener message validation based on semantic

Open

#15,372 opened on Mar 8, 2021

View on GitHub
 (8 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/configurationarea/listenerhelp wanted

Repository metrics

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

Description

We have tcp listener, udp listener, api listener in the same Listener message , and I am adding another internal listener.

These listeners have their own feature set. e.g. connection_balance_config should not be used by udp listener, filter_chains should only be used by tcp listener (and quic ?), not all sock options are for udp, vice versa.

We don't have adequate validation for the above implicit rules for now.

It's probably good to warn the user upon receiving listener config, starting from "some fields are contradicting or ignored" and eventually reject inconsistent config.

WDYT?

Contributor guide

Research direction
Investigate the existing listener validation logic in Envoy's config manager, focusing on protobuf validation annotations and custom validation in the listener manager. Determine how to add semantic checks for different listener types (tcp, udp, api, internal) to warn or reject invalid config.
Tech stack
cpp
Domain
backendnetworkingapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
C++ProtobufEnvoy proxy concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45