Provide richer description of machinehealthcheck type

Author: ingvagabund

install/0000_30_machine-api-operator_07_machinehealthcheck.crd.yaml

@@ -27,13 +27,16 @@ spec:
         metadata:
           type: object
         spec:
+          description: Specification of machine health check policy
           properties:
             selector:
+              description: Label selector to match machines whose health will be exercised
               type: object
           required:
           - selector
           type: object
         status:
+          description: Most recently observed status of MachineHealthCheck resource
           type: object
   version: v1alpha1
 status:

pkg/apis/healthchecking/v1alpha1/machinehealthcheck_types.go

@@ -16,7 +16,10 @@ type MachineHealthCheck struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   MachineHealthCheckSpec   `json:"spec,omitempty"`
+	// Specification of machine health check policy
+	Spec MachineHealthCheckSpec `json:"spec,omitempty"`
+
+	// Most recently observed status of MachineHealthCheck resource
 	Status MachineHealthCheckStatus `json:"status,omitempty"`
 }
 
@@ -31,6 +34,7 @@ type MachineHealthCheckList struct {
 
 // MachineHealthCheckSpec defines the desired state of MachineHealthCheck
 type MachineHealthCheckSpec struct {
+	// Label selector to match machines whose health will be exercised
 	Selector metav1.LabelSelector `json:"selector"`
 }