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

kubeadm: add 1.32 documentation #48408

Merged
merged 2 commits into from
Dec 10, 2024

Conversation

neolit123
Copy link
Member

@neolit123 neolit123 commented Oct 17, 2024

feature gates:

  • move PublicKeysECDSA to deprecated (this was done in 1.31)
  • add NodeLocalCRISocket as alpha for 1.32

update CLI docs

add nodes about new cert features.

revamp implementation details.

@k8s-ci-robot k8s-ci-robot added this to the 1.32 milestone Oct 17, 2024
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Oct 17, 2024
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 17, 2024
Copy link

netlify bot commented Oct 17, 2024

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit bbdb8dd
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/674837954860940008a8ed0f

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 17, 2024
@neolit123
Copy link
Member Author

/sig cluster-lifecycle
/kind feature cleanup

@k8s-ci-robot k8s-ci-robot added sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. kind/feature Categorizes issue or PR as related to a new feature. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Oct 17, 2024
Copy link

netlify bot commented Oct 17, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit bbdb8dd
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6748379587c642000877d025
😎 Deploy Preview https://deploy-preview-48408--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.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 6, 2024
@neolit123 neolit123 changed the title kubeadm: add 1.32 documentation WIP: kubeadm: add 1.32 documentation Nov 6, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 6, 2024
@neolit123 neolit123 force-pushed the 1.32-kubeadm-docs branch 2 times, most recently from 067a100 to 748be86 Compare November 6, 2024 12:48
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 6, 2024
title: kubeadm upgrade phase
weight: 90
title: kubeadm upgrade phases
weight: 40
Copy link
Member Author

Choose a reason for hiding this comment

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

making this appear after the kubeadm upgrade page in the list

@neolit123 neolit123 force-pushed the 1.32-kubeadm-docs branch 2 times, most recently from 0e04af3 to 6ba0b84 Compare November 6, 2024 13:16
@neolit123 neolit123 changed the title WIP: kubeadm: add 1.32 documentation kubeadm: add 1.32 documentation Nov 6, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 6, 2024
@neolit123
Copy link
Member Author

/remove-label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot removed the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Nov 11, 2024
@neolit123
Copy link
Member Author

@neolit123 I noticed that this PR comprises both manually created contents and generated contents. Can/shall we separate them into two PRs?

i split this PR in two commits:

  • generated ref docs
  • authored content updates

and removed the squash label.

Comment on lines +12 to +21
{{< tabs name="tab-phase" >}}
{{< tab name="phase" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase.md" />}}
{{< tab name="preflight" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_preflight.md" />}}
{{< tab name="control-plane" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_control-plane.md" />}}
{{< tab name="upload-config" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_upload-config.md" />}}
{{< tab name="kubelet-config" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_kubelet-config.md" />}}
{{< tab name="bootstrap-token" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_bootstrap-token.md" />}}
{{< tab name="addon" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_addon.md" />}}
{{< tab name="post-upgrade" include="generated/kubeadm_upgrade/kubeadm_upgrade_apply_phase_post-upgrade.md" />}}
{{< /tabs >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think tabs are the best option here.

Copy link
Member Author

@neolit123 neolit123 Nov 11, 2024

Choose a reason for hiding this comment

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

maybe yes, but the existing approach is to add phases as tabs. changing that seems out of scope for this PR.

we had discussions about these generated kubeadm docs in the past.
ideally the generator should generate hyper links between the various generated pages and create a tree structure.
then these authored pages would not need to import generated pages in tabs and can just link to a top generated page from the tree.

i don't have time to work on something like that, so maybe you or someone else from SIG Docs can submit this as a GSoC or LFX project and a student can pick it up.


{{< tabs name="tab-phase" >}}
{{< tab name="phase" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase.md" />}}
{{< tab name="preflight" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase_preflight.md" />}}
{{< tab name="control-plane" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase_control-plane.md" />}}
{{< tab name="kubelet-config" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase_kubelet-config.md" />}}
{{< tab name="addon" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase_addon.md" />}}
{{< tab name="post-upgrade" include="generated/kubeadm_upgrade/kubeadm_upgrade_node_phase_post-upgrade.md" />}}
{{< /tabs >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Here too.
These phases are not mutual exclusive IIUC.

@SataQiu
Copy link
Member

SataQiu commented Nov 11, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 11, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7a6ec91de9bba7be8e53bd7450044c54b5c7df2a

`kubeadm.alpha.kubernetes.io/cri-socket` on the Node object. The new file is applied as an instance
configuration patch, before any other user managed patches are applied when the `--patches` flag
is used. It contains a single field `containerRuntimeEndpoint` from the
[KubeletConfiguration file format](/docs/reference/config-api/kubelet-config.v1beta1/).
Copy link
Member

Choose a reason for hiding this comment

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

For upgrade, we will read from kubeadm-flags.env if instance-config.yam does not exist.

Should we mention it?

Copy link
Member Author

@neolit123 neolit123 Nov 28, 2024

Choose a reason for hiding this comment

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

adding:

If the feature gate is enabled during upgrade, but the file /var/lib/kubelet/instance-config.yaml does not exist yet, kubeadm will attempt to read the CRI socket value from the file /var/lib/kubelet/kubeadm-flags.env.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2024
@k8s-ci-robot k8s-ci-robot requested a review from SataQiu November 28, 2024 09:18
@neolit123 neolit123 requested a review from pacoxu November 28, 2024 09:26
Copy link
Member

@pacoxu pacoxu left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8fc72776cc3e03cdeb22bdc21f09141cb923156f

@reylejano
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pacoxu, reylejano, SataQiu

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

The pull request process is described 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit 426f5e2 into kubernetes:dev-1.32 Dec 10, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants