envoyproxy/envoy

Make envoyproxy/envoy the source-of-truth for envoy-filter-example

Open

#5,054 opened on Nov 15, 2018

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

Repository metrics

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

Description

As discussed in https://github.com/envoyproxy/envoy/pull/5031#issuecomment-438757841, we have a multiple commit dance needed for changes that break the filter API today, where both envoyproxy/envoy and envoyproxy/envoy-filter-example need multiple commits. One way to avoid this would be:

  1. We move envoy-filter-example into the main Envoy repo, using a local repository in the WORKSPACE to point the example at Envoy source.
  2. We export to envoy-filter-example as a read-only mirror (like data-plane-api), and swizzle the WORKSPACE to one that uses a remote repository.

This preserves envoy-filter-example as a standalone example of integrating Envoy, while avoiding the multi-phase commit dance (and breakages) we hit regularly these days.

Contributor guide

Research direction
Examine the Envoy WORKSPACE file and Bazel build system to understand how to add a local repository. Study the envoy filter example repository structure and its dependencies. Investigate the concept of read only mirrors used for data plane api and apply similar technique.
Tech stack
cpp
Domain
backendbuild systemdeveloper experience
Issue type
Refactor
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.
Half day
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
GitBazel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30