envoyproxy/envoy

Clarify configuration validation tests and tools

Open

#15,377 opened on Mar 9, 2021

View on GitHub
 (8 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/configurationarea/docshelp wantedtech debt

Repository metrics

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

Description

description

there is more than one path to validation of envoy config:

  • starting daemon in "validate" mode
  • (python) protobuf validation

what these type of validation actually do, how best to validate, and what each tool validates is an ongoing source of confusion.

at very least we need to improve docs around dev/ci, and perhaps also clarify in main docs for end users

Contributor guide

Research direction
Review the existing documentation for configuration validation methods in Envoy (validate mode and Python protobuf validation) and identify gaps or inconsistencies. Propose documentation improvements or additional testing tools to clarify the differences and use cases.
Tech stack
cpp
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
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70