Use rollout rather than cutover in CRD JSON. (#93)

* Use `rollout` rather than `cutover` in CRD JSON.

This matches the terms used internally.

Author: robholland

README.md

@@ -118,14 +118,14 @@ flowchart TD
 
 When a new worker deployment version is deployed, the worker controller detects it and automatically begins the process
 of making that version the new **current** (aka default) version of the worker deployment it is a part of. This could happen
-immediately if `cutover.strategy = AllAtOnce`, or gradually if `cutover.strategy = Progressive`.
+immediately if `rollout.strategy = AllAtOnce`, or gradually if `rollout.strategy = Progressive`.
 
 As older pinned workflows finish executing and deprecated deployment versions become drained, the worker controller also
 frees up resources by sunsetting the `Deployment` resources polling those versions.
 
 Here is an example of a progressive cut-over strategy gated on the success of the `HelloWorld` workflow:
 ```yaml
-  cutover:
+  rollout:
     strategy: Progressive
     steps:
       - rampPercentage: 1

api/v1alpha1/temporalworker_webhook.go

@@ -115,22 +115,22 @@ func validateRolloutStrategy(s RolloutStrategy) []*field.Error {
 		rolloutSteps := s.Steps
 		if len(rolloutSteps) == 0 {
 			allErrs = append(allErrs,
-				field.Invalid(field.NewPath("spec.cutover.steps"), rolloutSteps, "steps are required for Progressive cutover"),
+				field.Invalid(field.NewPath("spec.rollout.steps"), rolloutSteps, "steps are required for Progressive rollout"),
 			)
 		}
 		var lastRamp float32
 		for i, s := range rolloutSteps {
 			// Check duration >= 30s
 			if s.PauseDuration.Duration < 30*time.Second {
 				allErrs = append(allErrs,
-					field.Invalid(field.NewPath(fmt.Sprintf("spec.cutover.steps[%d].pauseDuration", i)), s.PauseDuration.Duration.String(), "pause duration must be at least 30s"),
+					field.Invalid(field.NewPath(fmt.Sprintf("spec.rollout.steps[%d].pauseDuration", i)), s.PauseDuration.Duration.String(), "pause duration must be at least 30s"),
 				)
 			}
 
 			// Check ramp value greater than last
 			if s.RampPercentage <= lastRamp {
 				allErrs = append(allErrs,
-					field.Invalid(field.NewPath(fmt.Sprintf("spec.cutover.steps[%d].rampPercentage", i)), s.RampPercentage, "rampPercentage must increase between each step"),
+					field.Invalid(field.NewPath(fmt.Sprintf("spec.rollout.steps[%d].rampPercentage", i)), s.RampPercentage, "rampPercentage must increase between each step"),
 				)
 			}
 			lastRamp = s.RampPercentage

api/v1alpha1/temporalworker_webhook_test.go

@@ -46,7 +46,7 @@ func TestTemporalWorkerDeployment_ValidateCreate(t *testing.T) {
 				obj.Spec.RolloutStrategy.Steps = nil
 				return obj
 			}),
-			errorMsg: "spec.cutover.steps: Invalid value: []v1alpha1.RolloutStep(nil): steps are required for Progressive cutover",
+			errorMsg: "spec.rollout.steps: Invalid value: []v1alpha1.RolloutStep(nil): steps are required for Progressive rollout",
 		},
 		"ramp value for step <= previous step": {
 			obj: testhelpers.ModifyObj(testhelpers.MakeTWDWithName("prog-rollout-decreasing-ramps"), func(obj *temporaliov1alpha1.TemporalWorkerDeployment) *temporaliov1alpha1.TemporalWorkerDeployment {
@@ -61,7 +61,7 @@ func TestTemporalWorkerDeployment_ValidateCreate(t *testing.T) {
 				}
 				return obj
 			}),
-			errorMsg: "[spec.cutover.steps[2].rampPercentage: Invalid value: 9: rampPercentage must increase between each step, spec.cutover.steps[4].rampPercentage: Invalid value: 50: rampPercentage must increase between each step]",
+			errorMsg: "[spec.rollout.steps[2].rampPercentage: Invalid value: 9: rampPercentage must increase between each step, spec.rollout.steps[4].rampPercentage: Invalid value: 50: rampPercentage must increase between each step]",
 		},
 		"pause duration < 30s": {
 			obj: testhelpers.ModifyObj(testhelpers.MakeTWDWithName("prog-rollout-decreasing-ramps"), func(obj *temporaliov1alpha1.TemporalWorkerDeployment) *temporaliov1alpha1.TemporalWorkerDeployment {
@@ -73,7 +73,7 @@ func TestTemporalWorkerDeployment_ValidateCreate(t *testing.T) {
 				}
 				return obj
 			}),
-			errorMsg: `spec.cutover.steps[1].pauseDuration: Invalid value: "10s": pause duration must be at least 30s`,
+			errorMsg: `spec.rollout.steps[1].pauseDuration: Invalid value: "10s": pause duration must be at least 30s`,
 		},
 	}
 

api/v1alpha1/worker_types.go

@@ -52,8 +52,8 @@ type TemporalWorkerDeploymentSpec struct {
 	// not be estimated during the time a deployment is paused. Defaults to 600s.
 	ProgressDeadlineSeconds *int32 `json:"progressDeadlineSeconds,omitempty" protobuf:"varint,9,opt,name=progressDeadlineSeconds"`
 
-	// How to cut over new workflow executions to the target version.
-	RolloutStrategy RolloutStrategy `json:"cutover"`
+	// How to rollout new workflow executions to the target version.
+	RolloutStrategy RolloutStrategy `json:"rollout"`
 
 	// How to manage sunsetting drained versions.
 	SunsetStrategy SunsetStrategy `json:"sunset"`

helm/temporal-worker-controller/templates/crds/temporal.io_temporalworkerdeployments.yaml

@@ -46,7 +46,20 @@ spec:
             type: object
           spec:
             properties:
-              cutover:
+              maxVersions:
+                format: int32
+                minimum: 1
+                type: integer
+              minReadySeconds:
+                format: int32
+                type: integer
+              progressDeadlineSeconds:
+                format: int32
+                type: integer
+              replicas:
+                format: int32
+                type: integer
+              rollout:
                 properties:
                   gate:
                     properties:
@@ -76,19 +89,6 @@ spec:
                 required:
                 - strategy
                 type: object
-              maxVersions:
-                format: int32
-                minimum: 1
-                type: integer
-              minReadySeconds:
-                format: int32
-                type: integer
-              progressDeadlineSeconds:
-                format: int32
-                type: integer
-              replicas:
-                format: int32
-                type: integer
               selector:
                 properties:
                   matchExpressions:
@@ -3760,7 +3760,7 @@ spec:
                 - temporalNamespace
                 type: object
             required:
-            - cutover
+            - rollout
             - sunset
             - template
             - workerOptions

internal/demo/helloworld/changes/progressive-rollout.patch

@@ -4,8 +4,8 @@ index 926fc27..3e1fd51 100644
 +++ b/internal/demo/helloworld/temporal_worker.yaml
 @@ -12,9 +12,20 @@ spec:
      temporalNamespace: "replay-2025.ktasd"
-   # How to cut over new workflow executions to the latest worker version
-   cutover:
+   # How to rollout new workflow executions to the latest worker version
+   rollout:
 -    strategy: AllAtOnce
 +    strategy: Progressive
      gate:

internal/demo/helloworld/temporal_worker_deployment.yaml

@@ -12,8 +12,8 @@ spec:
     #    temporalNamespace: "replay-2025.ktasd"
     temporalNamespace: "worker-controller-test.a2dd6"
 
-  # How to cut over new workflow executions to the latest worker version
-  cutover:
+  # How to rollout new workflow executions to the latest worker version
+  rollout:
     strategy: Progressive
     steps:
       - rampPercentage: 1