envoyproxy/envoy

Config validation without secret validation

Open

#9,809 opened on Jan 23, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/configurationhelp wanted

Repository metrics

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

Description

Currently when running Envoy with --mode validate it will attempt to load and validate the contents of the secrets referenced by the config. While this might be useful when the config is validated in the context in which Envoy will ultimately run, it makes setting up config validation as part of a CI pipeline tricky due to having to generate various test secrets.

A mode that validates that the config is correct (i.e. passes pgv validation) without relying on the state of the file system would simply this process and make it possible to do lightweight config validations.

I imagine this would require stubbing out a lot of the TLS classes that are used during validation for ones that won't actually try to read any of the file content.

Contributor guide

Research direction
Investigate how Envoy's config validation currently loads secrets, particularly the TLS certificate reading code. Identify the classes that need to be stubbed for a file system independent validation mode.
Tech stack
cpp
Domain
backendinfrastructure
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.
Over 1 week
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
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30