[KEP-3104] Kuberc beta #51351
Open
[KEP-3104] Kuberc beta #51351
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Maciej Szulik <soltysh@gmail.com>
Signed-off-by: Maciej Szulik <soltysh@gmail.com>
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
|
[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
k8s-ci-robot
added
sig/docs
8 tasks
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: e21e1f494afc538904a4497edafc7c914d93f0bb
|
lmktfy
reviewed
Jul 1, 2025
| @@ -89,7 +90,7 @@ operator to use or manage a cluster. | |||
| * [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/) | |||
| * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) | |||
| * [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/) | |||
| * [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) and | |||
| * [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) and | |||
There was a problem hiding this comment.
nit: Avoid changing this line
lmktfy
reviewed
Jul 1, 2025
| ## Disable kuberc | ||
|
|
||
| To temporarily disable the kuberc functionality, simply export the environment variable `KUBERC` with the value `off`: | ||
| To temporarily disable the kuberc functionality, simply export the environment |
There was a problem hiding this comment.
Suggested change
| To temporarily disable the kuberc functionality, simply export the environment | |
| To temporarily disable the kuberc functionality, set (and export) the environment |
lmktfy
reviewed
Jul 1, 2025
| ## Disable kuberc | ||
|
|
||
| To temporarily disable the kuberc functionality, simply export the environment variable `KUBERC` with the value `off`: | ||
| To temporarily disable the kuberc functionality, simply export the environment | ||
| variable `KUBERC` with the value `off`: | ||
|
|
||
| ```shell | ||
| export KUBERC=off |
There was a problem hiding this comment.
Does this assume that the path off is invalid?
lmktfy
reviewed
Jul 1, 2025
| compiled-in default value. | ||
| {{< /note >}} | ||
|
|
||
| #### Example |
lmktfy
reviewed
Jul 1, 2025
|
|
||
| Append arbitrary arguments to the end of the kubectl command. | ||
|
|
||
| #### Example {#appendArgs-example} |
lmktfy
reviewed
Jul 1, 2025
lmktfy
reviewed
Jul 1, 2025
|
|
||
| Alias name must not collide with the built-in commands. | ||
| Within a `kuberc` configuration, _aliases_ section allows you to define custom |
There was a problem hiding this comment.
Suggested change
| Within a `kuberc` configuration, _aliases_ section allows you to define custom | |
| Within a `kuberc` configuration, the _aliases_ section allows you to define custom |
|
|
||
| ## aliases | ||
| Currently, this file allows you to define two types of user preferences: |
There was a problem hiding this comment.
Suggested change
| Currently, this file allows you to define two types of user preferences: | |
| A kuberc using the v1beta1 format allows you to define two types of user preferences: |
|
|
||
| ### name | ||
| ## Aliases |
There was a problem hiding this comment.
Suggested change
| ## Aliases | |
| ## aliases |
|
|
||
| ### command | ||
| ## Defaults |
There was a problem hiding this comment.
Suggested change
| ## Defaults | |
| ## defaults |
| This includes support for subcommands like `create role`. | ||
| 1. `options` - Specify default values for options. If you explicitly specify an option | ||
| when you run `kubectl`, the value you provide takes precedence over the default | ||
| one defined in `kuberc`. | ||
|
|
| - command: delete | ||
| flags: | ||
| options: | ||
| - name: interactive | ||
| default: "true" |
There was a problem hiding this comment.
Optionally, use a comment to explain why the value is quoted.
|
|
||
| #### Example | ||
| This next example makes the interactive removal the default mode for invoking | ||
| `kubectl delete` command: |
There was a problem hiding this comment.
Suggested change
| `kubectl delete` command: | |
| `kubectl delete`: |
|
|
||
| A Kubernetes `kuberc` configuration file allows you to define preferences for kubectl, such as default options and command aliases. | ||
| Unlike the kubeconfig file, a `kuberc` configuration file does **not** contain cluster details, usernames or passwords. | ||
| A Kubernetes `kuberc` configuration file allows you to define preferences for kubectl, |
There was a problem hiding this comment.
Even better: make kubectl a hyperlink or a glossary tooltip.
|
|
||
| #### Example {#flags-example} | ||
| This next example defines `kubectl getn` alias for `kubectl get` command, additionally | ||
| setting output flag `--output=json`. |
There was a problem hiding this comment.
Suggested change
| setting output flag `--output=json`. | |
| specifying JSON output format: `--output=json`. |
| If you explicitly specify a command line argument when you run kubectl, the value you provide takes precedence over the default one defined in kuberc. | ||
|
|
||
| #### Example {#flags-example} | ||
| This next example defines `kubectl getn` alias for `kubectl get` command, additionally |
There was a problem hiding this comment.
Suggested change
| This next example defines `kubectl getn` alias for `kubectl get` command, additionally | |
| This next example defines a `kubectl getn` alias for the `kubectl get` subcommand, additionally |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Promote kuberc to beta
Issue
KEP: kubernetes/enhancements#3104
/assign @ardaguclu
for sig-cli review
The generated changes are coming from kubernetes-sigs/reference-docs#396