Skip to content

Commit 1fca3ca

Browse files
gyliu513k8s-ci-robot
authored andcommitted
Added use case for Cluster Health Checking. (#933)
1 parent 0ebf076 commit 1fca3ca

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/staging-use-cases.md

+20
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ last-updated: 2019-04-16
3333
- [Managing Providers](#managing-providers)
3434
- [Creating Workload Clusters](#creating-workload-clusters)
3535
- [Provider Implementors](#provider-implementors)
36+
- [Cluster Health Checking](#cluster-health-checking)
3637

3738
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3839

@@ -227,3 +228,22 @@ Multitenancy Management
227228

228229
### Provider Implementors
229230
- As a provider, I want the machine controller to reconcile a Machine in response to an event from some other resource in the cluster. This is the sort of thing that other controllers do on a regular basis, so that's nothing particularly interesting. But having made a machine actuator, there's not an easy way to get access to the machine controller object in order to call its Watch method.
231+
232+
## Cluster Health Checking
233+
234+
Cluster Health Checking is a service to provide the health status of Kubernetes cluster and its components.
235+
236+
- As an operator, given I have created a Kubernetes-conformant cluster with ClusterAPI, I want to check the Kubernetes cluster node status.
237+
- Describe nodes and provide details if they are ready/healthy or not ready/healthy.
238+
- List conditions for any nodes which are `NotReady`, list information about allocated resources.
239+
240+
- As an operator, given I have created a Kubernetes-conformant cluster with ClusterAPI, I want to check the kube-apiserver status.
241+
242+
- As an operator, given I have created a Kubernetes-conformant cluster with ClusterAPI, I want to check the etcd status.
243+
244+
- 🔭 As an operator, given I have created a Kubernetes-conformant cluster with ClusterAPI, I want to check the Kubernetes components status, like ingress controller, other add-on components etc.
245+
246+
- 🔭 As an operator, given I have created a Kubernetes-conformant cluster with ClusterAPI, I want to check unhealthy Pods statuses in configured namespace.
247+
- Provide the details on any pods which are unhealthy in `kube-system` namespace. Filter the unhealthy pods for their status(`kubectl get pods --show-labels -n kube-system | grep -vE "Running|Completed"`)
248+
- Describe any Pods which are not `Completed|Running`, list the Events to provide hints on the failure.
249+
- Look for Pods which don't have all of their containers running.

0 commit comments

Comments
 (0)