GitOps (kubectl) | ScyllaDB Docs

GitOps (kubectl)¶

Disclaimer¶

The following commands reference manifests that come from the same repository as the source code is being built from. This means we can’t have a pinned reference to the latest release as that is a chicken-egg problem. Therefore, we use a rolling tag for the particular branch in our manifests.

Caution

For production deployment, you should always replace the Scylla Operator image in all the manifests that contain it with a stable (full version) reference. We’d encourage you to use a sha reference, although using full-version tags is also fine.

Installation¶

Prerequisites¶

Scylla Operator has a few dependencies that you need to install to your cluster first.

In case you already have a supported version of each of these dependencies installed in your cluster, you can skip this part.

Cert Manager¶

kubectl apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/third-party/cert-manager.yaml

# Wait for CRDs to propagate to all apiservers.
kubectl wait --for condition=established --timeout=60s crd/certificates.cert-manager.io crd/issuers.cert-manager.io

# Wait for components that other steps depend on.
for deploy in cert-manager{,-cainjector,-webhook}; do
    kubectl -n=cert-manager rollout status --timeout=10m deployment.apps/"${deploy}"
done

# Wait for webhook CA secret to be created.
for i in {1..30}; do
    { kubectl -n=cert-manager get secret/cert-manager-webhook-ca && break; } || sleep 1
done

Prometheus Operator¶

kubectl -n=prometheus-operator apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/third-party/prometheus-operator.yaml

# Wait for CRDs to propagate to all apiservers.
kubectl wait --for='condition=established' crd/prometheuses.monitoring.coreos.com crd/prometheusrules.monitoring.coreos.com crd/servicemonitors.monitoring.coreos.com

# Wait for prometheus operator deployment.
kubectl -n=prometheus-operator rollout status --timeout=10m deployment.apps/prometheus-operator

# Wait for webhook CA secret to be created.
for i in {1..30}; do
    { kubectl -n=cert-manager get secret/cert-manager-webhook-ca && break; } || sleep 1
done

Scylla Operator¶

Once you have the dependencies installed and available in your cluster, it is the time to install Scylla Operator.

kubectl -n=scylla-operator apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/deploy/operator.yaml

Caution

Scylla Operator deployment references its own image that it later runs alongside each ScyllaDB instance. Therefore, you have to also replace the image in the environment variable called SCYLLA_OPERATOR_IMAGE:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: scylla-operator
  namespace: scylla-operator
# ...
spec:
  # ...
  template:
    # ...
    spec:
      # ...
      containers:
      - name: scylla-operator
        # ...
        image: docker.io/scylladb/scylla-operator:1.14.0@sha256:8c75c5780e2283f0a8f9734925352716f37e0e7f41007e50ce9b1d9924046fa1
        env:
          # ...
        - name: SCYLLA_OPERATOR_IMAGE
          value: docker.io/scylladb/scylla-operator:1.14.0@sha256:8c75c5780e2283f0a8f9734925352716f37e0e7f41007e50ce9b1d9924046fa1

The Scylla Operator image value and the SCYLLA_OPERATOR_IMAGE shall always match. Be careful not to use a rolling tag for any of them to avoid an accidental skew!

# Wait for CRDs to propagate to all apiservers.
kubectl wait --for='condition=established' crd/scyllaclusters.scylla.scylladb.com crd/nodeconfigs.scylla.scylladb.com crd/scyllaoperatorconfigs.scylla.scylladb.com crd/scylladbmonitorings.scylla.scylladb.com

# Wait for the components to deploy.
kubectl -n=scylla-operator rollout status --timeout=10m deployment.apps/{scylla-operator,webhook-server}

# Wait for webhook CA secret to be created.
for i in {1..30}; do
    { kubectl -n=cert-manager get secret/cert-manager-webhook-ca && break; } || sleep 1
done

Setting up local storage on nodes and enabling tuning¶

Caution

The following step heavily depends on the platform that you use, the machine type, or the options chosen when creating a node pool.

Please review the NodeConfig and adjust it for your platform!

GKE (NVMe)

kubectl -n=scylla-operator apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/gke/nodeconfig-alpha.yaml

EKS (NVMe)

kubectl -n=scylla-operator apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/eks/nodeconfig-alpha.yaml

Any platform (Loop devices)

Caution

This NodeConfig sets up loop devices instead of NVMe disks and is only intended for development purposes when you don’t have the NVMe disks available. Do not expect meaningful performance with this setup.

kubectl -n=scylla-operator apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/generic/nodeconfig-alpha.yaml

Note

Performance tuning is enabled for all nodes that are selected by NodeConfig by default, unless opted-out.

# Wait for NodeConfig to apply changes to the Kubernetes nodes.
kubectl wait --for='condition=Reconciled' --timeout=10m nodeconfigs.scylla.scylladb.com/scylladb-nodepool-1

Local CSI driver¶

kubectl -n=local-csi-driver apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/examples/common/local-volume-provisioner/local-csi-driver/{00_namespace,00_scylladb-local-xfs.storageclass,10_csidriver,10_driver.serviceaccount,10_provisioner_clusterrole,20_provisioner_clusterrolebinding,50_daemonset}.yaml

# Wait for it to deploy.
kubectl -n=local-csi-driver rollout status --timeout=10m daemonset.apps/local-csi-driver

ScyllaDB Manager¶

Note

ScyllaDB Manager is available for ScyllaDB Enterprise customers and ScyllaDB Open Source users. With ScyllaDB Open Source, ScyllaDB Manager is limited to 5 nodes. See the ScyllaDB Manager Proprietary Software License Agreement for details.

Production (sized)

kubectl -n=scylla-manager apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/deploy/manager-prod.yaml

Development (sized)

kubectl -n=scylla-manager apply --server-side -f=https://raw.githubusercontent.com/scylladb/scylla-operator/master/deploy/manager-dev.yaml

# Wait for it to deploy.
kubectl -n=scylla-manager rollout status --timeout=10m deployment.apps/scylla-manager

Next steps¶

Now that you’ve successfully installed Scylla Operator, it’s time to look at how to run ScyllaDB.

Was this page helpful?