envoyproxy/envoy

[Feature] Support Client Status Discovery Service (CSDS)

Open

#13,181 opened on Sep 18, 2020

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

Repository metrics

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

Description

Title: [Feature] Support Client Status Discovery Service (CSDS)

Description:

Client Status Discovery Service (CSDS) is a service that exposes xDS config of a given client. It’s commonly used to query control planes for the synced xDS config of a particular sidecar proxy. However, it can also be used to query Envoy for its received xDS configuration.

As a xDS client, Envoy can dump xDS config and expose internal status of each xDS resource (https://github.com/envoyproxy/envoy/pull/13121). The xDS config dump will share the same proto definition as admin interface. It will be an alternative way of getting config dump. As for internal status, it describes if the Envoy accepts or rejects or is pending on a specific xDS resource.

Relevant Links:

CC @htuch for more potential benefits.

Contributor guide

Research direction
Study the CSDS proto definition and understand Envoy's existing config dump mechanism. Identify how to expose client xDS config and status via a gRPC service. Start by examining the admin endpoint for config dump and the internal xDS subscription state.
Tech stack
cppgrpc
Domain
backendapinetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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++ProtobufgRPCEnvoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25