Skip to content

kubectl: sort configmap data alphabetically and simplify display format #131500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

kubectl: sort configmap data alphabetically and simplify display format #131500

wants to merge 2 commits into from
+26 −6

Conversation

HaraldNordgren
Copy link
Contributor

@HaraldNordgren HaraldNordgren commented Apr 27, 2025 •
edited
Loading

What type of PR is this?

/kind bug

What this PR does / why we need it:

Fixed 'describe configmap' so data keys are outputted in a predictable (alphabetical) order.

kubectl describe configmap gives a random order of data keys. This it annoying especially when using it through k9s.

Also simplifies the display format, inspired by how env vars are shown for a pod (see https://github.com/kubernetes/kubernetes/blob/v1.33.0/staging/src/k8s.io/kubectl/pkg/describe/describe.go#L2015).

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1738

Special notes for your reviewer:

Follow-up to #130309.

Does this PR introduce a user-facing change?

Changed: Configmap data keys sorted alphabetically, and key and value placed the same line (similar to pod environment variables.)

No user action should be required since it only alters the display format.

Affects `kubectl describe configmap`.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 27, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

Hi @HaraldNordgren. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Apr 27, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG CLI Apr 27, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: HaraldNordgren
Once this PR has been reviewed and has the lgtm label, please assign brianpursley for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from seans3 and soltysh April 27, 2025 13:39
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Apr 27, 2025
@HaraldNordgren HaraldNordgren marked this pull request as ready for review April 27, 2025 13:47
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 27, 2025
@k8s-ci-robot k8s-ci-robot requested a review from ardaguclu April 27, 2025 13:47
@HaraldNordgren
Copy link
Contributor Author

Ping @rikatz, thanks for the good idea!

@HaraldNordgren HaraldNordgren mentioned this pull request Apr 27, 2025
Merged
@HaraldNordgren HaraldNordgren changed the title kubectl: sort configmaps alphabetically to avoid random order kubectl: sort configmap data alphabetically to avoid random order Apr 27, 2025
@HaraldNordgren
Copy link
Contributor Author

HaraldNordgren commented Apr 27, 2025 •
edited
Loading

Ping @ardaguclu @googs1025

@HaraldNordgren HaraldNordgren changed the title kubectl: sort configmap data alphabetically to avoid random order kubectl: sort configmap data alphabetically and improve display format Apr 27, 2025
@HaraldNordgren HaraldNordgren changed the title kubectl: sort configmap data alphabetically and improve display format kubectl: sort configmap data alphabetically and simplify display format Apr 27, 2025
googs1025
googs1025 reviewed Apr 28, 2025
View reviewed changes
staging/src/k8s.io/kubectl/pkg/describe/describe.go
w.Write(LEVEL_0, "%s:\n----\n", k)
w.Write(LEVEL_0, "%s\n", string(v))
w.Write(LEVEL_0, "\n")
for _, k := range slices.Sorted(maps.Keys(configMap.Data)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this change involve changes in the way users use it?
If so, can we modify this? The same for the previous PR 😄
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@googs1025 Updated, let me know if it looks ok!

@googs1025
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note-none Denotes a PR that doesn't merit a release note. labels Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@googs1025 googs1025 googs1025 left review comments

@seans3 seans3 Awaiting requested review from seans3

@soltysh soltysh Awaiting requested review from soltysh

@ardaguclu ardaguclu Awaiting requested review from ardaguclu

Assignees
No one assigned
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
SIG CLI
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Configmap data is outputted in random order
3 participants
@HaraldNordgren @k8s-ci-robot @googs1025