Skip to content

Commit f2810c8

Browse files
authored
Merge pull request #26201 from kbhawkey/fix-nodedetector-caps
change capitalization of daemon name
2 parents 6ce3a86 + a09fc68 commit f2810c8

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

content/en/docs/tasks/debug-application-cluster/monitor-node-health.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ reviewers:
88

99
<!-- overview -->
1010

11-
*Node problem detector* is a daemon for monitoring and reporting about a node's health.
12-
You can run node problem detector as a `DaemonSet`
13-
or as a standalone daemon. Node problem detector collects information about node problems from various daemons
11+
*Node Problem Detector* is a daemon for monitoring and reporting about a node's health.
12+
You can run Node Problem Detector as a `DaemonSet` or as a standalone daemon.
13+
Node Problem Detector collects information about node problems from various daemons
1414
and reports these conditions to the API server as [NodeCondition](/docs/concepts/architecture/nodes/#condition)
1515
and [Event](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#event-v1-core).
1616

17-
To learn how to install and use the node problem detector, see the
18-
[Node problem detector project documentation](https://github.com/kubernetes/node-problem-detector).
17+
To learn how to install and use Node Problem Detector, see
18+
[Node Problem Detector project documentation](https://github.com/kubernetes/node-problem-detector).
1919

2020
## {{% heading "prerequisites" %}}
2121

@@ -25,24 +25,24 @@ To learn how to install and use the node problem detector, see the
2525

2626
## Limitations
2727

28-
* Node problem detector only supports file based kernel log.
28+
* Node Problem Detector only supports file based kernel log.
2929
Log tools such as `journald` are not supported.
3030

31-
* Node problem detector uses the kernel log format for reporting kernel issues.
31+
* Node Problem Detector uses the kernel log format for reporting kernel issues.
3232
To learn how to extend the kernel log format, see [Add support for another log format](#support-other-log-format).
3333

34-
## Enabling node problem detector
34+
## Enabling Node Problem Detector
3535

36-
Some cloud providers enable node problem detector as an {{< glossary_tooltip text="Addon" term_id="addons" >}}.
37-
You can also enable node problem detector with `kubectl` or by creating an Addon pod.
36+
Some cloud providers enable Node Problem Detector as an {{< glossary_tooltip text="Addon" term_id="addons" >}}.
37+
You can also enable Node Problem Detector with `kubectl` or by creating an Addon pod.
3838

39-
### Using kubectl to enable node problem detector {#using-kubectl}
39+
### Using kubectl to enable Node Problem Detector {#using-kubectl}
4040

41-
`kubectl` provides the most flexible management of node problem detector.
41+
`kubectl` provides the most flexible management of Node Problem Detector.
4242
You can overwrite the default configuration to fit it into your environment or
4343
to detect customized node problems. For example:
4444

45-
1. Create a node problem detector configuration similar to `node-problem-detector.yaml`:
45+
1. Create a Node Problem Detector configuration similar to `node-problem-detector.yaml`:
4646

4747
{{< codenew file="debug/node-problem-detector.yaml" >}}
4848

@@ -56,7 +56,7 @@ to detect customized node problems. For example:
5656
kubectl apply -f https://k8s.io/examples/debug/node-problem-detector.yaml
5757
```
5858

59-
### Using an Addon pod to enable node problem detector {#using-addon-pod}
59+
### Using an Addon pod to enable Node Problem Detector {#using-addon-pod}
6060

6161
If you are using a custom cluster bootstrap solution and don't need
6262
to overwrite the default configuration, you can leverage the Addon pod to
@@ -68,7 +68,7 @@ directory `/etc/kubernetes/addons/node-problem-detector` on a control plane node
6868
## Overwrite the configuration
6969

7070
The [default configuration](https://github.com/kubernetes/node-problem-detector/tree/v0.1/config)
71-
is embedded when building the Docker image of node problem detector.
71+
is embedded when building the Docker image of Node Problem Detector.
7272

7373
However, you can use a [`ConfigMap`](/docs/tasks/configure-pod-container/configure-pod-configmap/)
7474
to overwrite the configuration:
@@ -84,7 +84,7 @@ to overwrite the configuration:
8484

8585
{{< codenew file="debug/node-problem-detector-configmap.yaml" >}}
8686

87-
1. Recreate the node problem detector with the new configuration file:
87+
1. Recreate the Node Problem Detector with the new configuration file:
8888

8989
```shell
9090
# If you have a node-problem-detector running, delete before recreating
@@ -93,25 +93,25 @@ to overwrite the configuration:
9393
```
9494

9595
{{< note >}}
96-
This approach only applies to a node problem detector started with `kubectl`.
96+
This approach only applies to a Node Problem Detector started with `kubectl`.
9797
{{< /note >}}
9898

99-
Overwriting a configuration is not supported if a node problem detector runs as a cluster Addon.
99+
Overwriting a configuration is not supported if a Node Problem Detector runs as a cluster Addon.
100100
The Addon manager does not support `ConfigMap`.
101101

102102
## Kernel Monitor
103103

104-
*Kernel Monitor* is a system log monitor daemon supported in the node problem detector.
104+
*Kernel Monitor* is a system log monitor daemon supported in the Node Problem Detector.
105105
Kernel monitor watches the kernel log and detects known kernel issues following predefined rules.
106106

107107
The Kernel Monitor matches kernel issues according to a set of predefined rule list in
108-
[`config/kernel-monitor.json`](https://github.com/kubernetes/node-problem-detector/blob/v0.1/config/kernel-monitor.json). The rule list is extensible. You can extend the rule list by overwriting the
108+
[`config/kernel-monitor.json`](https://github.com/kubernetes/node-problem-detector/blob/v0.1/config/kernel-monitor.json). The rule list is extensible. You can expand the rule list by overwriting the
109109
configuration.
110110

111111
### Add new NodeConditions
112112

113-
To support a new `NodeCondition`, you can extend the `conditions` field in
114-
`config/kernel-monitor.json` with a new condition definition such as:
113+
To support a new `NodeCondition`, create a condition definition within the `conditions` field in
114+
`config/kernel-monitor.json`, for example:
115115

116116
```json
117117
{
@@ -140,7 +140,7 @@ with a new rule definition:
140140
Check your kernel log path location in your operating system (OS) distribution.
141141
The Linux kernel [log device](https://www.kernel.org/doc/Documentation/ABI/testing/dev-kmsg) is usually presented as `/dev/kmsg`. However, the log path location varies by OS distribution.
142142
The `log` field in `config/kernel-monitor.json` represents the log path inside the container.
143-
You can configure the `log` field to match the device path as seen by the node problem detector.
143+
You can configure the `log` field to match the device path as seen by the Node Problem Detector.
144144

145145
### Add support for another log format {#support-other-log-format}
146146

@@ -152,11 +152,11 @@ You can implement a new translator for a new log format.
152152

153153
## Recommendations and restrictions
154154

155-
It is recommended to run the node problem detector in your cluster to monitor node health.
156-
When running the node problem detector, you can expect extra resource overhead on each node.
155+
It is recommended to run the Node Problem Detector in your cluster to monitor node health.
156+
When running the Node Problem Detector, you can expect extra resource overhead on each node.
157157
Usually this is fine, because:
158158

159159
* The kernel log grows relatively slowly.
160-
* A resource limit is set for the node problem detector.
161-
* Even under high load, the resource usage is acceptable. For more information, see the node problem detector
160+
* A resource limit is set for the Node Problem Detector.
161+
* Even under high load, the resource usage is acceptable. For more information, see the Node Problem Detector
162162
[benchmark result](https://github.com/kubernetes/node-problem-detector/issues/2#issuecomment-220255629).

0 commit comments

Comments
 (0)