ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Deployments
    • Cloud
    • Server
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
    • Supported Driver Versions
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Install
Search Ask AI
ScyllaDB Docs ScyllaDB Operator Deploy ScyllaDB Before you deploy Configure ScyllaDB Operator

Configure ScyllaDB Operator¶

This page explains how to configure ScyllaDB Operator’s global settings using the ScyllaOperatorConfig resource.

Overview¶

ScyllaOperatorConfig is a cluster-scoped singleton resource named cluster. ScyllaDB Operator creates it automatically on startup if it does not exist. It holds global settings that affect all ScyllaDB clusters managed by ScyllaDB Operator, such as auxiliary container images and the Kubernetes cluster domain.

Most users do not need to modify this resource. ScyllaDB Operator ships with sensible defaults that are updated automatically when you upgrade.

Tip

You can inspect all available fields with:

kubectl explain --api-version='scylla.scylladb.com/v1alpha1' ScyllaOperatorConfig.spec

View the current configuration¶

kubectl get scyllaoperatorconfig cluster -o yaml

The status section shows the resolved values that are actually in use, including auto-discovered defaults:

status:
  scyllaDBUtilsImage: docker.io/scylladb/scylla:2025.1.9@sha256:...
  bashToolsImage: registry.access.redhat.com/ubi9/ubi:9.5-...@sha256:...
  grafanaImage: docker.io/grafana/grafana:12.2.0@sha256:...
  prometheusVersion: v3.6.0
  clusterDomain: cluster.local

Configurable fields¶

Spec field

Description

Default

scyllaUtilsImage

ScyllaDB image used for running utility scripts (perftune, sysctl). Determines which tuning scripts are used for performance optimization.

Latest ScyllaDB image.

configuredClusterDomain

Kubernetes cluster domain. Must be a fully qualified domain name.

Auto-discovered via DNS lookup of kubernetes.default.svc.

unsupportedBashToolsImageOverride

Override the Bash tools image. Unsupported — for advanced use only.

UBI 9 image.

unsupportedGrafanaImageOverride

Override the Grafana image. Unsupported — for advanced use only.

Official Grafana image.

unsupportedPrometheusVersionOverride

Override the Prometheus version. Unsupported — for advanced use only.

Latest tested Prometheus version.

Caution

Fields prefixed with unsupported are not covered by the regular support policy. Use them only if you have a specific reason and understand the implications.

Change the ScyllaDB utils image¶

By default, ScyllaDB Operator uses performance tuning scripts from the latest ScyllaDB image. To use a different image, set scyllaUtilsImage:

apiVersion: scylla.scylladb.com/v1alpha1
kind: ScyllaOperatorConfig
metadata:
  name: cluster
spec:
  scyllaUtilsImage: "docker.io/scylladb/scylla-enterprise:2026.1.3"

Apply the change:

kubectl apply --server-side -f scyllaoperatorconfig.yaml

The NodeConfig DaemonSet picks up the new image and uses Enterprise-specific tuning scripts on the next reconciliation.

Set the cluster domain¶

ScyllaDB Operator auto-discovers the Kubernetes cluster domain by performing a DNS CNAME lookup for kubernetes.default.svc. If your cluster uses a non-standard domain or the auto-discovery does not work, set it explicitly:

apiVersion: scylla.scylladb.com/v1alpha1
kind: ScyllaOperatorConfig
metadata:
  name: cluster
spec:
  configuredClusterDomain: my-cluster.local

The cluster domain is used internally for Kubernetes DNS resolution. Most users do not need to override it.

How settings propagate¶

ScyllaOperatorConfig settings are consumed by several Operator controllers:

Consumer

Setting used

NodeConfig controller

scyllaDBUtilsImage — configures the tuning DaemonSet with the correct ScyllaDB image for perftune.py and resource limits.

ScyllaDBMonitoring controller

grafanaImage, prometheusVersion — configures the monitoring stack.

Changes to ScyllaOperatorConfig trigger reconciliation in all dependent controllers. You do not need to restart Operator.

