Add support for temporal v1.24.x

alexandrevilain · Sep 8, 2024 · 564d33e · 564d33e
1 parent 6110327
commit 564d33e
Show file tree

Hide file tree

Showing 42 changed files with 310 additions and 211 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM --platform=${BUILDPLATFORM} golang:1.22.2 as builder
+FROM --platform=${BUILDPLATFORM} golang:1.22.2 AS builder
 
 ARG TARGETPLATFORM
 ARG BUILDPLATFORM

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore:
@@ -62,18 +62,20 @@ Somes examples are available to help you get started:
 The following table shows operator compatibility with Temporal and Kubernetes.
 Please note this table only reports end-to-end tests suite coverage, others versions *may* work.
 
-| Temporal Operator | Temporal           | Kubernetes     |
-|-------------------|--------------------|----------------|
-| v0.18.x           | v1.19.x to v1.23.x | v1.25 to v1.29 |
-| v0.17.x           | v1.18.x to v1.22.x | v1.25 to v1.29 |
-| v0.16.x           | v1.18.x to v1.22.x | v1.24 to v1.27 |
-| v0.15.x           | v1.18.x to v1.21.x | v1.24 to v1.27 |
-| v0.14.x           | v1.18.x to v1.21.x | v1.24 to v1.27 |
-| v0.13.x           | v1.18.x to v1.20.x | v1.24 to v1.27 |
-| v0.12.x           | v1.18.x to v1.20.x | v1.23 to v1.26 |
-| v0.11.x           | v1.17.x to v1.19.x | v1.23 to v1.26 |
-| v0.10.x           | v1.17.x to v1.19.x | v1.23 to v1.26 |
-| v0.9.x            | v1.16.x to v1.18.x | v1.22 to v1.25 |
+| Temporal Operator      | Temporal           | Kubernetes     |
+|------------------------|--------------------|----------------|
+| v0.20.x (not released) | v1.19.x to v1.24.x | v1.26 to v1.30 |
+| v0.19.x                | v1.19.x to v1.23.x | v1.25 to v1.29 |
+| v0.18.x                | v1.19.x to v1.23.x | v1.25 to v1.29 |
+| v0.17.x                | v1.18.x to v1.22.x | v1.25 to v1.29 |
+| v0.16.x                | v1.18.x to v1.22.x | v1.24 to v1.27 |
+| v0.15.x                | v1.18.x to v1.21.x | v1.24 to v1.27 |
+| v0.14.x                | v1.18.x to v1.21.x | v1.24 to v1.27 |
+| v0.13.x                | v1.18.x to v1.20.x | v1.24 to v1.27 |
+| v0.12.x                | v1.18.x to v1.20.x | v1.23 to v1.26 |
+| v0.11.x                | v1.17.x to v1.19.x | v1.23 to v1.26 |
+| v0.10.x                | v1.17.x to v1.19.x | v1.23 to v1.26 |
+| v0.9.x                 | v1.16.x to v1.18.x | v1.22 to v1.25 |
 
 ## Roadmap
 

diff --git a/api/v1beta1/temporalcluster_defaults.go b/api/v1beta1/temporalcluster_defaults.go
@@ -26,13 +26,14 @@ import (
 )
 
 const (
-	defaultTemporalVersion = "1.23.0"
+	defaultTemporalVersion = "1.24.2"
 	defaultTemporalImage   = "temporalio/server"
 
-	defaultTemporalUIVersion = "2.25.0"
+	defaultTemporalUIVersion = "2.27.3"
 	defaultTemporalUIImage   = "temporalio/ui"
 
-	defaultTemporalAdmintoolsImage = "temporalio/admin-tools"
+	defaultTemporalAdmintoolsImage   = "temporalio/admin-tools"
+	defaultTemporalAdmintoolsVersion = "1.24.2-tctl-1.18.1-cli-0.13.2"
 )
 
 // Default set default fields values.
@@ -213,6 +214,15 @@ func (c *TemporalCluster) Default() {
 		c.Spec.AdminTools.Image = defaultTemporalAdmintoolsImage
 	}
 
