From 68f2c4e5d5ea5a986beebc282a42da20d98915bb Mon Sep 17 00:00:00 2001 From: Yannis Zarkadas Date: Tue, 4 Dec 2018 02:18:11 +0200 Subject: [PATCH] cassandra: documentation for scale down action Signed-off-by: Yannis Zarkadas --- Documentation/cassandra-cluster-crd.md | 6 +++++ Documentation/cassandra.md | 29 +++++++++++++++++++-- Documentation/ceph-cluster-crd.md | 2 +- Documentation/ceph-filesystem-crd.md | 2 +- Documentation/ceph-object-store-crd.md | 2 +- Documentation/ceph-object-store-user-crd.md | 2 +- Documentation/ceph-pool-crd.md | 2 +- Documentation/quickstart-toc.md | 1 + 8 files changed, 39 insertions(+), 7 deletions(-) diff --git a/Documentation/cassandra-cluster-crd.md b/Documentation/cassandra-cluster-crd.md index f7b60d667..818012ceb 100644 --- a/Documentation/cassandra-cluster-crd.md +++ b/Documentation/cassandra-cluster-crd.md @@ -1,3 +1,9 @@ +--- +title: Cassandra Cluster +weight: 36 +indent: true +--- + # Cassandra Cluster CRD Cassandra database clusters can be created and configuring using the `clusters.cassandra.rook.io` custom resource definition (CRD). diff --git a/Documentation/cassandra.md b/Documentation/cassandra.md index 6fc47ebdd..ef95cc1e2 100644 --- a/Documentation/cassandra.md +++ b/Documentation/cassandra.md @@ -1,4 +1,10 @@ -# Quickstart +--- +title: Cassandra +weight: 7 +indent: true +--- + +# Cassandra Quickstart [Cassandra](http://cassandra.apache.org/) is a highly available, fault tolerant, peer-to-peer NoSQL database featuring lightning fast performance and tunable consistency. It provides massive scalability with no single point of failure. @@ -83,9 +89,28 @@ To get a cqlsh shell in your new Cluster: ## Scale Up -The operator supports scale up of a rack as well as addition of new racks. To make the changes, you can use `kubectl edit clusters.cassandra.rook.io rook-cassandra`: +The operator supports scale up of a rack as well as addition of new racks. To make the changes, you can use: + ```console + kubectl edit clusters.cassandra.rook.io rook-cassandra + ``` * To scale up a rack, change the `Spec.Members` field of the rack to the desired value. * To add a new rack, append the `racks` list with a new rack. Remember to choose a different rack name for the new rack. + * After editing and saving the yaml, check your cluster's Status and Events for information on what's happening: + ```console + kubectl -n rook-cassandra describe clusters.cassandra.rook.io rook-cassandra + ``` + +## Scale Down + +The operator supports scale down of a rack. To make the changes, you can use: + ```console + kubectl edit clusters.cassandra.rook.io rook-cassandra + ``` + * To scale down a rack, change the `Spec.Members` field of the rack to the desired value. + * After editing and saving the yaml, check your cluster's Status and Events for information on what's happening: + ```console + kubectl -n rook-cassandra describe clusters.cassandra.rook.io rook-cassandra + ``` ## Clean Up diff --git a/Documentation/ceph-cluster-crd.md b/Documentation/ceph-cluster-crd.md index e81150997..f2e7b238b 100755 --- a/Documentation/ceph-cluster-crd.md +++ b/Documentation/ceph-cluster-crd.md @@ -1,6 +1,6 @@ --- title: Ceph Cluster -weight: 32 +weight: 31 indent: true --- diff --git a/Documentation/ceph-filesystem-crd.md b/Documentation/ceph-filesystem-crd.md index fef80156a..6735ca2b9 100644 --- a/Documentation/ceph-filesystem-crd.md +++ b/Documentation/ceph-filesystem-crd.md @@ -1,6 +1,6 @@ --- title: Ceph Shared File System -weight: 36 +weight: 35 indent: true --- {% assign url = page.url | split: '/' %} diff --git a/Documentation/ceph-object-store-crd.md b/Documentation/ceph-object-store-crd.md index ac3972956..4f2120af6 100644 --- a/Documentation/ceph-object-store-crd.md +++ b/Documentation/ceph-object-store-crd.md @@ -1,6 +1,6 @@ --- title: Ceph Object Store -weight: 34 +weight: 33 indent: true --- diff --git a/Documentation/ceph-object-store-user-crd.md b/Documentation/ceph-object-store-user-crd.md index 08940eef1..48648c24f 100644 --- a/Documentation/ceph-object-store-user-crd.md +++ b/Documentation/ceph-object-store-user-crd.md @@ -1,6 +1,6 @@ --- title: Ceph Object Store User -weight: 35 +weight: 34 indent: true --- diff --git a/Documentation/ceph-pool-crd.md b/Documentation/ceph-pool-crd.md index f029f10f1..36b39b151 100644 --- a/Documentation/ceph-pool-crd.md +++ b/Documentation/ceph-pool-crd.md @@ -1,6 +1,6 @@ --- title: Ceph Block Pool -weight: 33 +weight: 32 indent: true --- diff --git a/Documentation/quickstart-toc.md b/Documentation/quickstart-toc.md index 5da6bb62a..6e77b226f 100644 --- a/Documentation/quickstart-toc.md +++ b/Documentation/quickstart-toc.md @@ -16,3 +16,4 @@ Rook provides growing number of storage providers to a Kubernetes cluster, each | [CockroachDB](cockroachdb.md) | Alpha | CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters. | | [EdgeFS](edgefs-quickstart.md) | Alpha | EdgeFS is high-performance and low-latency object storage system with Geo-Transparent data access via standard protocols (S3, NFS, iSCSI) from on-prem, private/public clouds or small footprint edge (IoT) devices. | | [Minio](minio-object-store.md) | Alpha | Minio is a high performance distributed object storage server, designed for large-scale private cloud infrastructure. | +| [Cassandra](cassandra.md) | Alpha | Cassandra is a highly available NoSQL database featuring lightning fast performance, tunable consistency and massive scalability.|