From f1f94a1a3fa31d4e90e396d6e75010ecc192df54 Mon Sep 17 00:00:00 2001 From: veenamj-avesha <104770800+veenamj-avesha@users.noreply.github.com> Date: Wed, 11 Oct 2023 15:28:10 +0530 Subject: [PATCH 1/3] Fixed remaining broken links in OSS versions 1.0.0 and 1.1.0 --- .../version-1.0.0/add-ons/add-ons-slack-metrics.mdx | 2 +- .../kubeslice-cli-demo-on-cloud-clusters.mdx | 2 +- .../version-1.1.0/add-ons/add-ons-slack-metrics.mdx | 2 +- .../release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx | 4 ++-- .../kubeslice-cli-demo-on-cloud-clusters.mdx | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx b/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx index 35ae9cdb..3aa77086 100644 --- a/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx +++ b/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx @@ -4,7 +4,7 @@ The integration involves configuring the Prometheus rules. The integration helps receive alerts on issues such as a pod not working on your cluster. :::info -For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.0.0n/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). +For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.0.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). ::: [Comment]: diff --git a/versioned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx b/versioned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx index 61d520b8..ae387ac5 100644 --- a/versioned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx +++ b/versioned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx @@ -258,4 +258,4 @@ kubeslice-cli uninstall --config= --all ``` -To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.0.0/kubeslice-cli/uninstall-kubeslice.mdx). \ No newline at end of file +To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.0.0/install-kubeslice/kubeslice-cli/uninstall-kubeslice.mdx). \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx b/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx index 0e915575..cf20b63c 100644 --- a/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx +++ b/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx @@ -4,7 +4,7 @@ The integration involves configuring the Prometheus rules. The integration helps receive alerts on issues such as a pod not working on your cluster. :::info -For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.0.0n/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). +For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.0.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). ::: [Comment]: diff --git a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx index f02c7a8f..80365606 100644 --- a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx +++ b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx @@ -27,12 +27,12 @@ applications do not work as expected. To avoid this breaking change, you must add the corresponding namespace of the existing onboarded application in the slice configuration file. To know more, see -[namespace isolation profile parameters](/versioned_docs/version-1.1.0/reference/configuration-parameters.mdx#namespace-isolation-profile-parameters). +[namespace isolation profile parameters](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#namespace-isolation-profile-parameters). ::: To onboard namespaces: -1. Edit the [slice configuration](/versioned_docs/version-1.1.0/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file: +1. Edit the [slice configuration](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file: * Add namespaces for each worker cluster. * Add a wildcard ***** (asterisk) to add all namespaces in the worker clusters. diff --git a/versioned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx b/versioned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx index d2e15ea2..58eae428 100644 --- a/versioned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx +++ b/versioned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx @@ -258,4 +258,4 @@ kubeslice-cli uninstall --config= --all ``` -To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.1.0/uninstall-kubeslice.mdx). \ No newline at end of file +To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.1.0/install-kubeslice/kubeslice-cli/uninstall-kubeslice.mdx). \ No newline at end of file From 93bb2328f03834e051d9b1e457cf8c9d0fcd47f6 Mon Sep 17 00:00:00 2001 From: veenamj-avesha <104770800+veenamj-avesha@users.noreply.github.com> Date: Wed, 11 Oct 2023 23:20:11 +0530 Subject: [PATCH 2/3] Fixing the broken links --- .../test-network-connectivity-kind.mdx | 2 +- .../kubeslice-cli-demo-on-cloud-clusters.mdx | 2 +- .../test-network-connectivity-kind.mdx | 2 +- .../kubeslice-cli-demo-on-cloud-clusters.mdx | 8 +- .../test-network-connectivity-kind.mdx | 2 +- .../test-network-connectivity-kind.mdx | 2 +- .../slice-operations/slice-cluster-health.mdx | 125 ++++++++++++++++++ .../release-notes-for-kubeslice-oss-0.7.0.mdx | 4 +- .../release-notes-for-kubeslice-oss-1.0.0.mdx | 9 +- .../test-network-connectivity.mdx | 2 +- .../slice-operations/slice-cluster-health.mdx | 125 ++++++++++++++++++ .../release-notes-for-kubeslice-oss-0.7.0.mdx | 4 +- .../release-notes-for-kubeslice-oss-1.0.0.mdx | 9 +- .../test-network-connectivity.mdx | 2 +- .../version-1.0.0-sidebars.json | 3 +- .../version-1.1.0-sidebars.json | 3 +- 16 files changed, 277 insertions(+), 27 deletions(-) create mode 100644 versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx create mode 100644 versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx diff --git a/versioned_docs/version-0.4.0/tutorials/test-network-connectivity-kind.mdx b/versioned_docs/version-0.4.0/tutorials/test-network-connectivity-kind.mdx index e021a556..030d2f79 100644 --- a/versioned_docs/version-0.4.0/tutorials/test-network-connectivity-kind.mdx +++ b/versioned_docs/version-0.4.0/tutorials/test-network-connectivity-kind.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-0.4.0/tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx b/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx index 05dc4887..49e1b4f7 100644 --- a/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx +++ b/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx @@ -12,7 +12,7 @@ see [Prerequisites](/versioned_docs/version-0.5.0/getting-started-with-cloud-clu - You have authenticated the worker clusters with the cloud providers. For more information, see [Prepare Clusters](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx). - You have installed Istio on the worker clusters to configure the external gateways. For more information, -see [Install Istio](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster#install-istio). +see [Install Istio](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx#install-istio). - You have cluster administrator privileges to install the KubeSlice Controller on controller cluster and the Slice Operator on worker clusters. ## Install KubeSlice diff --git a/versioned_docs/version-0.5.0/tutorials/test-network-connectivity-kind.mdx b/versioned_docs/version-0.5.0/tutorials/test-network-connectivity-kind.mdx index 9a637939..660e1955 100644 --- a/versioned_docs/version-0.5.0/tutorials/test-network-connectivity-kind.mdx +++ b/versioned_docs/version-0.5.0/tutorials/test-network-connectivity-kind.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-0.5.0/tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx b/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx index 05dc4887..dfb783e4 100644 --- a/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx +++ b/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx @@ -6,13 +6,13 @@ your existing clusters, use the `kubeslice-cli install` command. ## Prerequisites Before you begin, ensure the following prerequisites are met: - You have set up the environment to install the KubeSlice Controller on the cluster. For more information, -see [Prerequisites](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx). +see [Prerequisites](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx). - You have set up the environment for the worker clusters. For more information, -see [Prerequisites](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx). +see [Prerequisites](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx). - You have authenticated the worker clusters with the cloud providers. For more information, -see [Prepare Clusters](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx). +see [Prepare Clusters](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx). - You have installed Istio on the worker clusters to configure the external gateways. For more information, -see [Install Istio](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster#install-istio). +see [Install Istio](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx#install-istio). - You have cluster administrator privileges to install the KubeSlice Controller on controller cluster and the Slice Operator on worker clusters. ## Install KubeSlice diff --git a/versioned_docs/version-0.6.0/tutorials/test-network-connectivity-kind.mdx b/versioned_docs/version-0.6.0/tutorials/test-network-connectivity-kind.mdx index 061b328b..762e4521 100644 --- a/versioned_docs/version-0.6.0/tutorials/test-network-connectivity-kind.mdx +++ b/versioned_docs/version-0.6.0/tutorials/test-network-connectivity-kind.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-0.6.0/tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-0.7.0/tutorials/test-network-connectivity-kind.mdx b/versioned_docs/version-0.7.0/tutorials/test-network-connectivity-kind.mdx index ac4e0b85..be7de0d7 100644 --- a/versioned_docs/version-0.7.0/tutorials/test-network-connectivity-kind.mdx +++ b/versioned_docs/version-0.7.0/tutorials/test-network-connectivity-kind.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-0.7.0/tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx b/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx new file mode 100644 index 00000000..41297aef --- /dev/null +++ b/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx @@ -0,0 +1,125 @@ +# Monitor Slice and Cluster Health +You can check the health of a slice and the worker clusters connected to it using the +corresponding YAML commands. + +## Monitor Slice Health +To monitor a slice's health: + +1. Get the list of worker clusters connected to a slice using the following command: + ``` + kubectl get workersliceconfig -n kubeslice- + ``` + Example + ``` + kubectl get workersliceconfig -n kubeslice-avesha + ``` + + Example Output + ``` + NAME AGE + water-worker-1 54m + water-worker-2 54m + water-worker-3 54m + ``` + +2. From the output, note down the name of a worker cluster and use it in the following command to + get the slice description: + + ``` + kubectl describe workersliceconfig -n kubeslice- + ``` + Example + ``` + kubectl describe workersliceconfig water-worker-1 -n kubeslice-avesha + ``` + + Example Output + + :::info + The output below is an excerpt of the command output to only show the health status. + ::: + + ``` + Slice Health: + Component Statuses: + Component: dns + Component Health Status: Normal + Component: slicegateway + Component Health Status: Normal + Component: slicerouter + Component Health Status: Normal + Last Updated: 2023-04-10T08:54:08Z + Slice Health Status: Normal + +When all the components are in a healthy state, the corresponding status indicates that +the health is **Normal**. + +When a component's health goes bad, the corresponding status indicates the health +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](/versioned_docs/version-1.0.0/troubleshooting/troubleshooting-guide.mdx#slice-and-cluster-health-issues). + +## Monitor Cluster Health +To monitor a cluster's health: + +1. Get the list of worker clusters using the following command: + + ``` + kubectl get clusters -n kubeslice- + ``` + + Example + ``` + kubectl get clusters -n kubeslice-avesha + ``` + Example Output + ``` + NAME AGE + worker-1 76m + worker-2 75m + worker-3 76m + ``` + +2. From the output, note down a worker cluster that you want to monitor and use it in the following + command to get the cluster description: + + ``` + kubectl describe clusters -n kubeslice- + ``` + + Example + + ``` + kubectl describe clusters worker-1 -n kubeslice-avesha + ``` + + Example Output + + :::info + The output below is an excerpt of the command output to only show the health status. + ::: + + ``` + Status: + Cluster Health: + Cluster Health Status: Normal + Component Statuses: + Component: nsmgr + Component Health Status: Normal + Component: forwarder + Component Health Status: Normal + Component: admission-webhook + Component Health Status: Normal + Component: netop + Component Health Status: Normal + Component: spire-agent + Component Health Status: Normal + Component: spire-server + Component Health Status: Normal + Component: istiod + Component Health Status: Normal + ``` + +When all the components are in a healthy state, the corresponding status indicates that +the health is **Normal**. + +When a component's health is bad, the corresponding status indicates the health +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](/versioned_docs/version-1.0.0/troubleshooting/troubleshooting-guide.mdx#slice-and-cluster-health-issues). \ No newline at end of file diff --git a/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx b/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx index 165d8052..7a0b8ff0 100644 --- a/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx +++ b/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx @@ -15,11 +15,11 @@ These release notes describe the new changes and enhancements in this version. ### Controller Events KubeSlice creates controller events and stores them in the `kubeslice-controller` and `kubeslice-project` namespaces. The events can be retrieved using the corresponding command. -For more information, see [controller events](../monitor/controller-events). +For more information, see [controller events](/versioned_docs/version-1.0.0/install-kubeslice/yaml/events/yaml-events-controller-events.mdx). ### Slice and Cluster Health You can now monitor slice and cluster health using the corresponding description commands. -For more information, see [slice and cluster health](../monitor/slice-cluster-health). +For more information, see [slice and cluster health](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx). ### Removal of the Cert Manager Dependency The `cert-manager` is no longer required to install the KubeSlice Controller on the controller cluster. diff --git a/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx b/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx index a40d69e4..308ca955 100644 --- a/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx +++ b/versioned_docs/version-1.0.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx @@ -15,20 +15,19 @@ These release notes describe the new changes and enhancements in this version. ### Worker Operator-generated Events The Worker Operator generates events in the `kubeslice-system` namespace. The events can be retrieved using the corresponding command. -For more information, see [the Worker Operator events](../monitor/worker-operator-events). +For more information, see [the Worker Operator events](/versioned_docs/version-1.0.0/install-kubeslice/yaml/events/yaml-events-worker-events.mdx). ### KubeSlice Metrics KubeSlice now records custom metrics that helps in monitoring the slice, and other KubeSlice components. These Prometheus metrics can be configured as alerts using the alert manager. -For more information, see [KubeSlice metrics](../monitor/kubeslice-metrics) -and [Prometheus alert rules](../monitor/alert-rules). +For more information, see [KubeSlice metrics](/versioned_docs/version-1.0.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx). ### Event Integration on Slack KubeSlice-generated events can be integrated on slack to track them on a separate application workspace. -For more information, see [integrate KubeSlice-generated events on Slack](../monitor/slack-event-integration). +For more information, see [integrate KubeSlice-generated events on Slack](/versioned_docs/version-1.0.0/add-ons/add-ons-slack-events.mdx). ### Metric-based Alerts Integration with Slack KubeSlice metric-based alerts can be integrated with Slack for brownfield and greenfield Prometheus deployments. This integration facilitates tracking the metric-based alerts on a dedicated Slack channel. -For more information, see [integrate alerts with Slack](../monitor/alert-manager-slack). \ No newline at end of file +For more information, see [integrate alerts with Slack](/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx). \ No newline at end of file diff --git a/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx b/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx index 16e532ca..25aba683 100644 --- a/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx +++ b/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx b/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx new file mode 100644 index 00000000..8eecd77b --- /dev/null +++ b/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx @@ -0,0 +1,125 @@ +# Monitor Slice and Cluster Health +You can check the health of a slice and the worker clusters connected to it using the +corresponding YAML commands. + +## Monitor Slice Health +To monitor a slice's health: + +1. Get the list of worker clusters connected to a slice using the following command: + ``` + kubectl get workersliceconfig -n kubeslice- + ``` + Example + ``` + kubectl get workersliceconfig -n kubeslice-avesha + ``` + + Example Output + ``` + NAME AGE + water-worker-1 54m + water-worker-2 54m + water-worker-3 54m + ``` + +2. From the output, note down the name of a worker cluster and use it in the following command to + get the slice description: + + ``` + kubectl describe workersliceconfig -n kubeslice- + ``` + Example + ``` + kubectl describe workersliceconfig water-worker-1 -n kubeslice-avesha + ``` + + Example Output + + :::info + The output below is an excerpt of the command output to only show the health status. + ::: + + ``` + Slice Health: + Component Statuses: + Component: dns + Component Health Status: Normal + Component: slicegateway + Component Health Status: Normal + Component: slicerouter + Component Health Status: Normal + Last Updated: 2023-04-10T08:54:08Z + Slice Health Status: Normal + +When all the components are in a healthy state, the corresponding status indicates that +the health is **Normal**. + +When a component's health goes bad, the corresponding status indicates the health +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide.mdx#/slice-and-cluster-health-issues). + +## Monitor Cluster Health +To monitor a cluster's health: + +1. Get the list of worker clusters using the following command: + + ``` + kubectl get clusters -n kubeslice- + ``` + + Example + ``` + kubectl get clusters -n kubeslice-avesha + ``` + Example Output + ``` + NAME AGE + worker-1 76m + worker-2 75m + worker-3 76m + ``` + +2. From the output, note down a worker cluster that you want to monitor and use it in the following + command to get the cluster description: + + ``` + kubectl describe clusters -n kubeslice- + ``` + + Example + + ``` + kubectl describe clusters worker-1 -n kubeslice-avesha + ``` + + Example Output + + :::info + The output below is an excerpt of the command output to only show the health status. + ::: + + ``` + Status: + Cluster Health: + Cluster Health Status: Normal + Component Statuses: + Component: nsmgr + Component Health Status: Normal + Component: forwarder + Component Health Status: Normal + Component: admission-webhook + Component Health Status: Normal + Component: netop + Component Health Status: Normal + Component: spire-agent + Component Health Status: Normal + Component: spire-server + Component Health Status: Normal + Component: istiod + Component Health Status: Normal + ``` + +When all the components are in a healthy state, the corresponding status indicates that +the health is **Normal**. + +When a component's health is bad, the corresponding status indicates the health +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide.mdx#/slice-and-cluster-health-issues). \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx index 165d8052..1326a673 100644 --- a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx +++ b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-0.7.0.mdx @@ -15,11 +15,11 @@ These release notes describe the new changes and enhancements in this version. ### Controller Events KubeSlice creates controller events and stores them in the `kubeslice-controller` and `kubeslice-project` namespaces. The events can be retrieved using the corresponding command. -For more information, see [controller events](../monitor/controller-events). +For more information, see [controller events](versioned_docs/version-1.0.0/install-kubeslice/yaml/events/yaml-events-controller-events.mdx). ### Slice and Cluster Health You can now monitor slice and cluster health using the corresponding description commands. -For more information, see [slice and cluster health](../monitor/slice-cluster-health). +For more information, see [slice and cluster health](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx). ### Removal of the Cert Manager Dependency The `cert-manager` is no longer required to install the KubeSlice Controller on the controller cluster. diff --git a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx index a40d69e4..25742096 100644 --- a/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx +++ b/versioned_docs/version-1.1.0/release-notes/release-notes-for-kubeslice-oss-1.0.0.mdx @@ -15,20 +15,19 @@ These release notes describe the new changes and enhancements in this version. ### Worker Operator-generated Events The Worker Operator generates events in the `kubeslice-system` namespace. The events can be retrieved using the corresponding command. -For more information, see [the Worker Operator events](../monitor/worker-operator-events). +For more information, see [the Worker Operator events](/versioned_docs/version-1.0.0/install-kubeslice/yaml/events/yaml-events-controller-events.mdx). ### KubeSlice Metrics KubeSlice now records custom metrics that helps in monitoring the slice, and other KubeSlice components. These Prometheus metrics can be configured as alerts using the alert manager. -For more information, see [KubeSlice metrics](../monitor/kubeslice-metrics) -and [Prometheus alert rules](../monitor/alert-rules). +For more information, see [KubeSlice metrics](/versioned_docs/version-1.0.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx). ### Event Integration on Slack KubeSlice-generated events can be integrated on slack to track them on a separate application workspace. -For more information, see [integrate KubeSlice-generated events on Slack](../monitor/slack-event-integration). +For more information, see [integrate KubeSlice-generated events on Slack](/versioned_docs/version-1.1.0/add-ons/add-ons-slack-events.mdx). ### Metric-based Alerts Integration with Slack KubeSlice metric-based alerts can be integrated with Slack for brownfield and greenfield Prometheus deployments. This integration facilitates tracking the metric-based alerts on a dedicated Slack channel. -For more information, see [integrate alerts with Slack](../monitor/alert-manager-slack). \ No newline at end of file +For more information, see [integrate alerts with Slack](/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx). \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx b/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx index f260d56f..9ddceb6a 100644 --- a/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx +++ b/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_sidebars/version-1.0.0-sidebars.json b/versioned_sidebars/version-1.0.0-sidebars.json index d8cd27e7..3fbfea4a 100644 --- a/versioned_sidebars/version-1.0.0-sidebars.json +++ b/versioned_sidebars/version-1.0.0-sidebars.json @@ -141,7 +141,8 @@ }, "items": [ "install-kubeslice/yaml/slice-operations/slice-operations-slice-creation", - "install-kubeslice/yaml/slice-operations/slice-operations-slice-deletion" + "install-kubeslice/yaml/slice-operations/slice-operations-slice-deletion", + "install-kubeslice/yaml/slice-operations/slice-cluster-health" ] }, { diff --git a/versioned_sidebars/version-1.1.0-sidebars.json b/versioned_sidebars/version-1.1.0-sidebars.json index 3291479e..06575315 100644 --- a/versioned_sidebars/version-1.1.0-sidebars.json +++ b/versioned_sidebars/version-1.1.0-sidebars.json @@ -141,7 +141,8 @@ }, "items": [ "install-kubeslice/yaml/slice-operations/slice-operations-slice-creation", - "install-kubeslice/yaml/slice-operations/slice-operations-slice-deletion" + "install-kubeslice/yaml/slice-operations/slice-operations-slice-deletion", + "install-kubeslice/yaml/slice-operations/slice-cluster-health" ] }, { From 0e9b9750491306bbe9b55391f38534e67bd6fcfb Mon Sep 17 00:00:00 2001 From: veenamj-avesha <104770800+veenamj-avesha@users.noreply.github.com> Date: Thu, 12 Oct 2023 13:01:56 +0530 Subject: [PATCH 3/3] Fixed broken links --- .../yaml/slice-operations/slice-cluster-health.mdx | 4 ++-- .../tutorials/yaml-tutorials/test-network-connectivity.mdx | 2 +- .../version-1.1.0/add-ons/add-ons-slack-metrics.mdx | 2 +- .../yaml/slice-operations/slice-cluster-health.mdx | 4 ++-- .../tutorials/yaml-tutorials/test-network-connectivity.mdx | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx b/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx index 41297aef..93fa59b5 100644 --- a/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx +++ b/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx @@ -55,7 +55,7 @@ When all the components are in a healthy state, the corresponding status indicat the health is **Normal**. When a component's health goes bad, the corresponding status indicates the health -with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](/versioned_docs/version-1.0.0/troubleshooting/troubleshooting-guide.mdx#slice-and-cluster-health-issues). +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide#slice-and-cluster-health-issues). ## Monitor Cluster Health To monitor a cluster's health: @@ -122,4 +122,4 @@ When all the components are in a healthy state, the corresponding status indicat the health is **Normal**. When a component's health is bad, the corresponding status indicates the health -with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](/versioned_docs/version-1.0.0/troubleshooting/troubleshooting-guide.mdx#slice-and-cluster-health-issues). \ No newline at end of file +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide#slice-and-cluster-health-issues). \ No newline at end of file diff --git a/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx b/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx index 25aba683..cba9e0c3 100644 --- a/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx +++ b/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/test-network-connectivity.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/deploy-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a diff --git a/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx b/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx index cf20b63c..de9f0865 100644 --- a/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx +++ b/versioned_docs/version-1.1.0/add-ons/add-ons-slack-metrics.mdx @@ -4,7 +4,7 @@ The integration involves configuring the Prometheus rules. The integration helps receive alerts on issues such as a pod not working on your cluster. :::info -For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.0.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). +For more information on the metrics description, see [KubeSlice Metrics](/versioned_docs/version-1.1.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics). ::: [Comment]: diff --git a/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx b/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx index 8eecd77b..93fa59b5 100644 --- a/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx +++ b/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-cluster-health.mdx @@ -55,7 +55,7 @@ When all the components are in a healthy state, the corresponding status indicat the health is **Normal**. When a component's health goes bad, the corresponding status indicates the health -with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide.mdx#/slice-and-cluster-health-issues). +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide#slice-and-cluster-health-issues). ## Monitor Cluster Health To monitor a cluster's health: @@ -122,4 +122,4 @@ When all the components are in a healthy state, the corresponding status indicat the health is **Normal**. When a component's health is bad, the corresponding status indicates the health -with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide.mdx#/slice-and-cluster-health-issues). \ No newline at end of file +with a **Warning**. To know how to trace an issue in each component, see [slice and cluster health issues](../../../troubleshooting/troubleshooting-guide#slice-and-cluster-health-issues). \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx b/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx index 9ddceb6a..3d65fb62 100644 --- a/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx +++ b/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/test-network-connectivity.mdx @@ -20,7 +20,7 @@ Deploy the iPerf application and test the network connectivity between the worke :::info You can also use an intra-cluster slice to test the intra cluster connectivity. To know -more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/deploying-the-iperf-application-on-an-intra-cluster-slice.mdx). +more, see [deploying the iPerf application on an intra-cluster slice](/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/deploy-the-iperf-application-on-an-intra-cluster-slice.mdx). ::: Identify a worker cluster as a client and another worker cluster as a