From ea4bf6d407d700cecad64aa64f25c45da28f8512 Mon Sep 17 00:00:00 2001 From: Fotis Voutsas <fotis@netdata.cloud> Date: Tue, 23 Apr 2024 10:43:09 +0300 Subject: [PATCH] move netdata charts documentation to proper folder (#17488) * fix * links --- .../visualize/kubernetes.md => dashboard/kubernetes-tab.md} | 0 docs/glossary.md | 2 +- docs/guides/monitor/kubernetes-k8s-netdata.md | 2 +- docs/quickstart/infrastructure.md | 6 +++--- packaging/installer/methods/kubernetes.md | 6 +++--- 5 files changed, 8 insertions(+), 8 deletions(-) rename docs/{cloud/visualize/kubernetes.md => dashboard/kubernetes-tab.md} (100%) diff --git a/docs/cloud/visualize/kubernetes.md b/docs/dashboard/kubernetes-tab.md similarity index 100% rename from docs/cloud/visualize/kubernetes.md rename to docs/dashboard/kubernetes-tab.md diff --git a/docs/glossary.md b/docs/glossary.md index f3ba741d5d..6a9a8bf6c2 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -87,7 +87,7 @@ Use the alphabatized list below to find the answer to your single-term questions - [**Kickstart** or **Kickstart Script**](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md): An automatic one-line installation script named 'kickstart.sh' that works on all Linux distributions and macOS. -- [**Kubernetes Dashboard** or **Kubernetes Tab**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md): Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in the default Overview dashboard. +- [**Kubernetes Dashboard** or **Kubernetes Tab**](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md): Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in the default Overview dashboard. ## M diff --git a/docs/guides/monitor/kubernetes-k8s-netdata.md b/docs/guides/monitor/kubernetes-k8s-netdata.md index 992b69001a..d09ec6ed55 100644 --- a/docs/guides/monitor/kubernetes-k8s-netdata.md +++ b/docs/guides/monitor/kubernetes-k8s-netdata.md @@ -123,7 +123,7 @@ visualizations](https://user-images.githubusercontent.com/1153921/109049195-349f ### Health map -The first visualization is the [health map](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md#health-map), +The first visualization is the [health map](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md#health-map), which places each container into its own box, then varies the intensity of their color to visualize the resource utilization. By default, the health map shows the **average CPU utilization as a percentage of the configured limit** for every container in your cluster. diff --git a/docs/quickstart/infrastructure.md b/docs/quickstart/infrastructure.md index 20385e04df..d18df458e4 100644 --- a/docs/quickstart/infrastructure.md +++ b/docs/quickstart/infrastructure.md @@ -75,7 +75,7 @@ These tabs can be separated into "static", meaning they are by default presented - The third and most important tab is the [Metrics tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md) which uses composite charts to display real-time metrics from every available node in a given War Room. -- [Kubernetes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) is a logical grouping of charts regarding your Kubernetes clusters. It contains a subset of the charts available in the **Overview tab**. +- [Kubernetes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md) is a logical grouping of charts regarding your Kubernetes clusters. It contains a subset of the charts available in the **Overview tab**. - The [Dashboards tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/dashboards-tab.md) gives you the ability to have tailored made views of specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes. @@ -173,7 +173,7 @@ collect from across your infrastructure with Netdata. <BoxList> <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md)" title="Metrics tab" /> <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md)" title="Nodes tab" /> - <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)" title="Kubernetes" /> + <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md)" title="Kubernetes" /> <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/dashboards-tab.md)" title="Create new dashboards" /> </BoxList> </Box> @@ -208,7 +208,7 @@ collect from across your infrastructure with Netdata. - Dashboards - [Metrics tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md) - [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md) - - [Kubernetes](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) + - [Kubernetes](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md) - [Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/dashboard/dashboards-tab.md) - Alerts and notifications - [View active alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alerts.md#netdata-cloud) diff --git a/packaging/installer/methods/kubernetes.md b/packaging/installer/methods/kubernetes.md index 17cb9f5e16..bacee36b72 100644 --- a/packaging/installer/methods/kubernetes.md +++ b/packaging/installer/methods/kubernetes.md @@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem'; # Install Netdata on Kubernetes -This document details how to install Netdata on an existing Kubernetes (k8s) cluster, and connect it to Netdata Cloud. Read our [Kubernetes visualizations](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) documentation, to see what you will get. +This document details how to install Netdata on an existing Kubernetes (k8s) cluster, and connect it to Netdata Cloud. Read our [Kubernetes visualizations](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md) documentation, to see what you will get. The [Netdata Helm chart](https://github.com/netdata/helmchart/blob/master/charts/netdata/README.md) installs one `parent` pod for storing metrics and managing alert notifications, plus an additional `child` pod for every node in the cluster, responsible for collecting metrics from the node, Kubernetes control planes, @@ -191,10 +191,10 @@ helm upgrade netdata netdata/netdata ## What's next? -[Start Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) in Netdata Cloud, which comes with meaningful visualizations out of the box. +[Start Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md) in Netdata Cloud, which comes with meaningful visualizations out of the box. ### Related reference documentation -- [Netdata Cloud · Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) +- [Netdata Cloud · Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/dashboard/kubernetes-tab.md) - [Netdata Helm chart](https://github.com/netdata/helmchart) - [Netdata service discovery](https://github.com/netdata/agent-service-discovery/)