envoyproxy/envoy

Inconsistent naming with clusters.

Open

#37,525 opened on Dec 5, 2024

View on GitHub
 (1 comment) (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

Sometimes, we name our clusters envoy.cluster.xx but other times use envoy.clusters.xx

https://github.com/envoyproxy/envoy/blob/850c7f10cbf5e1132de4eed6b5131d2928ddb95f/source/extensions/extensions_metadata.yaml#L92-L131

https://github.com/envoyproxy/envoy/blob/850c7f10cbf5e1132de4eed6b5131d2928ddb95f/source/extensions/clusters/logical_dns/logical_dns_cluster.h#L90

https://github.com/envoyproxy/envoy/blob/850c7f10cbf5e1132de4eed6b5131d2928ddb95f/source/extensions/clusters/redis/redis_cluster.h#L313

Contributor guide

Research direction
Search the codebase for instances of 'envoy.cluster' and 'envoy.clusters' to identify all inconsistencies, then propose a consistent naming convention (likely singular) and update all occurrences.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
80