Update quick-reference.md: add reusable kubectl aliases for on-call and restricted Kubernetes environments #51497
Conversation
…nd restricted Kubernetes environments
k8s-ci-robot
added
the
cncf-cla: yes
|
Welcome @jvoravong! |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
k8s-ci-robot
added
language/en
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Thanks, but I disagree with merging this.
The aliases you suggest are a handy set but they are also quite opinionated, and different people might have their own opinions about what works best.
The explanatory paragraphs also aren't right for a quick reference.
I notice for example you use kubectl get events not kubectl events; another place where there might be contention is which container image registry to use for krun.
We also can't assume
Consider proposing a blog article with b these suggestions instead.
|
Thanks for the feedback, totally fair. I often work in environments where only the Kubernetes.io docs are accessible, so a few more aliases somewhere in the official docs would really help in time-sensitive or restricted situations. I’ll get a change out with a smaller set focused on the least opinionated ones and see if that looks more feasible. |
|
We might consider a change different page, but I don't think we would. The quick reference page is arguably already quite long. A careful bit of curation is, I think, more valuable. |
|
Thought on this for a bit, @lmktfy's feedback was useful. So I'm going to try out these other approaches.
Closing this PR in favor of these other approaches. |
This pull request adds a new subsection to the kubectl quick reference guide:
"Aliases for Quick Response in Unknown Kubernetes Environments."
The goal is to provide a lightweight, reusable set of kubectl aliases for users operating in constrained, time-sensitive, or unfamiliar Kubernetes environments—such as during on-call incidents, ephemeral environments, or across diverse multicloud production setups (e.g., EKS, GKE, AKS, OpenShift).
This is my first time contributing to the Kubernetes documentation project. I've seen a recurring need for this kind of alias utility over time, and I’ve personally found it useful across environments with limited tooling or locked-down access to anything beyond the official Kubernetes resources.
If others find this helpful, I’d love to see it included as part of the quick-reference section. Let me know if anything is missing—happy to make adjustments.