From 92408498ccb21f63c194e96200dea4ec9d6ac84f Mon Sep 17 00:00:00 2001 From: David Grove Date: Fri, 11 Apr 2025 11:12:28 -0400 Subject: [PATCH] minor edits to apidoc comments --- api/v1beta2/appwrapper_types.go | 13 +++++++------ .../workload.codeflare.dev_appwrappers.yaml | 16 ++++++++-------- site/_pages/appwrapper.v1beta2.md | 10 +++++----- 3 files changed, 20 insertions(+), 19 deletions(-) diff --git a/api/v1beta2/appwrapper_types.go b/api/v1beta2/appwrapper_types.go index 4ea021a..f448e82 100644 --- a/api/v1beta2/appwrapper_types.go +++ b/api/v1beta2/appwrapper_types.go @@ -42,7 +42,7 @@ 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"` @@ -50,19 +50,19 @@ type AppWrapperComponent struct { //+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 ( diff --git a/config/crd/bases/workload.codeflare.dev_appwrappers.yaml b/config/crd/bases/workload.codeflare.dev_appwrappers.yaml index ab8ea6b..243aed4 100644 --- a/config/crd/bases/workload.codeflare.dev_appwrappers.yaml +++ b/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 diff --git a/site/_pages/appwrapper.v1beta2.md b/site/_pages/appwrapper.v1beta2.md index 8a4ccc7..0220bee 100644 --- a/site/_pages/appwrapper.v1beta2.md +++ b/site/_pages/appwrapper.v1beta2.md @@ -78,7 +78,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap []AppWrapperPodSet -

DeclaredPodSets for the Component (optional for known PodCreating GVKs)

+

DeclaredPodSets for the Component (optional for known GVKs whose PodSets can be automatically inferred)

podSetInfos
@@ -165,7 +165,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap - [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus) -

AppWrapperPhase is the phase of the appwrapper

+

AppWrapperPhase enumerates the valid Phases of an AppWrapper

@@ -180,7 +180,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap - [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus) -

AppWrapperPodSet describes an homogeneous set of pods

+

AppWrapperPodSet describes a homogeneous set of pods

@@ -199,7 +199,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap string
-

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
annotations
@@ -315,7 +315,7 @@ arbitrary metadata about the PodSet to customize its treatment by the AppWrapper - [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper) -

AppWrapperStatus defines the observed state of the appwrapper

+

AppWrapperStatus defines the observed state of the AppWrapper