deploy: 3287887

APIs/index.html

@@ -8022,6 +8022,27 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertex">
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>updateStrategy</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.UpdateStrategy"> UpdateStrategy
+</a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+The strategy to use to replace existing pods with new ones.
+</p>
+
+</td>
+
+</tr>
+
 </table>
 
 </td>
@@ -8390,6 +8411,27 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexSpec">
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>updateStrategy</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.UpdateStrategy"> UpdateStrategy
+</a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+The strategy to use to replace existing pods with new ones.
+</p>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>
@@ -8490,6 +8532,25 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexStatus">
 
 <td>
 
+<code>desiredReplicas</code></br> <em> uint32 </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+The number of desired replicas.
+</p>
+
+</td>
+
+</tr>
+
+<tr>
+
+<td>
+
 <code>selector</code></br> <em> string </em>
 </td>
 
@@ -8607,15 +8668,15 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexStatus">
 
 <td>
 
-<code>currentReplicas</code></br> <em> uint32 </em>
+<code>updatedReplicas</code></br> <em> uint32 </em>
 </td>
 
 <td>
 
 <p>
 
 The number of Pods created by the controller from the MonoVertex version
-indicated by currentHash.
+indicated by updateHash.
 </p>
 
 </td>
@@ -8626,15 +8687,15 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexStatus">
 
 <td>
 
-<code>updatedReplicas</code></br> <em> uint32 </em>
+<code>updatedReadyReplicas</code></br> <em> uint32 </em>
 </td>
 
 <td>
 
 <p>
 
-The number of Pods created by the controller from the MonoVertex version
-indicated by updateHash.
+The number of ready Pods created by the controller from the MonoVertex
+version indicated by updateHash.
 </p>
 
 </td>
@@ -8652,8 +8713,8 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexStatus">
 
 <p>
 
-If not empty, indicates the version of the MonoVertex used to generate
-Pods in the sequence \[0,currentReplicas).
+If not empty, indicates the current version of the MonoVertex used to
+generate Pods.
 </p>
 
 </td>
@@ -8671,8 +8732,8 @@ <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexStatus">
 
 <p>
 
-If not empty, indicates the version of the MonoVertx used to generate
-Pods in the sequence \[replicas-updatedReplicas,replicas)
+If not empty, indicates the updated version of the MonoVertex used to
+generate Pods.
 </p>
 
 </td>
@@ -10649,6 +10710,81 @@ <h3 id="numaflow.numaproj.io/v1alpha1.RetryStrategy">
 
 </table>
 
+<h3 id="numaflow.numaproj.io/v1alpha1.RollingUpdateStrategy">
+
+RollingUpdateStrategy
+</h3>
+
+<p>
+
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.UpdateStrategy">UpdateStrategy</a>)
+</p>
+
+<p>
+
+<p>
+
+RollingUpdateStrategy is used to communicate parameter for
+RollingUpdateStrategyType.
+</p>
+
+</p>
+
+<table>
+
+<thead>
+
+<tr>
+
+<th>
+
+Field
+</th>
+
+<th>
+
+Description
+</th>
+
+</tr>
+
+</thead>
+
+<tbody>
+
+<tr>
+
+<td>
+
+<code>maxUnavailable</code></br> <em>
+k8s.io/apimachinery/pkg/util/intstr.IntOrString </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+The maximum number of pods that can be unavailable during the update.
+Value can be an absolute number (ex: 5) or a percentage of desired pods
+(ex: 10%). Absolute number is calculated from percentage by rounding
+down. Defaults to 25%. Example: when this is set to 30%, the old pods
+can be scaled down to 70% of desired pods immediately when the rolling
+update starts. Once new pods are ready, old pods can be scaled down
+further, followed by scaling up the new pods, ensuring that the total
+number of pods available at all times during the update is at least 70%
+of desired pods.
+</p>
+
+</td>
+
+</tr>
+
+</tbody>
+
+</table>
+
 <h3 id="numaflow.numaproj.io/v1alpha1.SASL">
 
 SASL
@@ -12890,6 +13026,120 @@ <h3 id="numaflow.numaproj.io/v1alpha1.UDTransformer">
 
 </table>
 
+<h3 id="numaflow.numaproj.io/v1alpha1.UpdateStrategy">
+
+UpdateStrategy
+</h3>
+
+<p>
+
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.MonoVertexSpec">MonoVertexSpec</a>)
+</p>
+
+<p>
+
+<p>
+
+UpdateStrategy indicates the strategy that the controller will use to
+perform updates for Vertex or MonoVertex.
+</p>
+
+</p>
+
+<table>
+
+<thead>
+
+<tr>
+
+<th>
+
+Field
+</th>
+
+<th>
+
+Description
+</th>
+
+</tr>
+
+</thead>
+
+<tbody>
+
+<tr>
+
+<td>
+
+<code>type</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.UpdateStrategyType">
+UpdateStrategyType </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+Type indicates the type of the StatefulSetUpdateStrategy. Default is
+RollingUpdate.
+</p>
+
+</td>
+
+</tr>
+
+<tr>
+
+<td>
+
+<code>rollingUpdate</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.RollingUpdateStrategy">
+RollingUpdateStrategy </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+RollingUpdate is used to communicate parameters when Type is
+RollingUpdateStrategy.
+</p>
+
+</td>
+
+</tr>
+
+</tbody>
+
+</table>
+
+<h3 id="numaflow.numaproj.io/v1alpha1.UpdateStrategyType">
+
+UpdateStrategyType (<code>string</code> alias)
+</p>
+
+</h3>
+
+<p>
+
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.UpdateStrategy">UpdateStrategy</a>)
+</p>
+
+<p>
+
+<p>
+
+UpdateStrategyType is a string enumeration type that enumerates all
+possible update strategies.
+</p>
+
+</p>
+
 <h3 id="numaflow.numaproj.io/v1alpha1.Vertex">
 
 Vertex