# ScyllaDB Operator > ScyllaDB Operator documentation 2026, ScyllaDB. All rights reserved. ## Pages - [NOTE](https://operator.docs.scylladb.com/v1.20/index.md):
- [Reference](https://operator.docs.scylladb.com/v1.20/reference/index.md): * [API Reference](https://operator.docs.scylladb.com/v1.20/reference/api/index.md) - [Installation](https://operator.docs.scylladb.com/v1.20/installation/index.md): * [Overview](https://operator.docs.scylladb.com/v1.20/installation/overview.md) - [Quickstarts](https://operator.docs.scylladb.com/v1.20/quickstarts/index.md): * [Deploying ScyllaDB on GKE](https://operator.docs.scylladb.com/v1.20/quickstarts/gke.md) - [Management](https://operator.docs.scylladb.com/v1.20/management/index.md): * [Configuring kernel parameters (sysctls)](https://operator.docs.scylladb.com/v1.20/management/sysc... - [Support](https://operator.docs.scylladb.com/v1.20/support/index.md): * [Support overview](https://operator.docs.scylladb.com/v1.20/support/overview.md) - [Resources](https://operator.docs.scylladb.com/v1.20/resources/index.md): * [Overview](https://operator.docs.scylladb.com/v1.20/resources/overview.md) - [Architecture](https://operator.docs.scylladb.com/v1.20/architecture/index.md): * [Overview](https://operator.docs.scylladb.com/v1.20/architecture/overview.md) - [API Reference](https://operator.docs.scylladb.com/v1.20/reference/api/index.md): All APIs provided by Scylla Operator are defined using CRDs and adhere to Kubernetes API standards. ... - [Networking](https://operator.docs.scylladb.com/v1.20/management/networking/index.md): This section covers networking configuration for ScyllaDB clusters. - [Monitoring](https://operator.docs.scylladb.com/v1.20/management/monitoring/index.md): * [ScyllaDB Monitoring overview](https://operator.docs.scylladb.com/v1.20/management/monitoring/over... - [Upgrading](https://operator.docs.scylladb.com/v1.20/management/upgrading/index.md): * [Upgrading ScyllaDB Operator](https://operator.docs.scylladb.com/v1.20/management/upgrading/upgrad... - [IPv6 networking](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/index.md): IPv6 networking support enables you to run ScyllaDB clusters on IPv6 networks, with options for IPv6... - [Troubleshooting](https://operator.docs.scylladb.com/v1.20/support/troubleshooting/index.md): * [Troubleshooting installation issues](https://operator.docs.scylladb.com/v1.20/support/troubleshoo... - [ScyllaDBClusters](https://operator.docs.scylladb.com/v1.20/resources/scylladbclusters/index.md): * [ScyllaDBClusters](https://operator.docs.scylladb.com/v1.20/resources/scylladbclusters/scylladbclu... - [ScyllaClusters](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/index.md): * [ScyllaClusters](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/basics.md) - [Deploying multi-datacenter ScyllaDB clusters in Kubernetes](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/multidc/index.md): Prepare a platform for a multi datacenter ScyllaDB cluster deployment: - [Node operations using Scylla Operator](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/index.md): * [Upgrading version of ScyllaDB](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/... - [ScyllaDB clients](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/clients/index.md): * [Discovering ScyllaDB Nodes](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/cli... - [Storage](https://operator.docs.scylladb.com/v1.20/architecture/storage/index.md): * [Overview](https://operator.docs.scylladb.com/v1.20/architecture/storage/overview.md) - [Using Alternator (DynamoDB)](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/clients/alternator.md): Alternator is a DynamoDB compatible API provided by ScyllaDB. - [Automatic cleanup and replacement in case when k8s node is lost](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/automatic-cleanup.md): In case when your k8s cluster loses one of the nodes due to incident or explicit removal, ScyllaDB P... - [ScyllaClusters](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/basics.md): [ScyllaCluster](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/sc... - [Bootstrap-Sync-Min-Scylladb-Version-Caution](https://operator.docs.scylladb.com/v1.20/.internal/bootstrap-sync-min-scylladb-version-caution.md): Page content - [Synchronising bootstrap operations in ScyllaDB clusters](https://operator.docs.scylladb.com/v1.20/management/bootstrap-sync.md): This document explains the automated bootstrap synchronisation in ScyllaDB Operator. - [Using CQL](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/clients/cql.md): `cqlsh` is the CQL shell for ScyllaDB. You can learn more about it in [ScyllaDB documentation](https... - [Automatic data cleanup](https://operator.docs.scylladb.com/v1.20/management/data-cleanup.md): This document explains the automatic data cleanup feature in ScyllaDB Operator. - [Discovering ScyllaDB Nodes](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/clients/discovery.md): Outside the Kubernetes ecosystem, ScyllaDB nodes are usually set up on static IP addresses - [Deploying ScyllaDB on EKS](https://operator.docs.scylladb.com/v1.20/quickstarts/eks.md): This is a quickstart guide to help you set up a basic EKS cluster quickly with local NVMes and solid... - [Build multiple Amazon EKS clusters with inter-Kubernetes networking](https://operator.docs.scylladb.com/v1.20/resources/common/multidc/eks.md): This document describes the process of creating multiple Amazon EKS clusters in different regions, u... - [Exposing Grafana](https://operator.docs.scylladb.com/v1.20/management/monitoring/exposing-grafana.md): This guide shows how to expose Grafana deployed by `ScyllaDBMonitoring` using an `Ingress` resource. - [Exposing ScyllaDB cluster](https://operator.docs.scylladb.com/v1.20/resources/common/exposing.md): This document explains how ScyllaDB Operator exposes ScyllaDB clusters in different network setups. - [Setting up ScyllaDB Monitoring on OpenShift](https://operator.docs.scylladb.com/v1.20/management/monitoring/external-prometheus-on-openshift.md): This guide will walk you through setting up a monitoring stack for your ScyllaDB clusters using the - [Feature Gates](https://operator.docs.scylladb.com/v1.20/reference/feature-gates.md): ScyllaDB Operator lets you enable or disable features using feature gates. This document provides an... - [GitOps (kubectl)](https://operator.docs.scylladb.com/v1.20/installation/gitops.md): The following commands reference manifests that come from the same repository as the source code is ... - [Gke-1-32-Xfsprogs](https://operator.docs.scylladb.com/v1.20/.internal/gke-1-32-xfsprogs.md): Beginning with GKE version `1.32.1-gke.1002000`, the Ubuntu image used by GKE clusters no longer pro... - [Deploying ScyllaDB on GKE](https://operator.docs.scylladb.com/v1.20/quickstarts/gke.md): This is a quickstart guide to help you set up a basic GKE cluster quickly with local NVMes and solid... - [Build multiple GKE clusters with inter-Kubernetes networking](https://operator.docs.scylladb.com/v1.20/resources/common/multidc/gke.md): This document describes the process of creating multiple GKE clusters in a shared VPC and explains t... - [WARNING](https://operator.docs.scylladb.com/v1.20/.internal/helm-crd-warning.md): Helm doesn’t support managing CustomResourceDefinition resources ([#5871](https://github.com/helm/he... - [Helm](https://operator.docs.scylladb.com/v1.20/installation/helm.md): Helm doesn’t support managing CustomResourceDefinition resources ([#5871](https://github.com/helm/he... - [Troubleshooting installation issues](https://operator.docs.scylladb.com/v1.20/support/troubleshooting/installation.md): ScyllaDB Operator provides several custom API resources that use webhooks to function properly. - [IPv6 configuration reference](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/reference/ipv6-configuration.md): This reference documents IPv6-specific configuration guidance for ScyllaDB clusters. - [Configure dual-stack networking with IPv6](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/how-to/ipv6-configure-ipv6-first.md): **What you’ll achieve**: Deploy a ScyllaDB cluster that uses IPv6 for ScyllaDB communication and pro... - [Configure IPv6-only networking](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/how-to/ipv6-configure-ipv6-only.md): **What you’ll achieve**: Deploy a ScyllaDB cluster that uses only IPv6 for all communication. - [Configure dual-stack networking with IPv4](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/how-to/ipv6-configure.md): **What you’ll achieve**: Deploy a ScyllaDB cluster that uses IPv4 for ScyllaDB communication and pro... - [Getting started with IPv6 networking](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/tutorials/ipv6-getting-started.md): This tutorial teaches you how to deploy your first ScyllaDB cluster with IPv6 networking. You’ll lea... - [Migrate clusters to IPv6](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/how-to/ipv6-migrate.md): This guide shows you how to migrate existing ScyllaDB clusters to IPv6 networking. - [IPv6 networking concepts](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/concepts/ipv6-networking.md): This document explains how IPv6 networking works in ScyllaDB clusters, including the design decision... - [Troubleshoot IPv6 networking issues](https://operator.docs.scylladb.com/v1.20/management/networking/ipv6/how-to/ipv6-troubleshoot.md): This guide helps you diagnose and resolve common IPv6 networking issues in ScyllaDB clusters. - [Known issues](https://operator.docs.scylladb.com/v1.20/support/known-issues.md): If your ScyllaDB Manager is failing to apply 8th migration (008_\*), then apply fix for [TRUNCATE qu... - [Kubernetes prerequisites](https://operator.docs.scylladb.com/v1.20/installation/kubernetes-prerequisites.md): Because ScyllaDB Operator aims to leverage the best performance available, there are a few extra ste... - [Local CSI Driver](https://operator.docs.scylladb.com/v1.20/architecture/storage/local-csi-driver.md): The Local CSI Driver implements the [Container Storage Interface (CSI)](https://kubernetes.io/blog/2... - [Maintenance mode](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/maintenance-mode.md): When maintenance mode is enabled, readiness probe of ScyllaDB Pod will always return failure and liv... - [NOTE](https://operator.docs.scylladb.com/v1.20/.internal/manager-license-note.md): ScyllaDB Manager is available for ScyllaDB Enterprise customers and ScyllaDB Open Source users. - [ScyllaDB Manager](https://operator.docs.scylladb.com/v1.20/architecture/manager.md): ScyllaDB Operator has a basic integration with ScyllaDB Manager. At this point there is one global S... - [Deploy a multi-datacenter ScyllaDB cluster in multiple interconnected Kubernetes clusters](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/multidc/multidc.md): This document describes the process of deploying a Multi Datacenter ScyllaDB cluster in multiple int... - [Gathering data with must-gather](https://operator.docs.scylladb.com/v1.20/support/must-gather.md): `must-gather` is an embedded tool in ScyllaDB Operator that helps collecting all the necessary info ... - [NOTE](https://operator.docs.scylladb.com/v1.20/.internal/namespaces.md): You can run your ScyllaDB cluster in the Kubernetes **namespace of your choice** (you can change the... - [NOTE](https://operator.docs.scylladb.com/v1.20/.internal/node-tuning.note.md): Performance tuning is enabled for all nodes that are selected by `NodeConfig` by default, unless exp... - [NodeConfigs](https://operator.docs.scylladb.com/v1.20/resources/nodeconfigs.md): NodeConfig is an API object that helps you set up and tune the nodes. - [NodeConfig (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/nodeconfigs.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [Install ScyllaDB Operator in Red Hat OpenShift](https://operator.docs.scylladb.com/v1.20/installation/openshift.md): ScyllaDB Operator is a Red Hat OpenShift Certified Operator available for installation through the e... - [WARNING](https://operator.docs.scylladb.com/v1.20/.internal/operator-namespace.warning.md): ScyllaDB Operator must run in a reserved `scylla-operator` namespace. [It is not currently possible]... - [Overview](https://operator.docs.scylladb.com/v1.20/installation/overview.md): ScyllaDB Operator is a set of controllers and Kubernetes API extensions. - [Support overview](https://operator.docs.scylladb.com/v1.20/support/overview.md): ScyllaDB provides administrators with [paid support](https://www.scylladb.com/product/support/#enter... - [Overview](https://operator.docs.scylladb.com/v1.20/resources/overview.md): There are generally 2 types of resources in Kubernetes: [namespaced]() and [cluster-scoped]() resour... - [Overview](https://operator.docs.scylladb.com/v1.20/architecture/overview.md): ScyllaDB Operator is a set of controllers and API extensions that need to be installed in your clust... - [ScyllaDB Monitoring overview](https://operator.docs.scylladb.com/v1.20/management/monitoring/overview.md): ScyllaDB [exposes](https://monitoring.docs.scylladb.com/stable/reference/monitoring-apis.html) its m... - [Overview](https://operator.docs.scylladb.com/v1.20/architecture/storage/overview.md): ScyllaDB works with both local and network attached storage provisioners, but our primary focus is a... - [Releases](https://operator.docs.scylladb.com/v1.20/support/releases.md): We are aiming to ship a new release approximately every 2 months. The following release schedule is ... - [RemoteKubernetesCluster](https://operator.docs.scylladb.com/v1.20/resources/remotekubernetesclusters.md): The cluster-scoped `RemoteKubernetesCluster` resource provides an abstraction layer for managing res... - [RemoteKubernetesCluster (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/remotekubernetesclusters.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [RemoteOwner (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/remoteowners.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [Replacing a ScyllaDB node](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/replace-node.md): In the case of a host failure, it may not be possible to bring back the node to life. - [Restore from backup](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/restore.md): This procedure will describe how to restore from backup taken using [ScyllaDB Manager](https://opera... - [WARNING](https://operator.docs.scylladb.com/v1.20/.internal/rf-warning.md): To ensure high availability and fault tolerance in ScyllaDB, it is crucial to **spread your nodes ac... - [Upgrading version of ScyllaDB](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/scylla-upgrade.md): **Review Release Notes Before Upgrading** - [scylla.scylladb.com](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com.md): * [NodeConfig (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api... - [ScyllaCluster (scylla.scylladb.com/v1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scyllaclusters.md): **APIVersion**: scylla.scylladb.com/v1 - [Scylladbcluster-Cluster-Ip-Exposure-Caution](https://operator.docs.scylladb.com/v1.20/.internal/scylladbcluster-cluster-ip-exposure-caution.md): Page content - [ScyllaDBCluster (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbclusters.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaDBClusters](https://operator.docs.scylladb.com/v1.20/resources/scylladbclusters/scylladbclusters.md): The [ScyllaDBCluster](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.... - [ScyllaDBDatacenterNodesStatusReport (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbdatacenternodesstatusreports.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaDBDatacenter (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbdatacenters.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaDBManagerClusterRegistration (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbmanagerclusterregistrations.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaDBManagerTask (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbmanagertasks.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaDBMonitoring (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scylladbmonitorings.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [ScyllaOperatorConfigs](https://operator.docs.scylladb.com/v1.20/resources/scyllaoperatorconfigs.md): [ScyllaOperatorConfig](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb... - [ScyllaOperatorConfig (scylla.scylladb.com/v1alpha1)](https://operator.docs.scylladb.com/v1.20/reference/api/groups/scylla.scylladb.com/scyllaoperatorconfigs.md): **APIVersion**: scylla.scylladb.com/v1alpha1 - [Setting up ScyllaDB Monitoring](https://operator.docs.scylladb.com/v1.20/management/monitoring/setup.md): This guide will walk you through setting up a complete monitoring stack for your ScyllaDB clusters u... - [Configuring kernel parameters (sysctls)](https://operator.docs.scylladb.com/v1.20/management/sysctls.md): This guide explains how to configure Linux kernel parameters (sysctls) for nodes running production-... - [Tuning-Qos-Caution](https://operator.docs.scylladb.com/v1.20/.internal/tuning-qos-caution.md): Page content - [WARNING](https://operator.docs.scylladb.com/v1.20/.internal/tuning-warning.md): We recommend that you first try out the performance tuning on a pre-production instance. - [Tuning](https://operator.docs.scylladb.com/v1.20/architecture/tuning.md): ScyllaDB works best when it’s pinned to the CPUs and not interrupted. - [Upgrading ScyllaDB clusters](https://operator.docs.scylladb.com/v1.20/management/upgrading/upgrade-scylladb.md): Upgrading your ScyllaDB cluster to a newer version is automated by ScyllaDB Operator and performed u... - [Upgrading ScyllaDB Operator](https://operator.docs.scylladb.com/v1.20/management/upgrading/upgrade.md): ScyllaDB Operator supports N+1 upgrades only. - [Verify-Operator-Installation-Gitops](https://operator.docs.scylladb.com/v1.20/.internal/verify-operator-installation-gitops.md): Wait for CRDs to propagate to all apiservers: - [Resizing storage in ScyllaCluster](https://operator.docs.scylladb.com/v1.20/resources/scyllaclusters/nodeoperations/volume-expansion.md): Let’s use the following ScyllaCluster as an example. - [List all ScyllaDB pods in the cluster.](https://operator.docs.scylladb.com/v1.20/.internal/wait-for-all-nodes-un.md): To verify the cluster state, execute `nodetool status` in each of the ScyllaDB cluster pods: - [Wait-For-Status-Conditions.Nodeconfig.Code-Block](https://operator.docs.scylladb.com/v1.20/.internal/wait-for-status-conditions.nodeconfig.code-block.md): kubectl wait --timeout=10m --for='condition=Progressing=False' nodeconfigs.scylla.scylladb.com/scyll... - [Wait-For-Status-Conditions.Scyllacluster.Code-Block](https://operator.docs.scylladb.com/v1.20/.internal/wait-for-status-conditions.scyllacluster.code-block.md): kubectl wait --for='condition=Progressing=False' scyllacluster.scylla.scylladb.com/scylladb - [Wait-For-Status-Conditions.Scylladbcluster.Code-Block](https://operator.docs.scylladb.com/v1.20/.internal/wait-for-status-conditions.scylladbcluster.code-block.md): kubectl --context=${CONTROL_PLANE_CONTEXT} wait --for='condition=Progressing=False' scylladbcluster.... --- For more comprehensive documentation, see [llms-full.txt](https://operator.docs.scylladb.com/v1.20/llms-full.txt)