Add documents for kuberc by ardaguclu · Pull Request #50913 · kubernetes/website

ardaguclu · 2025-05-15T07:43:55Z

This PR adds documentations for the kuberc (KEP issue: kubernetes/enhancements#3104).

This PR is complementary of this #50961.

ardaguclu · 2025-05-15T07:45:03Z

/cc @soltysh @sftim @liggitt

k8s-ci-robot · 2025-05-15T07:45:07Z

@ardaguclu: GitHub didn't allow me to request PR reviews from the following users: sftim.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

/cc @soltysh @sftim @liggitt

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.

netlify · 2025-05-15T07:53:44Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`d41a8c7`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/683ff0a8024c660008038bf8
😎 Deploy Preview	https://deploy-preview-50913--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

soltysh

Several nits, but mostly lgtm

content/en/docs/reference/config-api/kuberc-config.v1alpha1.md

content/en/docs/reference/kubectl/kuberc.md

lmktfy · 2025-05-16T08:26:22Z

Relevant to kubernetes/enhancements#5300

soltysh

/lgtm
from technical pov, it will be updated to beta at a later stage as part of kubernetes/enhancements#3104 promotion (ref kubernetes/enhancements#5300)

k8s-ci-robot · 2025-05-16T12:15:43Z

LGTM label has been added.

Details

Git tree hash: 35c4172d2b68b19002ebc212338c977303f1e65a

ardaguclu · 2025-05-16T12:37:34Z

/cc @tengqm

lmktfy · 2025-05-18T22:20:40Z

/assign @divya-mohan0209

lmktfy

We could merge this, but I do have corrective feedback to offer.

Aside: once we document writing and using a kubeconfig, we should also document writing and using kuberc.

content/en/docs/reference/config-api/kuberc-config.v1alpha1.md

content/en/docs/reference/kubectl/kuberc.md

lmktfy · 2025-05-18T22:31:41Z

content/en/docs/reference/kubectl/kuberc.md

+## Disable Kuberc
+
+To temporarily disable the kuberc functionality, simply export the environment variable `KUBERC` with the value `off`:
+
+```shell
+export KUBERC=off
+```


Given it's an alpha feature, couldn't you just unset something?

I've mentioned disabling via feature gate as well. Please let me know what you think.

content/en/docs/tasks/tools/install-kubectl-linux.md

content/en/docs/tasks/tools/install-kubectl-macos.md

content/en/docs/tasks/tools/install-kubectl-windows.md

content/en/docs/reference/kubectl/kuberc.md

tengqm · 2025-05-18T23:38:31Z

The config API for kuberc is auto-generated using the genref tool from kubernetes-sigs/reference-docs. Please don't manually create this file.
A related change has been made to the generator, with the update committed in #50961.

soltysh · 2025-05-19T13:13:14Z

Aside: once we document writing and using a kubeconfig, we should also document writing and using kuberc.

Great idea, I wasn't even aware we have that issue.

content/en/docs/reference/config-api/kuberc-config.v1alpha1.md

content/en/docs/reference/kubectl/kuberc.md

ardaguclu · 2025-05-20T06:22:21Z

@tengqm thank you for merging auto-generated api docs.
@lmktfy thank you for your all valuable feedback. I've applied all of them.

ardaguclu · 2025-05-21T12:23:28Z

So the expectation is we'll merge this before kubernetes/kubernetes#131818. Once kubernetes/kubernetes#131818 merges, we'll update the documents accordingly?

lmktfy · 2025-05-21T12:40:11Z

So the expectation is we'll merge this before kubernetes/kubernetes#131818. Once kubernetes/kubernetes#131818 merges, we'll update the documents accordingly?

This PR should document what's already in released Kubernetes (as alpha).

We'll need a new, separate update PR ahead of cutting a release that includes the changes from kubernetes/kubernetes#131818

soltysh · 2025-05-21T13:31:01Z

We'll need a new, separate update PR ahead of cutting a release that includes the changes from kubernetes/kubernetes#131818

Correct, the beta updates will be part of 1.34, and as usual the changes in the linked PR will be submitted there.

ardaguclu · 2025-05-22T09:55:58Z

@lmktfy is there any pending action from me?. I'm wondering maybe we can merge this PR.

lmktfy

/lgtm

I'd like to see more fixes, but this looks OK to merge as-is.

content/en/docs/reference/kubectl/kuberc.md

k8s-ci-robot · 2025-06-01T21:53:09Z

LGTM label has been added.

Details

Git tree hash: c01b3842fb5743e404b1b458a74e702e494d04c8

ardaguclu · 2025-06-02T04:03:21Z

@lmktfy should I apply your changes or ping someone for approval?

soltysh · 2025-06-03T17:38:59Z

@lmktfy should I apply your changes or ping someone for approval?

let's get the suggested fixes applied right away, otherwise we'll loose track of them

lmktfy · 2025-06-03T17:42:51Z

An approver is welcome to merge this and then open one or more good-first-issue issues

(we can always use a supply of these, and k/website likes to have very low difficulty first issues).

Applying fixes? Also fine.

ardaguclu · 2025-06-03T18:00:52Z

An approver is welcome to merge this and then open one or more good-first-issue issues

(we can always use a supply of these, and k/website likes to have very low difficulty first issues).

Applying fixes? Also fine.

I can apply the changes tomorrow.@lmktfy as far as I can see, you are also the approver?

lmktfy · 2025-06-03T18:33:30Z

@lmktfy as far as I can see, you are also the approver?

Divya is nominated approver for this PR
we haven't taught this convention to Prow, but for changes that will publish to the live docs, we get approval and LGTM from separate reviews.

ardaguclu · 2025-06-04T07:07:50Z

I've updated the PR based on the review.

lmktfy

/LGTM

If we merge this, the docs will be better than if we did not.

lmktfy · 2025-06-08T13:40:51Z

content/en/docs/reference/kubectl/kuberc.md

+	compiled-in default value.
+	{{< /note >}}
+
+#### Example:


nit: we don't end headings with punctuation.
Try this

Suggested change

#### Example:

#### Example {#overrides-example}

lmktfy · 2025-06-08T13:41:01Z

content/en/docs/reference/kubectl/kuberc.md

+Within a `kuberc`, configuration, command line arguments are termed _flags_ (even if they do not represent a boolean type).
+You can use `flags` to set the default value of a command line argument.
+
+	If you explicitly specify a flag on your terminal, explicit value will always take precedence over the value you defined in kuberc using `overrides`.


Why indent this? That doesn't look right.

This indentation also causes a slight rendering issue with the page content, but aside from that, the overall changes look good to me!

Preview Link (here)

k8s-ci-robot · 2025-06-08T13:42:36Z

LGTM label has been added.

Details

Git tree hash: 1fd1cbcf38c9a82d2bb44cadae1fa8d7f538d1cd

katcosgrove · 2025-06-08T21:22:16Z

/approve

k8s-ci-robot · 2025-06-08T21:22:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: katcosgrove, soltysh

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~content/en/docs/OWNERS~~ [katcosgrove]

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 added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 15, 2025

ardaguclu mentioned this pull request May 15, 2025

KEP-3104: promote kuberc to beta kubernetes/enhancements#5300

Merged

k8s-ci-robot requested a review from mikedanese May 15, 2025 07:44

k8s-ci-robot added the language/en Issues or PRs related to English language label May 15, 2025

k8s-ci-robot requested a review from Princesso May 15, 2025 07:44

k8s-ci-robot requested review from liggitt and soltysh May 15, 2025 07:45

ardaguclu mentioned this pull request May 15, 2025

Separate kubectl user preferences from cluster configs kubernetes/enhancements#3104

Open

16 tasks

soltysh reviewed May 15, 2025

View reviewed changes

soltysh approved these changes May 16, 2025

View reviewed changes

k8s-ci-robot assigned soltysh May 16, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2025

k8s-ci-robot requested a review from tengqm May 16, 2025 12:37

k8s-ci-robot assigned divya-mohan0209 May 18, 2025

lmktfy reviewed May 18, 2025

View reviewed changes

content/en/docs/reference/kubectl/kuberc.md Outdated Show resolved Hide resolved

lmktfy reviewed May 18, 2025

View reviewed changes

content/en/docs/reference/kubectl/kuberc.md Show resolved Hide resolved

lmktfy mentioned this pull request May 19, 2025

Add a task page for setting up kubeconfig #38681

Open

lmktfy reviewed May 19, 2025

View reviewed changes

content/en/docs/reference/config-api/kuberc-config.v1alpha1.md Show resolved Hide resolved

lmktfy reviewed May 19, 2025

View reviewed changes

content/en/docs/reference/kubectl/kuberc.md Outdated Show resolved Hide resolved

k8s-ci-robot requested review from divya-mohan0209 and soltysh May 20, 2025 06:18

ardaguclu changed the title ~~Add documents for Kuberc~~ Add documents for kuberc May 20, 2025

soltysh mentioned this pull request May 20, 2025

Add a task page for setting up kuberc #50988

Open

lmktfy reviewed Jun 1, 2025

View reviewed changes

k8s-ci-robot assigned lmktfy Jun 1, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 1, 2025

Apply more suggested changes

d41a8c7

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 4, 2025

k8s-ci-robot requested a review from lmktfy June 4, 2025 07:07

lmktfy reviewed Jun 8, 2025

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 8, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 8, 2025

k8s-ci-robot merged commit ee05e9e into kubernetes:main Jun 8, 2025
6 checks passed

ardaguclu deleted the kuberc-docs branch June 9, 2025 05:07

Conversation

ardaguclu commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ardaguclu commented May 15, 2025

Uh oh!

k8s-ci-robot commented May 15, 2025

Uh oh!

netlify bot commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

soltysh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lmktfy commented May 16, 2025

Uh oh!

soltysh left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented May 16, 2025

Uh oh!

ardaguclu commented May 16, 2025

Uh oh!

lmktfy commented May 18, 2025

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lmktfy May 18, 2025

Choose a reason for hiding this comment

Uh oh!

ardaguclu May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tengqm commented May 18, 2025

Uh oh!

soltysh commented May 19, 2025

Uh oh!

Uh oh!

Uh oh!

ardaguclu commented May 20, 2025

Uh oh!

ardaguclu commented May 21, 2025

Uh oh!

lmktfy commented May 21, 2025

Uh oh!

soltysh commented May 21, 2025

Uh oh!

ardaguclu commented May 22, 2025

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k8s-ci-robot commented Jun 1, 2025

Uh oh!

ardaguclu commented Jun 2, 2025

Uh oh!

soltysh commented Jun 3, 2025

Uh oh!

lmktfy commented Jun 3, 2025

ardaguclu commented May 15, 2025 •

edited

Loading

netlify bot commented May 15, 2025 •

edited

Loading