Merge pull request #2088 from zimnx/deprecate-cpuset

Deprecate cpuset field in v1.ScyllaCluster
scylladb · Aug 21, 2024 · 6b54d8d · 6b54d8d
2 parents eb6c012 + 0ab6cc1
commit 6b54d8d
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 8 deletions.
diff --git a/deploy/operator.yaml b/deploy/operator.yaml
@@ -1205,7 +1205,7 @@ spec:
                     type: object
                   type: array
                 cpuset:
-                  description: cpuset determines if the cluster will use cpu-pinning for max performance.
+                  description: 'cpuset determines if the cluster will use cpu-pinning. Deprecated: `cpuset` is deprecated and may be ignored in the future.'
                   type: boolean
                 datacenter:
                   description: datacenter holds a specification of a datacenter.

diff --git a/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst b/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst
@@ -92,7 +92,7 @@ object
      - backups specifies backup tasks in Scylla Manager. When Scylla Manager is not installed, these will be ignored.
    * - cpuset
      - boolean
-     - cpuset determines if the cluster will use cpu-pinning for max performance.
+     - cpuset determines if the cluster will use cpu-pinning. Deprecated: `cpuset` is deprecated and may be ignored in the future.
    * - :ref:`datacenter<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter>`
      - object
      - datacenter holds a specification of a datacenter.

diff --git a/examples/eks/cluster.yaml b/examples/eks/cluster.yaml
@@ -15,7 +15,6 @@ metadata:
 spec:
   agentVersion: 3.3.0
   version: 5.4.3
-  cpuset: true
   sysctls:
   - "fs.aio-max-nr=2097152"
   datacenter:

diff --git a/examples/gke/cluster.yaml b/examples/gke/cluster.yaml
@@ -15,7 +15,6 @@ metadata:
 spec:
   agentVersion: 3.3.0
   version: 5.4.3
-  cpuset: true
   automaticOrphanedNodeCleanup: true
   sysctls:
     - "fs.aio-max-nr=2097152"

diff --git a/helm/scylla-manager/values.schema.json b/helm/scylla-manager/values.schema.json
@@ -281,7 +281,7 @@
           "type": "array"
         },
         "cpuset": {
-          "description": "cpuset determines if the cluster will use cpu-pinning for max performance.",
+          "description": "cpuset determines if the cluster will use cpu-pinning. Deprecated: `cpuset` is deprecated and may be ignored in the future.",
           "type": "boolean"
         },
         "datacenter": {

diff --git a/helm/scylla/values.schema.json b/helm/scylla/values.schema.json
@@ -170,7 +170,7 @@
       "type": "array"
     },
     "cpuset": {
-      "description": "cpuset determines if the cluster will use cpu-pinning for max performance.",
+      "description": "cpuset determines if the cluster will use cpu-pinning. Deprecated: `cpuset` is deprecated and may be ignored in the future.",
       "type": "boolean"
     },
     "datacenter": {

diff --git a/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml b/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml
@@ -176,7 +176,7 @@ spec:
                     type: object
                   type: array
                 cpuset:
-                  description: cpuset determines if the cluster will use cpu-pinning for max performance.
+                  description: 'cpuset determines if the cluster will use cpu-pinning. Deprecated: `cpuset` is deprecated and may be ignored in the future.'
                   type: boolean
                 datacenter:
                   description: datacenter holds a specification of a datacenter.

diff --git a/pkg/api/scylla/v1/types_cluster.go b/pkg/api/scylla/v1/types_cluster.go
@@ -63,7 +63,8 @@ type ScyllaClusterSpec struct {
 	// +optional
 	DeveloperMode bool `json:"developerMode,omitempty"`
 
-	// cpuset determines if the cluster will use cpu-pinning for max performance.
+	// cpuset determines if the cluster will use cpu-pinning.
+	// Deprecated: `cpuset` is deprecated and may be ignored in the future.
 	// +optional
 	CpuSet bool `json:"cpuset,omitempty"`