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

Document cluster-info ConfigMap; document cluster CA Certificate renewal #42258

Closed
daddy-joseph97 opened this issue Jul 27, 2023 · 12 comments
Closed
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle.

Comments

@daddy-joseph97
Copy link

I haven't seen anywhere if a tool updates cluster-info. In fact, 'cluster-info' seems magical and undocumented so that after days of failure in adding a non-master worker node I eventually found a kind soul who knew of the problem. Please graciously consider documenting this apparently critical file along with the kubectl join documentation and also including here in the info regarding renewing the cluster CA and other certificates.

@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 27, 2023
@dipesh-rawat
Copy link
Member

Page initially included as part of issue: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/
/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 27, 2023
@dipesh-rawat
Copy link
Member

/retitle Document 'cluster-info' and Cluster CA Certificate renewal

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/ Document 'cluster-info' and Cluster CA Certificate renewal Jul 27, 2023
@neolit123
Copy link
Member

I haven't seen anywhere if a tool updates cluster-info. In fact, 'cluster-info' seems magical and undocumented so that after days of failure in adding a non-master worker node I eventually found a kind soul who knew of the problem. Please graciously consider documenting this apparently critical file along with the kubectl join documentation and also including here in the info regarding renewing the cluster CA and other certificates.

cluster-info is actually not kubeadm specific. same goes for bootstrap tokens.
note that most users don't need to know it exists.
it is not clear what failures you had exactly, but overall i do not object to have more information about cluster-info at k/website.

the configmap is documented here:
https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/

this page has cluster-info CA rotation mentioned:
https://kubernetes.io/docs/tasks/tls/manual-rotation-of-ca-certificates/

this page can include a basic note that kubeadm uses cluster-info for bootstrap with bootstrap tokens.
https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/

similar note can be added here:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/

@neolit123
Copy link
Member

Page initially included as part of issue: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/ /language en

maybe we shouldn't update this page.

@neolit123
Copy link
Member

neolit123 commented Jul 28, 2023

/sig auth cluster-lifecycle

@daddy-joseph97 (or someone else) if you are willing to send a PR, help is appreciated.

@k8s-ci-robot k8s-ci-robot added sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. labels Jul 28, 2023
@Gauravpadam
Copy link
Member

I haven't seen anywhere if a tool updates cluster-info. In fact, 'cluster-info' seems magical and undocumented so that after days of failure in adding a non-master worker node I eventually found a kind soul who knew of the problem. Please graciously consider documenting this apparently critical file along with the kubectl join documentation and also including here in the info regarding renewing the cluster CA and other certificates.

cluster-info is actually not kubeadm specific. same goes for bootstrap tokens. note that most users don't need to know it exists. it is not clear what failures you had exactly, but overall i do not object to have more information about cluster-info at k/website.

the configmap is documented here: https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/

this page has cluster-info CA rotation mentioned: https://kubernetes.io/docs/tasks/tls/manual-rotation-of-ca-certificates/

this page can include a basic note that kubeadm uses cluster-info for bootstrap with bootstrap tokens. https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/

similar note can be added here: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/

Hello,
I'd like to assign this issue to myself , I'll add the note to the links as mentioned above

@Gauravpadam
Copy link
Member

/assign

@sftim
Copy link
Contributor

sftim commented Jul 30, 2023

Issue #30575 covers the process for updating TLS certificates and keys (not yet documented)

We ie, you) could update this issue to describe what to document around cluster-info @daddy-joseph97; would that suit you?

@sftim
Copy link
Contributor

sftim commented Jul 30, 2023

/retitle Document cluster-info ConfigMap; document cluster CA Certificate renewal

@k8s-ci-robot k8s-ci-robot changed the title Document 'cluster-info' and Cluster CA Certificate renewal Document cluster-info ConfigMap; document cluster CA Certificate renewal Jul 30, 2023
@enj enj added this to SIG Auth Oct 16, 2023
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Auth Oct 16, 2023
@stlaz
Copy link
Member

stlaz commented Nov 20, 2023

/close

The configmap appears to be documented in https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/#configmap-signing.
Since the reporter did not reply about what exactly they would like improved, I'm closing this issue.

@k8s-ci-robot
Copy link
Contributor

@stlaz: Closing this issue.

In response to this:

/close

The configmap appears to be documented in https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/#configmap-signing.
Since the reporter did not reply about what exactly they would like improved, I'm closing this issue.

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/test-infra repository.

@github-project-automation github-project-automation bot moved this from Needs Triage to Closed / Done in SIG Auth Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle.
Projects
Archived in project
Development

No branches or pull requests

7 participants