Skip to content

feat: Include cluster name in the output#586

Merged
yonahd merged 9 commits intoyonahd:mainfrom
dabico:cluster
Apr 13, 2026
Merged

feat: Include cluster name in the output#586
yonahd merged 9 commits intoyonahd:mainfrom
dabico:cluster

Conversation

@dabico
Copy link
Copy Markdown
Contributor

@dabico dabico commented Mar 22, 2026

What this PR does / why we need it?

Include the cluster name as part of the output. Obtained either through the kubeconfig or overridden through a CLI flag.

PR Checklist

  • This PR adds K8s exceptions (false positives)
  • This PR adds new code
  • This PR includes tests for new/existing code
  • This PR adds docs

GitHub Issue

Closes #579

Notes for your reviewers

Since this information is not propagated to the formatter, the name of the cluster will not be part of reports that are sent to Slack. Planning to add that in a subsequent commit.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 22, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 22.41379% with 45 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.58%. Comparing base (58fc28d) to head (826e0b9).
⚠️ Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
pkg/kor/kor.go 72.22% 2 Missing and 3 partials ⚠️
pkg/utils/banner.go 0.00% 5 Missing ⚠️
cmd/kor/root.go 0.00% 4 Missing ⚠️
pkg/kor/formatter.go 0.00% 4 Missing ⚠️
cmd/kor/all.go 0.00% 1 Missing ⚠️
cmd/kor/clusterrolebindings.go 0.00% 1 Missing ⚠️
cmd/kor/clusterroles.go 0.00% 1 Missing ⚠️
cmd/kor/configmaps.go 0.00% 1 Missing ⚠️
cmd/kor/crds.go 0.00% 1 Missing ⚠️
cmd/kor/daemonsets.go 0.00% 1 Missing ⚠️
... and 21 more
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #586      +/-   ##
==========================================
+ Coverage   46.56%   46.58%   +0.02%     
==========================================
  Files          69       69              
  Lines        3930     3956      +26     
==========================================
+ Hits         1830     1843      +13     
- Misses       1794     1805      +11     
- Partials      306      308       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a cluster identifier to the CLI’s human-readable banner output, sourced from kubeconfig (or overridden via a new CLI flag), to help distinguish runs across multiple clusters.

Changes:

  • Extend banner printing to optionally include a “kor cluster: …” line.
  • Add kubeconfig-derived cluster/context lookup and wire it into command execution.
  • Plumb a new --cluster-name-override option through commands to the banner.

Reviewed changes

Copilot reviewed 31 out of 31 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
pkg/utils/banner.go Adds optional cluster line to version/banner output; updates function signatures to accept cluster string.
pkg/kor/kor.go Introduces isRunningInCluster() and GetClusterName() helper; reuses in-cluster detection in config loading.
pkg/common/params.go Adds ClusterNameOverride to shared CLI options.
cmd/kor/root.go Populates cluster name (if not overridden) and adds --cluster-name-override flag; passes cluster to banner in root command.
cmd/kor/all.go Passes cluster override into banner printing.
cmd/kor/clusterrolebindings.go Passes cluster override into banner printing.
cmd/kor/clusterroles.go Passes cluster override into banner printing.
cmd/kor/configmaps.go Passes cluster override into banner printing.
cmd/kor/crds.go Passes cluster override into banner printing.
cmd/kor/daemonsets.go Passes cluster override into banner printing.
cmd/kor/deployments.go Passes cluster override into banner printing.
cmd/kor/finalizers.go Adds utils import and passes cluster override into banner printing.
cmd/kor/hpas.go Passes cluster override into banner printing.
cmd/kor/ingresses.go Passes cluster override into banner printing.
cmd/kor/jobs.go Passes cluster override into banner printing.
cmd/kor/networkpolicies.go Passes cluster override into banner printing.
cmd/kor/pdbs.go Passes cluster override into banner printing.
cmd/kor/pods.go Passes cluster override into banner printing.
cmd/kor/priorityclasses.go Passes cluster override into banner printing.
cmd/kor/pv.go Passes cluster override into banner printing.
cmd/kor/pvc.go Passes cluster override into banner printing.
cmd/kor/replicasets.go Passes cluster override into banner printing.
cmd/kor/rolebindings.go Passes cluster override into banner printing.
cmd/kor/roles.go Passes cluster override into banner printing.
cmd/kor/secrets.go Passes cluster override into banner printing.
cmd/kor/serviceaccounts.go Passes cluster override into banner printing.
cmd/kor/services.go Passes cluster override into banner printing.
cmd/kor/statefulsets.go Passes cluster override into banner printing.
cmd/kor/storageclasses.go Passes cluster override into banner printing.
cmd/kor/volumeattachments.go Passes cluster override into banner printing.
cmd/kor/version.go Updates version command to use new PrintVersion(string) signature.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pkg/kor/kor.go Outdated
Comment thread cmd/kor/root.go Outdated
Comment thread cmd/kor/root.go Outdated
Comment thread pkg/utils/banner.go
Comment thread pkg/kor/kor.go
@yonahd
Copy link
Copy Markdown
Owner

yonahd commented Apr 6, 2026

Looks good overall a couple small comments that should be cleared before merging

@dabico dabico requested a review from yonahd April 10, 2026 18:59
Copy link
Copy Markdown
Owner

@yonahd yonahd left a comment

Choose a reason for hiding this comment

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

Lgtm

@yonahd yonahd merged commit 1319bd0 into yonahd:main Apr 13, 2026
1 check passed
@SamuelMolling
Copy link
Copy Markdown

SamuelMolling commented Apr 14, 2026

@yonahd When will the new release have this feature?

@yonahd
Copy link
Copy Markdown
Owner

yonahd commented Apr 17, 2026

@yonahd When will the new release have this feature?

Hopefully beginning of next week

@yonahd
Copy link
Copy Markdown
Owner

yonahd commented Apr 23, 2026

@SamuelMolling A new release was created.
Enjoy the new features

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Include cluster name in the output

5 participants