Skip to content

Commit 33e7257

Browse files
committed
regenerate apiref
1 parent 1f9796c commit 33e7257

File tree

1 file changed

+90
-1
lines changed

1 file changed

+90
-1
lines changed

site/_pages/appwrapper.v1beta2.md

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
6969
<a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
7070
</td>
7171
<td>
72-
<p>PodSets contained in the Component</p>
72+
<p>DeclaredPodSets for the Component (optional for known PodCreating GVKs)</p>
7373
</td>
7474
</tr>
7575
<tr><td><code>podSetInfos</code><br/>
@@ -89,6 +89,64 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
8989
</tbody>
9090
</table>
9191

92+
## `AppWrapperComponentStatus` {#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus}
93+
94+
95+
**Appears in:**
96+
97+
- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus)
98+
99+
100+
<p>AppWrapperComponentStatus tracks the status of a single managed Component</p>
101+
102+
103+
<table class="table">
104+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
105+
<tbody>
106+
107+
108+
<tr><td><code>name</code> <B>[Required]</B><br/>
109+
<code>string</code>
110+
</td>
111+
<td>
112+
<p>Name is the name of the Component</p>
113+
</td>
114+
</tr>
115+
<tr><td><code>kind</code> <B>[Required]</B><br/>
116+
<code>string</code>
117+
</td>
118+
<td>
119+
<p>Kind is the Kind of the Component</p>
120+
</td>
121+
</tr>
122+
<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
123+
<code>string</code>
124+
</td>
125+
<td>
126+
<p>APIVersion is the APIVersion of the Component</p>
127+
</td>
128+
</tr>
129+
<tr><td><code>podSets</code> <B>[Required]</B><br/>
130+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
131+
</td>
132+
<td>
133+
<p>PodSets is the validated PodSets for the Component (either from AppWrapperComponent.DeclaredPodSets or inferred by the controller)</p>
134+
</td>
135+
</tr>
136+
<tr><td><code>conditions</code><br/>
137+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta"><code>[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition</code></a>
138+
</td>
139+
<td>
140+
<p>Conditions hold the latest available observations of the Component's current state.</p>
141+
<p>The type of the condition could be:</p>
142+
<ul>
143+
<li>ResourcesDeployed: The component is deployed on the cluster</li>
144+
</ul>
145+
</td>
146+
</tr>
147+
</tbody>
148+
</table>
149+
92150
## `AppWrapperPhase` {#workload-codeflare-dev-v1beta2-AppWrapperPhase}
93151

94152
(Alias of `string`)
@@ -110,6 +168,8 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
110168

111169
- [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent)
112170

171+
- [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus)
172+
113173

114174
<p>AppWrapperPodSet describes an homogeneous set of pods</p>
115175

@@ -133,6 +193,14 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
133193
<p>Path is the path Component.Template to the PodTemplateSpec for this PodSet</p>
134194
</td>
135195
</tr>
196+
<tr><td><code>annotations</code><br/>
197+
<code>map[string]string</code>
198+
</td>
199+
<td>
200+
<p>Annotations is an unstructured key value map that may be used to store and retrieve
201+
arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.</p>
202+
</td>
203+
</tr>
136204
</tbody>
137205
</table>
138206

@@ -180,6 +248,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
180248
<p>Tolerations to be added to the PodSpecTemplate</p>
181249
</td>
182250
</tr>
251+
<tr><td><code>schedulingGates</code><br/>
252+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podschedulinggate-v1-core"><code>[]k8s.io/api/core/v1.PodSchedulingGate</code></a>
253+
</td>
254+
<td>
255+
<p>SchedulingGates to be added to the PodSpecTemplate</p>
256+
</td>
257+
</tr>
183258
</tbody>
184259
</table>
185260

@@ -213,6 +288,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
213288
<p>Suspend suspends the AppWrapper when set to true</p>
214289
</td>
215290
</tr>
291+
<tr><td><code>managedBy</code> <B>[Required]</B><br/>
292+
<code>string</code>
293+
</td>
294+
<td>
295+
<p>ManagedBy is used to indicate the controller or entity that manages the AppWrapper.</p>
296+
</td>
297+
</tr>
216298
</tbody>
217299
</table>
218300

@@ -261,5 +343,12 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
261343
</ul>
262344
</td>
263345
</tr>
346+
<tr><td><code>componentStatus</code> <B>[Required]</B><br/>
347+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus"><code>[]AppWrapperComponentStatus</code></a>
348+
</td>
349+
<td>
350+
<p>ComponentStatus parallels the Components array in the Spec and tracks the actually deployed resources</p>
351+
</td>
352+
</tr>
264353
</tbody>
265354
</table>

0 commit comments

Comments
 (0)