docs: upgrade guide from 0.3.0

scylladb · Jan 11, 2021 · c882e6e · c882e6e
1 parent e6b1ddc
commit c882e6e
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,6 +11,7 @@ Scylla Operator Documentation
    gke
    manager
    node_operations
+   upgrade
    scylla_cluster_crd
    contributing
 
@@ -45,6 +46,7 @@ Currently it supports:
 * :doc:`Deploying Scylla on GKE <gke>`
 * :doc:`Deploying Scylla Manager on a Kubernetes Cluster <manager>`
 * :doc:`Node operations <node_operations>`
+* :doc:`Upgrade procedures <upgrade>`
 * :doc:`Scylla Cluster Custom Resource Definition (CRD) <scylla_cluster_crd>`
 * :doc:`Contributing to the Scylla Operator Project <contributing>`
 

diff --git a/docs/source/upgrade.md b/docs/source/upgrade.md
@@ -0,0 +1,50 @@
+# Upgrade of Scylla Operator
+
+This pages describes Scylla Operator upgrade procedures.
+
+## `v0.3.0` -> `v1.0.0`
+
+`v0.3.0` used a very common name as a CRD kind. In `v1.0.0` this issue was solved by using less common kind which is easier to disambiguate.
+This change is backward incompatible, so Scylla cluster must be turned off and recreated from scratch.
+In case you need to preserve your data, refer to backup and restore guide.
+
+1. Get list of existing Scylla clusters
+    ```
+    kubectl -n scylla get cluster.scylla.scylladb.com
+
+    NAME             AGE
+    simple-cluster   30m
+    ```
+1. Delete each one of them
+
+    ```
+    kubectl -n scylla delete cluster.scylla.scylladb.com simple-cluster
+    ```
+1. Make sure you're on `v0.3.0` branch
+    ```
+    git checkout v0.3.0
+    ```
+1. Delete existing CRD and Operator
+    ```
+    kubectl delete -f examples/generic/operator.yaml
+    ```
+1. Checkout `v1.0.0` version
+    ```
+    git checkout v1.0.0
+    ```
+1. Install new CRD and Scylla Operator
+    ```
+    kubectl apply -f examples/common/operator.yaml
+    ```
+1. Migrate your existing Scylla Cluster definition. Change `apiVersion` and `kind` from:
+    ```
+    apiVersion: scylla.scylladb.com/v1alpha1
+    kind: Cluster
+    ```
+   to:
+    ```
+    apiVersion: scylla.scylladb.com/v1
+    kind: ScyllaCluster
+    ```
+1. Once your cluster definition is ready, use `kubectl apply` to install fresh Scylla cluster.
+