docs/reference: Add configuration links for node status update interv… #52621
Conversation
k8s-ci-robot
added
the
do-not-merge/invalid-commit-message
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
|
/sig docs |
k8s-ci-robot
added
the
sig/docs
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
95124b6 to
72602e1
Compare
k8s-ci-robot
removed
the
do-not-merge/invalid-commit-message
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
72602e1 to
4301ed2
Compare
k8s-ci-robot
added
the
do-not-merge/invalid-commit-message
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
2 times, most recently
from
918e2a6 to
72602e1
Compare
k8s-ci-robot
removed
the
do-not-merge/invalid-commit-message
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| ## Addresses | ||
|
|
||
| Addresses |
There was a problem hiding this comment.
Why this change? I don't understand it.
| The `conditions` field describes the status of all `Running` nodes. Examples of conditions include: | ||
| InternalIP: Typically the IP address of the node that is routable only within the cluster. | ||
| Conditions {#condition} |
There was a problem hiding this comment.
Why this change from heading text? I don't understand it.
| of the Node resource. For example, the following JSON structure describes a healthy node: | ||
|
|
||
| ```json | ||
| JSON |
|
|
||
| ## Capacity and Allocatable {#capacity} | ||
|
|
||
| Capacity and Allocatable {#capacity} |
There was a problem hiding this comment.
Why this change from heading text? I don't understand it.
|
|
||
| ## Info | ||
|
|
||
| Info |
There was a problem hiding this comment.
Why this change from heading text? I don't understand it.
|
|
||
| ## Heartbeats | ||
|
|
||
| Heartbeats |
There was a problem hiding this comment.
Why this change from heading text? I don't understand it.
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
72602e1 to
6cdbad0
Compare
k8s-ci-robot
added
size/M
| kubectl describe node <insert-node-name-here> | ||
| ``` | ||
|
|
||
| text |
| "type": "Ready", | ||
| "status": "True", | ||
| "reason": "KubeletReady", | ||
| "message": "kubelet is posting ready status", | ||
| "lastHeartbeatTime": "2019-06-05T18:38:35Z", | ||
| "lastTransitionTime": "2019-06-05T11:41:27Z" |
There was a problem hiding this comment.
better indent these line by 2 spaces
| ] | ||
| ``` | ||
|
|
||
| text |
| for `.status` updates to Nodes is 5 minutes, which is much longer than the 40 | ||
| second default timeout for unreachable nodes. | ||
| second default timeout for unreachable nodes. The update interval is controlled by the | ||
| `nodeStatusUpdateFrequency` field in the [Kubelet configuration file](/docs/tasks/administer-cluster/reconfigure-kubelet/), and the timeout is controlled by the |
There was a problem hiding this comment.
| `nodeStatusUpdateFrequency` field in the [Kubelet configuration file](/docs/tasks/administer-cluster/reconfigure-kubelet/), and the timeout is controlled by the | |
| `nodeStatusUpdateFrequency` field in the [Kubelet configuration file](/docs/tasks/administer-cluster/reconfigure-kubelet/), | |
| and the timeout is controlled by the |
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
6cdbad0 to
4175e2d
Compare
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
4175e2d to
c895db7
Compare
k8s-ci-robot
added
the
do-not-merge/invalid-commit-message
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
c895db7 to
491205e
Compare
shivansh-gohem
force-pushed
the
fix-node-status-links
branch
from
491205e to
7db1305
Compare
k8s-ci-robot
removed
the
do-not-merge/invalid-commit-message
|
Hi @lmktfy, thank you for the feedback and the suggestion to start a new PR. I've gone ahead and cleaned up the history on this one by resetting the branch and force-pushing a single, clean commit. All the formatting and commit message issues should now be resolved, and all checks are passing. I hope this works, but please let me know if you'd still prefer a new PR. Thanks again for the guidance! |
|
Hi, @lmktfy could you please review my PR. Thanks!! |
4 participants
Fixes #52516
Summary of Change
This Pull Request improves the clarity and referenceability of the "Node Status" documentation by adding explicit links to the configuration parameters for the two key timing values mentioned in the "Heartbeats" section.
Details of the Fix
The paragraph previously stated the default times (5 minutes for Kubelet updates and 40 seconds for unreachability) without explaining how to change them.
The updated text now links directly to the relevant documentation pages:
nodeStatusUpdateFrequency.kube-controller-managerreference page for the--node-monitor-grace-periodflag.This resolves the long-standing request for better configuration guidance on this page.