diff --git a/deploy/operator.yaml b/deploy/operator.yaml index 0925ba1a04a..bc171ab45ba 100644 --- a/deploy/operator.yaml +++ b/deploy/operator.yaml @@ -2932,7 +2932,7 @@ spec: type: string type: array exposeOptions: - description: exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. + description: exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. properties: broadcastOptions: description: BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients. diff --git a/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst b/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst index c492cf51d1a..12a36b6c388 100755 --- a/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst +++ b/docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst @@ -104,7 +104,7 @@ object - dnsDomains is a list of DNS domains this cluster is reachable by. These domains are used when setting up the infrastructure, like certificates. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. * - :ref:`exposeOptions` - object - - exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. + - exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. * - externalSeeds - array (string) - externalSeeds specifies the external seeds to propagate to ScyllaDB binary on startup as "seeds" parameter of seed-provider. @@ -4168,7 +4168,7 @@ object Description """"""""""" -exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. +exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. Type """" diff --git a/docs/source/exposing.md b/docs/source/exposing.md index 348bc4c233d..9ec6e0ba4e5 100644 --- a/docs/source/exposing.md +++ b/docs/source/exposing.md @@ -9,6 +9,10 @@ ScyllaClusters can be only exposed when the ScyllaDB version used version is `>= ## Expose Options +:::{note} +`exposeOptions` are immutable, they cannot be changed after ScyllaCluster is created. +::: + `exposeOptions` specifies configuration options for exposing ScyllaCluster's. A ScyllaCluster created without any `exposeOptions` is equivalent to the following: diff --git a/helm/scylla-manager/values.schema.json b/helm/scylla-manager/values.schema.json index 0617790a5d2..ac48d4b7cc8 100644 --- a/helm/scylla-manager/values.schema.json +++ b/helm/scylla-manager/values.schema.json @@ -299,7 +299,7 @@ "type": "array" }, "exposeOptions": { - "description": "exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.", + "description": "exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.", "properties": { "broadcastOptions": { "description": "BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients.", diff --git a/helm/scylla/values.schema.json b/helm/scylla/values.schema.json index d1a1926179b..0321a6648f7 100644 --- a/helm/scylla/values.schema.json +++ b/helm/scylla/values.schema.json @@ -188,7 +188,7 @@ "type": "array" }, "exposeOptions": { - "description": "exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.", + "description": "exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.", "properties": { "broadcastOptions": { "description": "BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients.", diff --git a/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml b/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml index dc0c07f90da..90988bf43f5 100644 --- a/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml +++ b/pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml @@ -1903,7 +1903,7 @@ spec: type: string type: array exposeOptions: - description: exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. + description: exposeOptions specifies options for exposing ScyllaCluster services. This field is immutable. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. properties: broadcastOptions: description: BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients. diff --git a/pkg/api/scylla/v1/types_cluster.go b/pkg/api/scylla/v1/types_cluster.go index c7c6cc475ea..c6a808016a7 100644 --- a/pkg/api/scylla/v1/types_cluster.go +++ b/pkg/api/scylla/v1/types_cluster.go @@ -118,6 +118,7 @@ type ScyllaClusterSpec struct { DNSDomains []string `json:"dnsDomains,omitempty"` // exposeOptions specifies options for exposing ScyllaCluster services. + // This field is immutable. // EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. // +optional ExposeOptions *ExposeOptions `json:"exposeOptions,omitempty"`