Skip to content

minor edits to apidoc comments #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged

minor edits to apidoc comments #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions api/v1beta2/appwrapper_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 (
Expand All @@ -164,6 +164,7 @@ const (
AppWrapperTerminating AppWrapperPhase = "Terminating"
)

// AppWrapperCondition enumerates the Condition Types that may appear in AppWrapper status
type AppWrapperCondition string

const (
Expand Down
16 changes: 8 additions & 8 deletions config/crd/bases/workload.codeflare.dev_appwrappers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions site/_pages/appwrapper.v1beta2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/>
Expand Down Expand Up @@ -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>



Expand All @@ -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">
Expand All @@ -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/>
Expand Down Expand Up @@ -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">
Expand Down
Loading