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
Ask AI
ScyllaDB Docs ScyllaDB Operator Resources Overview

Caution

You're viewing documentation for an unstable version of ScyllaDB Operator. Switch to the latest stable version.

Overview¶

There are generally 2 types of resources in Kubernetes: namespaced and cluster-scoped resources.

Tip

You can discover the available resources (for the installed version in your cluster) by running

kubectl api-resources --api-group=scylla.scylladb.com

and explore their schema using

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

Namespaced resources¶

ScyllaClusters

ScyllaCluster defines a single datacenter ScyllaDB cluster and manages the racks within.

Learn more »

ScyllaDBClusters

ScyllaDBCluster defines a multi datacenter ScyllaDB cluster spanned across multiple Kubernetes clusters and manages the datacenters and racks within.

Learn more »

ScyllaDBMonitorings

ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack.

Learn more »

Cluster scoped resources¶

Cluster scoped resources declare the state for the whole cluster or control something at the cluster level which isn’t multitenant. Therefore, working with these resources requires elevated privileges.

Generally, there can be multiple instances of these resources but for some of them, like for ScyllaOperatorConfigs, it only makes sense to have one instance. We call them singletons and the single instance is named cluster.

NodeConfigs

NodeConfig manages setup and tuning for a set of Kubernetes nodes.

Learn more »

ScyllaOperatorConfigs

ScyllaOperatorConfig configures the ScyllaDB Operator deployment and reports the status.

Learn more »

RemoteKubernetesClusters

RemoteKubernetesCluster configures the access for ScyllaDB Operator to remotely deployed Kubernetes clusters.

Learn more »

Was this page helpful?

PREVIOUS
Resources
NEXT
ScyllaClusters
  • Create an issue
  • Edit this page

On this page

  • Overview
    • Namespaced resources
    • Cluster scoped resources
ScyllaDB Operator
  • v1.20
    • v1.20
    • v1.19
    • v1.18
    • v1.17
    • master
  • Architecture
    • Overview
    • Storage
      • Overview
      • Local CSI Driver
    • Tuning
    • ScyllaDB Manager
  • Installation
    • Overview
    • Kubernetes prerequisites
    • GitOps (kubectl)
    • Helm
  • Management
    • Configuring kernel parameters (sysctls)
    • Synchronising bootstrap operations in ScyllaDB clusters
    • Automatic data cleanup
    • Upgrading
      • Upgrading ScyllaDB Operator
      • Upgrading ScyllaDB clusters
    • Monitoring
      • ScyllaDB Monitoring overview
      • Setting up ScyllaDB Monitoring
      • Exposing Grafana
      • Setting up ScyllaDB Monitoring on OpenShift
    • Networking
      • IPv6 networking
        • Getting started with IPv6 networking
        • Configure dual-stack networking with IPv4
        • Configure dual-stack networking with IPv6
        • Configure IPv6-only networking
        • Migrate clusters to IPv6
        • Troubleshoot IPv6 networking issues
        • IPv6 configuration reference
        • IPv6 networking concepts
  • Resources
    • Overview
    • ScyllaClusters
      • ScyllaClusters
      • ScyllaDB clients
        • Discovering ScyllaDB Nodes
        • Using CQL
        • Using Alternator (DynamoDB)
      • Node operations using Scylla Operator
        • Upgrading version of ScyllaDB
        • Replacing a ScyllaDB node
        • Automatic cleanup and replacement in case when k8s node is lost
        • Maintenance mode
        • Restore from backup
        • Resizing storage in ScyllaCluster
      • 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
    • 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
  • 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
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 11 February 2026.
Powered by Sphinx 8.2.3 & ScyllaDB Theme 1.8.10
Ask AI