Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for loopback certificates in kube-apiserver #49518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

HirazawaUi
Copy link
Contributor

Description

The loopback certificate is an internal certificate that always exists within the kube-apiserver. Its expiration can cause the kube-apiserver to malfunction. However, there is currently no documentation detailing the risks associated with its expiration or how to troubleshoot related issues.

Issue

Closes: #46407

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign tengqm for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 21, 2025
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 21, 2025
@HirazawaUi
Copy link
Contributor Author

/cc @liggitt

@k8s-ci-robot k8s-ci-robot requested a review from liggitt January 21, 2025 11:22
Copy link

netlify bot commented Jan 21, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 7062e6c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/678f8338d8769e00084957a4
😎 Deploy Preview https://deploy-preview-49518--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Comment on lines +66 to +78
### Loopback Certificate in kube-apiserver

The loopback certificate is used by the kube-apiserver to establish privileged loopback connections.
This certificate is stored in memory and has a validity period of one year.
However, it does not renew automatically. If the certificate expires, the kube-apiserver will cease to function.

The kube-apiserver is supported by the Kubernetes community for one year,
aligning with the validity of the loopback certificate. This means that to maintain community support,
you should upgrade the kube-apiserver within one year. The loopback certificate is automatically renewed during the kube-apiserver upgrade process.

{{< note >}}
Restarting the kube-apiserver is another way to renew the loopback certificate.
{{< /note >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is the wrong place to describe this certificate; please move it within the Server certificates section earlier in the page.

to maintain community support, you should upgrade the kube-apiserver within one year

This is not factually correct; we sometimes provide slightly more than 1 year of formal support.

Recommending an API server restart at least once a year makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add apiserver LoopbackClient server certificate validity period documention
3 participants