feat: Include cluster name in the output#586
Conversation
|
Codecov Report❌ Patch coverage is
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. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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-overrideoption 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.
|
Looks good overall a couple small comments that should be cleared before merging |
|
@yonahd When will the new release have this feature? |
Hopefully beginning of next week |
|
@SamuelMolling A new release was created. |
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
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.