Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note to documentation about exposeOptions being immutable #2097

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Add a note to documentation about exposeOptions being immutable #2097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fead3e7
Add a note to documentation about exposeOptions being immutable
zimnx Aug 27, 2024
37617bd
Update autogenerated
zimnx Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deploy/operator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<api-scylla.scylladb.com-scyllaclusters-v1-.spec.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.
Expand Down Expand Up @@ -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
""""
Expand Down
4 changes: 4 additions & 0 deletions docs/source/exposing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion helm/scylla-manager/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down
2 changes: 1 addition & 1 deletion helm/scylla/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down
2 changes: 1 addition & 1 deletion pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions pkg/api/scylla/v1/types_cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down