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

Revise glossary entry for node #48688

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

Conversation

TransitivityPaul
Copy link

... and to clarify use regarding worker node, which is often used interchangeably with node, and the use of. the term control plane node within the documentation.

Description

Issue

Closes: #

... and to clarify use regarding worker node, which is often used interchangeably with node, and the use of. the term control plane node within the documentation.
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 11, 2024
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Nov 11, 2024
@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 divya-mohan0209 for approval. For more information see the Kubernetes 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 the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 11, 2024
Copy link

netlify bot commented Nov 11, 2024

Pull request preview available for checking

Built without sensitive environment variables

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

@sftim
Copy link
Contributor

sftim commented Nov 11, 2024

/retitle Revise glossary entry for node

@k8s-ci-robot k8s-ci-robot changed the title Update node.md to be consistent with update to cluster... Revise glossary entry for node Nov 11, 2024
@@ -4,17 +4,19 @@ id: node
date: 2018-04-12
full_link: /docs/concepts/architecture/nodes/
short_description: >
A node is a worker machine in Kubernetes.
A node is a machine within a Kubernetes cluster that hosts pods.
Copy link
Contributor

Choose a reason for hiding this comment

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

Keeping it short:

Suggested change
A node is a machine within a Kubernetes cluster that hosts pods.
Machine within a Kubernetes cluster that hosts pods.


<!--more-->

A worker node may be a VM or physical machine, depending on the cluster. It has local daemons or services necessary to run {{< glossary_tooltip text="Pods" term_id="pod" >}} and is managed by the control plane. The daemons on a node include {{< glossary_tooltip text="kubelet" term_id="kubelet" >}}, {{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}}, and a container runtime implementing the {{< glossary_tooltip text="CRI" term_id="cri" >}} such as {{< glossary_tooltip term_id="docker" >}}.
A node may be a VM or physical machine, depending on the cluster. The term *node* is often used as an abbreviation for the term *worker node*, given that most nodes host {{< glossary_tooltip text="workloads" term_id="workload" >}}. However it is possible for nodes to host control plane components within pods, and these nodes may be referred to as control plane nodes. Thus it's possible for a node to be both a worker node and a control plane node, though this is less likely in production environments, as having a machine co-host workloads and control plane components goes against best practices.
Copy link
Contributor

Choose a reason for hiding this comment

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

No; this would be misleading. A node can't be a worker node (defined as doesn't host any control plane components) and at the same time also be a control plane node (defined as runs the kubelet combined with hosts at least some control plane components).

Copy link
Contributor

Choose a reason for hiding this comment

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

The typical way to identify worker nodes is to negatively select on node-role.kubernetes.io/control-plane="true".

In early Kubernetes versions, Nodes were called "Minions".
Each node is managed by the {{< glossary_tooltip text="control plane" term_id="control-plane" >}} and has the local daemons or services necessary to run pods. The daemons on a node include {{< glossary_tooltip text="kubelet" term_id="kubelet" >}}, {{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}}, and a container runtime implementing the {{< glossary_tooltip text="CRI" term_id="cri" >}} such as {{< glossary_tooltip term_id="docker" >}}.

In early Kubernetes versions, worker nodes were called "Minions".
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit / optional tweak)

Suggested change
In early Kubernetes versions, worker nodes were called "Minions".
In early versions of Kubernetes, nodes were called _minions_.

Copy link
Contributor

Choose a reason for hiding this comment

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

The node concept (and Node API) superseded the Minion concept (and Minion API).
Around 9 years ago, kubectl get minions still worked.

@sftim
Copy link
Contributor

sftim commented Dec 12, 2024

@TransitivityPaul would you be willing to move this PR forward?

A maintainer may close it if the PR is still waiting for feedback to be incorporated.

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.

3 participants