Install on OpenShift¶

This procedure follows the generic Operator installation steps outlined in the upstream documentation: Installing from the software catalog by using the web console.

Procedure

1. Navigate to Ecosystem → Software Catalog.

2. Search for ScyllaDB Operator and select the Certified version by setting the Source filter to Certified, or by verifying that the ScyllaDB Operator tile has the Certified tag.

3. Read the description and click Install.

4. In the Install Operator dialog, configure the installation:

   • For clusters on AWS with Security Token Service (STS): enter the Amazon Resource Name (ARN) of the AWS IAM role for your service account in the role ARN field.

   • Select the stable Update Channel.

   • Select the All namespaces on the cluster installation mode.

   • Select the Operator recommended installed namespace: scylla-operator.

   • Select the Manual update approval strategy to manually approve ScyllaDB Operator upgrades when new versions are available.

   Caution

   Always review the Upgrade ScyllaDB Operator guide before approving a new version.

5. Click Install.

6. In the Install Plan dialog, review the manual install plan and click Approve.

7. Log in to the OpenShift cluster in the terminal. Ensure that kubectl is configured to communicate with your cluster.

This procedure follows the generic Operator installation steps outlined in the upstream documentation: Installing from the software catalog by using the CLI.

Procedure

1. Log in to the OpenShift cluster in the terminal. Ensure that kubectl is configured to communicate with your cluster.

2. Verify that the ScyllaDB Operator package is available:

   kubectl get -n=openshift-marketplace packagemanifest scylladb-operator
   

   Expected output:

   NAME                CATALOG               AGE
   scylladb-operator   Certified Operators   2d22h
   

3. Create the scylla-operator namespace:

   kubectl create namespace scylla-operator
   

4. Create an OperatorGroup in the scylla-operator namespace:

   kubectl apply --server-side -n=scylla-operator -f=- <<EOF
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: scylladb-operator
     namespace: scylla-operator
   EOF
   

5. Create a Subscription to install ScyllaDB Operator.

   Clusters on cloud providers with token-based authentication require additional fields in the Subscription config section. Apply the appropriate manifest based on your environment:

   AWS STSGeneric

   If the cluster uses AWS Security Token Service (STS), include the role ARN in the Subscription manifest:

   kubectl apply --server-side -n=scylla-operator -f=- <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: scylladb-operator
     namespace: scylla-operator
   spec:
     channel: stable
     installPlanApproval: Manual
     name: scylladb-operator
     source: certified-operators
     sourceNamespace: openshift-marketplace
     startingCSV: scylladb-operator.v1.21.0
     config:
       env:
       - name: ROLEARN
         value: "<role_arn>"
   EOF
   

   Replace <role_arn> with the ARN of the AWS IAM role for your service account.

6. Locate, review, and approve the generated InstallPlan:

   kubectl -n=scylla-operator get installplan -l=operators.coreos.com/scylladb-operator.scylla-operator=""
   

   Example expected output:

   NAME            CSV                                    APPROVAL   APPROVED
   install-tw6bv   scylladb-operator.v1.21.0   Manual     false
   

   Review the InstallPlan:

   kubectl -n=scylla-operator describe installplan <install-plan-name>
   

   Approve it to start the installation:

   kubectl -n=scylla-operator patch installplan --type=merge -p='{"spec":{"approved":true}}' <install-plan-name>
   

   Example expected output:

   installplan.operators.coreos.com/install-tw6bv patched
   

7. Wait for the ClusterServiceVersion to reach Succeeded phase:

   kubectl -n=scylla-operator wait --for=create --timeout=10m csv/scylladb-operator.v1.21.0
   kubectl -n=scylla-operator wait --timeout=5m --for=jsonpath='{.status.phase}'=Succeeded clusterserviceversions.operators.coreos.com/scylladb-operator.v1.21.0
   

   Expected output:

   clusterserviceversion.operators.coreos.com/scylladb-operator.v1.21.0 condition met
   clusterserviceversion.operators.coreos.com/scylladb-operator.v1.21.0 condition met