kubeslice · veenamj-avesha · Oct 12, 2023 · Oct 11, 2023 · Oct 11, 2023 · Oct 12, 2023
@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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]: <!-- TODO: Syntax is correct, but this link does not resolve. -->

@@ -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-<project>
+   ```
+   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 <worker-cluster> -n kubeslice-<project>
+   ```
+   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#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-<project>
+   ```
+
+   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 <worker-cluster> -n kubeslice-<project>
+   ```
+
+   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#slice-and-cluster-health-issues).
@@ -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. 

@@ -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).
+For more information, see [integrate alerts with Slack](/versioned_docs/version-1.0.0/add-ons/add-ons-slack-metrics.mdx).
@@ -258,4 +258,4 @@ kubeslice-cli uninstall --config=<file-path-of-topology> --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).
+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).
@@ -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/deploy-the-iperf-application-on-an-intra-cluster-slice.mdx).
 :::
 
 Identify a worker cluster as a client and another worker cluster as a

@@ -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.1.0/install-kubeslice/yaml/metrics/yaml-metrics-controller-metrics.mdx/#controller-metrics).
 :::
 
 [Comment]: <!-- TODO: Syntax is correct, but this link does not resolve. -->

@@ -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-<project>
+   ```
+   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 <worker-cluster> -n kubeslice-<project>
+   ```
+   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#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-<project>
+   ```
+
+   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 <worker-cluster> -n kubeslice-<project>
+   ```
+
+   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#slice-and-cluster-health-issues).