+	if c.Spec.AdminTools.Version == "" {
+		if c.Spec.Version.GreaterOrEqual(version.V1_24_0) {
+			c.Spec.AdminTools.Version = defaultTemporalAdmintoolsVersion
+		} else {
+			c.Spec.AdminTools.Version = c.Spec.Version.String()
+		}
+
+	}
+
 	if c.Spec.MTLS != nil {
 		if c.Spec.MTLS.RefreshInterval == nil {
 			c.Spec.MTLS.RefreshInterval = &metav1.Duration{Duration: time.Hour}

diff --git a/api/v1beta1/temporalcluster_types.go b/api/v1beta1/temporalcluster_types.go
@@ -585,6 +585,9 @@ type TemporalAdminToolsSpec struct {
 	// Image defines the temporal admin tools docker image the instance should run.
 	// +optional
 	Image string `json:"image"`
+	// Version defines the temporal admin tools version the instance should run.
+	// +optional
+	Version string `json:"version"`
 	// Compute Resources required by the ui.
 	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 	// +optional

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/bundle/manifests/temporal-operator.clusterserviceversion.yaml b/bundle/manifests/temporal-operator.clusterserviceversion.yaml
@@ -191,7 +191,7 @@ spec:
             user: temporal
       ui:
         enabled: true
-      version: 1.23.0
+      version: 1.24.2
     </pre>
 
     ### Apply TemporalCluster CustomResource

diff --git a/config/crd/bases/temporal.io_temporalclusters.yaml b/config/crd/bases/temporal.io_temporalclusters.yaml
@@ -174,6 +174,9 @@ spec:
                             More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
                           type: object
                       type: object
+                    version:
+                      description: Version defines the temporal admin tools version the instance should run.
+                      type: string
                   type: object
                 archival:
                   description: Archival allows Workflow Execution Event Histories and Visibility data backups for the temporal cluster.

diff --git a/config/manifests/bases/temporal-operator.clusterserviceversion.yaml b/config/manifests/bases/temporal-operator.clusterserviceversion.yaml
@@ -164,7 +164,7 @@ spec:
             user: temporal
       ui:
         enabled: true
-      version: 1.23.0
+      version: 1.24.2
     </pre>
 
     ### Apply TemporalCluster CustomResource

diff --git a/config/manifests/bases/temporal-operator.clusterserviceversion.yaml-e b/config/manifests/bases/temporal-operator.clusterserviceversion.yaml-e
@@ -164,7 +164,7 @@ spec:
             user: temporal
       ui:
         enabled: true
-      version: 1.23.0
+      version: 1.24.2
     </pre>
 
     ### Apply TemporalCluster CustomResource

diff --git a/config/samples/temporal.io_v1beta1_temporalcluster.yaml b/config/samples/temporal.io_v1beta1_temporalcluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300
   persistence:

diff --git a/docs/api/v1beta1.md b/docs/api/v1beta1.md
@@ -4574,6 +4574,18 @@ string
 </tr>
 <tr>
 <td>
+<code>version</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Version defines the temporal admin tools version the instance should run.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>resources</code><br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core">

diff --git a/docs/features/admin-tools.md b/docs/features/admin-tools.md
@@ -11,13 +11,13 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   admintools:
     enabled: true
     # You can specify the admin tools version if needed.
     # Check available tag you can check by the link below
     # https://hub.docker.com/r/temporalio/admin-tools/tags
-    version: 1.23.0
+    version: 1.24.2-tctl-1.18.1-cli-0.13.2
 ```
diff --git a/docs/features/archival.md b/docs/features/archival.md
@@ -68,7 +68,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   archival:
@@ -104,7 +104,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   archival:
@@ -142,7 +142,7 @@ kind: TemporalCluster
 metadata:
   name: prod
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   services:
@@ -195,7 +195,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   archival:

diff --git a/docs/features/dynamic-config.md b/docs/features/dynamic-config.md
@@ -11,7 +11,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   dynamicConfig:

diff --git a/docs/features/monitoring/prometheus-operator.md b/docs/features/monitoring/prometheus-operator.md
@@ -23,7 +23,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   metrics:

diff --git a/docs/features/monitoring/prometheus.md b/docs/features/monitoring/prometheus.md
@@ -19,7 +19,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   metrics:

diff --git a/docs/features/temporal-ui.md b/docs/features/temporal-ui.md
@@ -15,7 +15,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   ui:
@@ -39,7 +39,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   ui:
@@ -63,7 +63,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   # [...]
   ui:
@@ -92,7 +92,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   ui:
     enabled: true

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -34,7 +34,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore:

diff --git a/examples/cluster-cassandra/02-temporal-cluster.yaml b/examples/cluster-cassandra/02-temporal-cluster.yaml
@@ -13,7 +13,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300
   persistence:

diff --git a/examples/cluster-mtls-istio/02-temporal-cluster.yaml b/examples/cluster-mtls-istio/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300
   persistence:

diff --git a/examples/cluster-mtls-linkerd/02-temporal-cluster.yaml b/examples/cluster-mtls-linkerd/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300  
   persistence:

diff --git a/examples/cluster-mtls/02-temporal-cluster.yaml b/examples/cluster-mtls/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300
   persistence:

diff --git a/examples/cluster-mysql/02-temporal-cluster.yaml b/examples/cluster-mysql/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore:

diff --git a/examples/cluster-postgres-archival/02-temporal-cluster.yaml b/examples/cluster-postgres-archival/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore:

diff --git a/examples/cluster-postgres-es/03-temporal-cluster.yaml b/examples/cluster-postgres-es/03-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   jobTtlSecondsAfterFinished: 300 
   persistence:

diff --git a/examples/cluster-postgres/02-temporal-cluster.yaml b/examples/cluster-postgres/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore:

diff --git a/examples/cluster-sidecar/02-temporal-cluster.yaml b/examples/cluster-sidecar/02-temporal-cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: prod
   namespace: demo
 spec:
-  version: 1.23.0
+  version: 1.24.2
   numHistoryShards: 1
   persistence:
     defaultStore: