Update the "Kubernetes visualizations" doc (#14347)
* Update the "Kubernetes visualizations" doc * fix metadata comment block
Fotis Voutsas committed
Feb 7, 2023 at 20:17 UTC
f115f0831b78c4f7f75a691d041122d74d22b88d
1 file changed
+4
-18
docs/cloud/visualize/kubernetes.md
+4
-18
@@ -9,22 +9,12 @@ learn_rel_path: "Operations/Visualizations"
9
-->
10
11
Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in
12
-the default [Overview](/docs/cloud/visualize/overview/) dashboard.
12
+the default [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) dashboard.
13
14
These visualizations include a health map for viewing the status of k8s pods/containers, in addition to composite charts
15
for viewing per-second CPU, memory, disk, and networking metrics from k8s nodes.
16
17
-## Before you begin
18
-
19
-In order to use the Kubernetes visualizations in Netdata Cloud, you need:
20
-
21
-- A Kubernetes cluster running Kubernetes v1.9 or newer.
22
-- A Netdata deployment using the latest version of the [Helm chart](https://github.com/netdata/helmchart), which
23
- installs [v1.29.2](https://github.com/netdata/netdata/releases) or newer of the Netdata Agent.
24
-- To connect your Kubernetes cluster to Netdata Cloud.
25
-- To enable the feature flag described below.
26
-
27
-See our [Kubernetes deployment instructions](/docs/agent/packaging/installer/methods/kubernetes/) for details on
17
+See our [Kubernetes deployment instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for details on
18
installation and connecting to Netdata Cloud.
19
20
## Available Kubernetes metrics
@@ -87,7 +77,7 @@ and `k8s_node_name`. The default is `k8s_controller_name`.
77
78
### Filtering
79
90
-Filtering behaves identically to the [node filter in War Rooms](/docs/cloud/war-rooms#node-filter), with the ability to
80
+Filtering behaves identically to the [node filter in War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#node-filter), with the ability to
81
filter pods/containers by `container_id` and `namespace`.
82
83
### Detailed information
@@ -120,7 +110,7 @@ problematic behavior to investigate further, troubleshoot, and remediate with `k
110
The Kubernetes composite charts show real-time and historical resource utilization metrics from nodes, pods, or
111
containers within your Kubernetes deployment.
112
123
-See the [Overview](/docs/cloud/visualize/overview#definition-bar) doc for details on how composite charts work. These
113
+See the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#definition-bar) doc for details on how composite charts work. These
114
work similarly, but in addition to visualizing _by dimension_ and _by node_, Kubernetes composite charts can also be
115
grouped by the following labels:
116
@@ -148,7 +138,3 @@ There are some caveats and known issues with Kubernetes monitoring with Netdata
138
[drained](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/) from your Kubernetes cluster. These
139
drained nodes will be marked "unreachable" and will show up in War Room management screens/dropdowns. The same applies
140
for any ephemeral nodes created and destroyed during horizontal scaling.
151
-
152
-## What's next?
153
-
154
-For more information about monitoring a k8s cluster with Netdata, see our guide: [_Kubernetes monitoring with Netdata: Overview and visualizations_](/guides/monitor/kubernetes-k8s-netdata/).