envoyproxy/envoy

Add annotations for certificates listed in /certs

Open

#7,604 opened on Jul 16, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
enhancementhelp wanted

Repository metrics

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

Description

Title: Add annotations for certificates listed in /certs

Description: Per discussion with @PiotrSikora and @incfly on https://github.com/envoyproxy/envoy/issues/7111#issuecomment-499291659, we need to add annotations or something similar into /certs dump to clearly display the type of each certificate, i.e., certificates from static secret, inline secret or SDS. It would be nice if we can add SDS resource name and other information into the annotation, so that we can associate certificates from /certs to SecretConfig(PR https://github.com/envoyproxy/envoy/pull/7365) dump from /config_dump while debugging SDS related issues.

Contributor guide

Research direction
Examine the current /certs endpoint implementation in Envoy, understand the certificate types (static, inline, SDS), and determine where to inject annotations with type and SDS resource name. Look at related PR #7365 for SecretConfig dump format.
Tech stack
c
Domain
backendapi
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.
Clear
Prerequisites
C++Envoy proxy internalsSDS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35