linkerd / linkerd/linkerd2

Sort yaml keys alphabetically in values.yaml inside the Helm chart

Open
#3,418 0 comments 0 reactions 0 assignees View on GitHub
area/install help wanted
Dominant language
Go
Stars
11.5k
Forks
1.4k
Avg merge
3d 22h
Merged PRs (30d)
53

Description

## Feature Request

### What problem are you trying to solve?

Big YAMLs are hard to read. When one needs to add a new value, it's hard to decide in what position it should be added. Also it's hard to compare two files when a lot of keys have been changed in a customization.

### How should the problem be solved?

Setup the new convention and sort all keys alphabetically (root level only).

### Any alternatives you've considered?

Not really, it's a pretty known common solution for YAMLs.

### How would users interact with this feature?

Nothing new for users.

Contributor guide

Open the contributing guide

Research direction

Open the Helm chart's values.yaml and inventory its root-level keys before changing their order. Alphabetize the root-level keys only, then verify that the chart remains valid and that the resulting file establishes the requested convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, infrastructure
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.