minor edits to apidoc comments (#349)

Author: dgrove-oss

api/v1beta2/appwrapper_types.go

@@ -42,27 +42,27 @@ type AppWrapperComponent struct {
 	//+optional
 	Annotations map[string]string `json:"annotations,omitempty"`
 
-	// DeclaredPodSets for the Component (optional for known PodCreating GVKs)
+	// DeclaredPodSets for the Component (optional for known GVKs whose PodSets can be automatically inferred)
 	//+optional
 	DeclaredPodSets []AppWrapperPodSet `json:"podSets,omitempty"`
 
 	// PodSetInfos assigned to the Component's PodSets by Kueue
 	//+optional
 	PodSetInfos []AppWrapperPodSetInfo `json:"podSetInfos,omitempty"`
 
+	// Template defines the Kubernetes resource for the Component
 	// +kubebuilder:pruning:PreserveUnknownFields
 	// +kubebuilder:validation:EmbeddedResource
-	// Template defines the Kubernetes resource for the Component
 	Template runtime.RawExtension `json:"template"`
 }
 
-// AppWrapperPodSet describes an homogeneous set of pods
+// AppWrapperPodSet describes a homogeneous set of pods
 type AppWrapperPodSet struct {
 	// Replicas is the number of pods in this PodSet
 	//+optional
 	Replicas *int32 `json:"replicas,omitempty"`
 
-	// Path is the path Component.Template to the PodTemplateSpec for this PodSet
+	// Path is the path within Component.Template to the PodTemplateSpec for this PodSet
 	Path string `json:"path"`
 
 	// Annotations is an unstructured key value map that may be used to store and retrieve
@@ -90,7 +90,7 @@ type AppWrapperPodSetInfo struct {
 	SchedulingGates []corev1.PodSchedulingGate `json:"schedulingGates,omitempty"`
 }
 
-// AppWrapperStatus defines the observed state of the appwrapper
+// AppWrapperStatus defines the observed state of the AppWrapper
 type AppWrapperStatus struct {
 	// Phase of the AppWrapper object
 	//+optional
@@ -149,7 +149,7 @@ type AppWrapperComponentStatus struct {
 	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
 }
 
-// AppWrapperPhase is the phase of the appwrapper
+// AppWrapperPhase enumerates the valid Phases of an AppWrapper
 type AppWrapperPhase string
 
 const (
@@ -164,6 +164,7 @@ const (
 	AppWrapperTerminating AppWrapperPhase = "Terminating"
 )
 
+// AppWrapperCondition enumerates the Condition Types that may appear in AppWrapper status
 type AppWrapperCondition string
 
 const (

config/crd/bases/workload.codeflare.dev_appwrappers.yaml

@@ -150,9 +150,9 @@ spec:
                       type: array
                     podSets:
                       description: DeclaredPodSets for the Component (optional for
-                        known PodCreating GVKs)
+                        known GVKs whose PodSets can be automatically inferred)
                       items:
-                        description: AppWrapperPodSet describes an homogeneous set
+                        description: AppWrapperPodSet describes a homogeneous set
                           of pods
                         properties:
                           annotations:
@@ -163,8 +163,8 @@ spec:
                               arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.
                             type: object
                           path:
-                            description: Path is the path Component.Template to the
-                              PodTemplateSpec for this PodSet
+                            description: Path is the path within Component.Template
+                              to the PodTemplateSpec for this PodSet
                             type: string
                           replicas:
                             description: Replicas is the number of pods in this PodSet
@@ -195,7 +195,7 @@ spec:
             - components
             type: object
           status:
-            description: AppWrapperStatus defines the observed state of the appwrapper
+            description: AppWrapperStatus defines the observed state of the AppWrapper
             properties:
               componentStatus:
                 description: ComponentStatus parallels the Components array in the
@@ -284,7 +284,7 @@ spec:
                         (either from AppWrapperComponent.DeclaredPodSets or inferred
                         by the controller)
                       items:
-                        description: AppWrapperPodSet describes an homogeneous set
+                        description: AppWrapperPodSet describes a homogeneous set
                           of pods
                         properties:
                           annotations:
@@ -295,8 +295,8 @@ spec:
                               arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.
                             type: object
                           path:
-                            description: Path is the path Component.Template to the
-                              PodTemplateSpec for this PodSet
+                            description: Path is the path within Component.Template
+                              to the PodTemplateSpec for this PodSet
                             type: string
                           replicas:
                             description: Replicas is the number of pods in this PodSet

site/_pages/appwrapper.v1beta2.md

@@ -78,7 +78,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 <a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
 </td>
 <td>
-   <p>DeclaredPodSets for the Component (optional for known PodCreating GVKs)</p>
+   <p>DeclaredPodSets for the Component (optional for known GVKs whose PodSets can be automatically inferred)</p>
 </td>
 </tr>
 <tr><td><code>podSetInfos</code><br/>
@@ -165,7 +165,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 - [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus)
 
 
-<p>AppWrapperPhase is the phase of the appwrapper</p>
+<p>AppWrapperPhase enumerates the valid Phases of an AppWrapper</p>
 
 
 
@@ -180,7 +180,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 - [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus)
 
 
-<p>AppWrapperPodSet describes an homogeneous set of pods</p>
+<p>AppWrapperPodSet describes a homogeneous set of pods</p>
 
 
 <table class="table">
@@ -199,7 +199,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 <code>string</code>
 </td>
 <td>
-   <p>Path is the path Component.Template to the PodTemplateSpec for this PodSet</p>
+   <p>Path is the path within Component.Template to the PodTemplateSpec for this PodSet</p>
 </td>
 </tr>
 <tr><td><code>annotations</code><br/>
@@ -315,7 +315,7 @@ arbitrary metadata about the PodSet to customize its treatment by the AppWrapper
 - [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper)
 
 
-<p>AppWrapperStatus defines the observed state of the appwrapper</p>
+<p>AppWrapperStatus defines the observed state of the AppWrapper</p>
 
 
 <table class="table">