ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla Operator API Reference scylla.scylladb.com ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)

ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)¶

APIVersion: scylla.scylladb.com/v1alpha1
Kind: ScyllaOperatorConfig
PluralName: scyllaoperatorconfigs
SingularName: scyllaoperatorconfig
Scope: Cluster
ListKind: ScyllaOperatorConfigList
Served: true
Storage: true

Description¶

ScyllaOperatorConfig describes the Scylla Operator configuration.

Specification¶

Property

Type

Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

object

spec

object

spec defines the desired state of the operator.

status

object

status defines the observed state of the operator.

.metadata¶

Description¶

Type¶

object

.spec¶

Description¶

spec defines the desired state of the operator.

Type¶

object

Property

Type

Description

configuredClusterDomain

string

configuredClusterDomain allows users to set the configured Kubernetes cluster domain explicitly, instead of letting Scylla Operator automatically discover it.

scyllaUtilsImage

string

scyllaUtilsImage is a ScyllaDB image used for running ScyllaDB utilities.

unsupportedBashToolsImageOverride

string

unsupportedBashToolsImageOverride allows to adjust a generic Bash image with extra tools used by the operator for auxiliary purposes. Setting this field renders your cluster unsupported. Use at your own risk.

unsupportedGrafanaImageOverride

string

unsupportedGrafanaImageOverride allows to adjust Grafana image used by the operator for testing, dev or emergencies. Setting this field renders your cluster unsupported. Use at your own risk.

unsupportedPrometheusVersionOverride

string

unsupportedPrometheusVersionOverride allows to adjust Prometheus version used by the operator for testing, dev or emergencies. Setting this field renders your cluster unsupported. Use at your own risk.

.status¶

Description¶

status defines the observed state of the operator.

Type¶

object

Property

Type

Description

bashToolsImage

string

bashToolsImage is a generic Bash image with extra tools used by the operator for auxiliary purposes.

clusterDomain

string

clusterDomain is the Kubernetes cluster domain used by the Scylla Operator.

conditions

array (object)

conditions hold conditions describing ScyllaOperatorConfig state.

grafanaImage

string

grafanaImage is the image used by the operator to create a Grafana instance.

observedGeneration

integer

observedGeneration is the most recent generation observed for this ScyllaOperatorConfig. It corresponds to the ScyllaOperatorConfig’s generation, which is updated on mutation by the API Server.

prometheusVersion

string

prometheusVersion is the Prometheus version used by the operator to create a Prometheus instance.

scyllaDBUtilsImage

string

scyllaDBUtilsImage is the ScyllaDB image used for running ScyllaDB utilities.

.status.conditions[]¶

Description¶

Condition contains details for one aspect of the current state of this API Resource.

Type¶

object

Property

Type

Description

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

Was this page helpful?

PREVIOUS
ScyllaDBMonitoring (scylla.scylladb.com/v1alpha1)
  • Create an issue
  • Edit this page

On this page

  • ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)
    • Description
    • Specification
      • .metadata
        • Description
        • Type
      • .spec
        • Description
        • Type
      • .status
        • Description
        • Type
      • .status.conditions[]
        • Description
        • Type
Scylla Operator
  • v1.17
    • v1.17
    • v1.16
    • v1.15
    • master
  • Architecture
    • Overview
    • Storage
      • Overview
      • Local CSI Driver
    • Tuning
    • ScyllaDB Manager
  • Installation
    • Overview
    • Kubernetes
      • Generic
      • EKS
      • GKE
    • GitOps (kubectl)
    • Helm
  • Resources
    • Overview
    • ScyllaClusters
      • ScyllaClusters
      • ScyllaDB clients
        • Discovering ScyllaDB Nodes
        • Using CQL
        • Using Alternator (DynamoDB)
      • Node operations using Scylla Operator
        • Upgrading version of Scylla
        • Replacing a Scylla node
        • Automatic cleanup and replacement in case when k8s node is lost
        • Maintenance mode
        • Restore from backup
      • Deploying multi-datacenter ScyllaDB clusters in Kubernetes
        • Build multiple Amazon EKS clusters with inter-Kubernetes networking
        • Build multiple GKE clusters with inter-Kubernetes networking
        • Deploy a multi-datacenter ScyllaDB cluster in multiple interconnected Kubernetes clusters
      • Exposing ScyllaDB cluster
    • ScyllaDBClusters
      • ScyllaDBClusters
      • Exposing ScyllaDB cluster
    • ScyllaDBMonitorings
    • NodeConfigs
    • ScyllaOperatorConfigs
    • RemoteKubernetesCluster
  • Quickstarts
    • Deploying ScyllaDB on GKE
    • Deploying ScyllaDB on EKS
  • Support
    • Support overview
    • Known issues
    • Troubleshooting
      • Troubleshooting installation issues
    • Gathering data with must-gather
    • Releases
  • API Reference
    • scylla.scylladb.com
      • NodeConfig (scylla.scylladb.com/v1alpha1)
      • RemoteKubernetesCluster (scylla.scylladb.com/v1alpha1)
      • RemoteOwner (scylla.scylladb.com/v1alpha1)
      • ScyllaCluster (scylla.scylladb.com/v1)
      • ScyllaDBCluster (scylla.scylladb.com/v1alpha1)
      • ScyllaDBDatacenter (scylla.scylladb.com/v1alpha1)
      • ScyllaDBMonitoring (scylla.scylladb.com/v1alpha1)
      • ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 13 May 2025.
Powered by Sphinx 8.1.3 & ScyllaDB Theme 1.8.6