Related pages¶

  • Configure nodes — performance tuning that uses the scyllaUtilsImage.

  • Set up monitoring — monitoring stack that uses the Grafana and Prometheus settings.

  • Tuning architecture — how tuning scripts are executed.

Was this page helpful?

PREVIOUS
Configure nodes
NEXT
Deploy your first cluster
  • Create an issue
  • Edit this page

On this page

  • Configure ScyllaDB Operator
    • Overview
    • View the current configuration
    • Configurable fields
    • Change the ScyllaDB utils image
    • Set the cluster domain
    • How settings propagate
    • Related pages
ScyllaDB Operator
Search Ask AI
  • v1.21
    • master
    • v1.21
    • v1.20
    • v1.19
    • v1.18
  • Get Started
    • What Is ScyllaDB Operator?
    • ScyllaDB Concepts on Kubernetes
  • Install Operator
    • Provision infrastructure
      • Set up a GKE cluster for ScyllaDB
      • Set up an EKS cluster for ScyllaDB
      • Set up an OKE cluster for ScyllaDB
      • Set up an OpenShift cluster for ScyllaDB
    • Install with GitOps
    • Install with Helm
    • Install on OpenShift
  • Deploy ScyllaDB
    • Before you deploy
      • Set up dedicated node pools
      • Configure CPU pinning
      • Configure nodes
      • Configure ScyllaDB Operator
    • Deploy your first cluster
    • Reference deployments
      • Reference deployment: GKE
      • Reference deployment: EKS
      • Reference deployment: OKE
      • Reference deployment: OpenShift
    • Install ScyllaDB Manager
    • Set up networking
      • Configure external access
      • IPv6 networking
        • Getting started with IPv6 networking
        • Configure dual-stack networking
        • Configure IPv6-only networking
        • Migrate clusters to IPv6
        • Troubleshoot IPv6 networking issues
        • IPv6 networking concepts
    • Set up monitoring
      • Set up ScyllaDB Monitoring
      • Set up ScyllaDB Monitoring on OpenShift
      • Expose Grafana
    • Production checklist
  • Connect Your App
    • Connect via CQL
    • Alternator (DynamoDB API)
    • Discovery endpoint
  • Understand
    • Storage
    • Tuning
    • ScyllaDB Manager
    • Networking
    • ScyllaDB Monitoring overview
    • Bootstrap synchronisation
    • Automatic data cleanup
    • Sidecar and pod anatomy
    • Ignition
    • Pod disruption budgets
    • Security
    • StatefulSets and racks
  • Operate
    • Scale, add, remove racks
    • Replace nodes
    • Expand storage volumes
    • Use maintenance mode
    • Back up and restore
    • Restore from backup
    • Perform a rolling restart
    • Migrate a rack to a new node pool
    • Pass additional ScyllaDB arguments
    • Configure precomputed IO properties
  • Upgrade
    • Upgrading ScyllaDB Operator
    • Upgrading ScyllaDB clusters
  • Troubleshoot
    • Investigate pod restarts
    • Change log level on a live cluster
    • Recover from a failed node replace
    • Troubleshoot performance
    • Collect debugging information
      • Collect data with must-gather
      • must-gather contents
      • Query system tables for debugging
    • Collect core dumps
  • Reference
    • 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)
        • ScyllaDBDatacenterNodesStatusReport (scylla.scylladb.com/v1alpha1)
        • ScyllaDBDatacenter (scylla.scylladb.com/v1alpha1)
        • ScyllaDBManagerClusterRegistration (scylla.scylladb.com/v1alpha1)
        • ScyllaDBManagerTask (scylla.scylladb.com/v1alpha1)
        • ScyllaDBMonitoring (scylla.scylladb.com/v1alpha1)
        • ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)
    • Feature gates
    • IPv6 configuration reference
    • Releases
    • Known issues
    • Conditions reference
    • nodetool alternatives
  • Contributing to ScyllaDB Operator
Docs Tutorials University Contact Us About Us
© 2026, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 22 May 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.2