Skip to content

docs: separate $-prompt commands from their output in bash code blocks #998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArnobKumarSaha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: separate $-prompt commands from their output in bash code blocks #998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
52 changes: 28 additions & 24 deletions docs/guides/cassandra/autoscaler/compute/compute-autoscale.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ This guide will show you how to use `KubeDB` to autoscaling compute resources i.
To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial.

```bash
$ kubectl create ns demo
namespace/demo created
kubectl create ns demo
```
namespace/demo created

> **Note:** YAML files used in this tutorial are stored in [docs/examples/cassandra](/docs/examples/cassandra) directory of [kubedb/docs](https://github.com/kubedb/docs) repository.

Expand Down Expand Up @@ -78,22 +78,23 @@ spec:
Let's create the `Cassandra` CRO we have shown above,

```bash
$ kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/compute/cassandra-autoscale.yaml
cassandra.kubedb.com/cassandra-autoscale created
kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/compute/cassandra-autoscale.yaml
```
cassandra.kubedb.com/cassandra-autoscale created

Now, wait until `cassandra-autoscale` has status `Ready`. i.e,

```bash
$ kubectl get cas -n demo
kubectl get cas -n demo
```
NAME TYPE VERSION STATUS AGE
cassandra-autoscale kubedb.com/v1alpha2 5.0.3 Ready 22s
```

Let's check the Pod containers resources,

```bash
$ kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.containers[].resources'
kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.containers[].resources'
```
{
"limits": {
"cpu": "1",
Expand All @@ -104,11 +105,11 @@ $ kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.cont
"memory": "600Mi"
}
}
```

Let's check the Cassandra resources,
```bash
$ kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topology.rack[0].podTemplate.spec.containers[0].resources'
kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topology.rack[0].podTemplate.spec.containers[0].resources'
```
{
"limits": {
"cpu": "1",
Expand All @@ -119,7 +120,6 @@ $ kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topology
"memory": "600Mi"
}
}
```

You can see from the above outputs that the resources are same as the one we have assigned while deploying the cassandra.

Expand Down Expand Up @@ -173,20 +173,23 @@ Here,
Let's create the `CassandraAutoscaler` CR we have shown above,

```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/compute/cassandra-autoscaler-ops.yaml
cassandraautoscaler.autoscaling.kubedb.com/cassandra-autoscaler-ops created
kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/compute/cassandra-autoscaler-ops.yaml
```
cassandraautoscaler.autoscaling.kubedb.com/cassandra-autoscaler-ops created

#### Verify Autoscaling is set up successfully

Let's check that the `cassandraautoscaler` resource is created successfully,

```bash
$ kubectl get cassandraautoscaler -n demo
kubectl get cassandraautoscaler -n demo
```
NAME AGE
cassandra-autoscale-ops 6m55s

$ kubectl describe cassandraautoscaler cassandra-autoscale-ops -n demo
```bash
kubectl describe cassandraautoscaler cassandra-autoscale-ops -n demo
```
Name: cassandra-autoscale-ops
Namespace: demo
Labels: <none>
Expand Down Expand Up @@ -276,33 +279,33 @@ Status:
Memory: 3Gi
Vpa Name: cassandra-autoscale-rack-r0
Events: <none>
```
So, the `Cassandraautoscaler` resource is created successfully.

you can see in the `Status.VPAs.Recommendation` section, that recommendation has been generated for our Cassandra. Our autoscaler operator continuously watches the recommendation generated and creates an `cassandraopsrequest` based on the recommendations, if the cassandra pods are needed to scaled up or down.

Let's watch the `cassandraopsrequest` in the demo namespace to see if any `cassandraopsrequest` object is created. After some time you'll see that a `cassandraopsrequest` will be created based on the recommendation.

```bash
$ watch kubectl get cassandraopsrequest -n demo
watch kubectl get cassandraopsrequest -n demo
```
Every 2.0s: kubectl get cassandraopsrequest -n demo
NAME TYPE STATUS AGE
casops-cassandra-autoscale-rack-r0-kefyuq VerticalScaling Progressing 1m28s
```

Let's wait for the ops request to become successful.

```bash
$ watch kubectl get cassandraopsrequest -n demo
watch kubectl get cassandraopsrequest -n demo
```
Every 2.0s: kubectl get cassandraopsrequest -n demo
NAME TYPE STATUS AGE
casops-cassandra-autoscale-rack-r0-kefyuq VerticalScaling Successful 3m34s
```

We can see from the above output that the `CassandraOpsRequest` has succeeded. If we describe the `CassandraOpsRequest` we will get an overview of the steps that were followed to scale the Cassandra.

```bash
$ kubectl describe cassandraopsrequest -n demo casops-cassandra-autoscale-rack-r0-kefyuq
kubectl describe cassandraopsrequest -n demo casops-cassandra-autoscale-rack-r0-kefyuq
```
Name: casops-cassandra-autoscale-rack-r0-kefyuq
Namespace: demo
Labels: app.kubernetes.io/component=database
Expand Down Expand Up @@ -410,12 +413,12 @@ Events:
Normal RestartPods 89s KubeDB Ops-manager Operator Successfully Restarted Pods With Resources
Normal Starting 89s KubeDB Ops-manager Operator Resuming Cassandra database: demo/cassandra-autoscale
Normal Successful 89s KubeDB Ops-manager Operator Successfully resumed Cassandra database: demo/cassandra-autoscale for CassandraOpsRequest: casops-cassandra-autoscale-rack-r0-kefyuq
```

Now, we are going to verify from the Pod, and the Cassandra yaml whether the resources of the Cassandra has updated to meet up the desired state, Let's check,

```bash
$ kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.containers[].resources'
kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.containers[].resources'
```
{
"limits": {
"cpu": "1600m",
Expand All @@ -427,7 +430,9 @@ $ kubectl get pod -n demo cassandra-autoscale-rack-r0-0 -o json | jq '.spec.con
}
}

$ kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topology.rack[0].podTemplate.spec.containers[0].resources'
```bash
kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topology.rack[0].podTemplate.spec.containers[0].resources'
```
{
"limits": {
"cpu": "1",
Expand All @@ -438,7 +443,6 @@ $ kubectl get cassandra -n demo cassandra-autoscale -o json | jq '.spec.topolog
"memory": "600Mi"
}
}
```

The above output verifies that we have successfully auto-scaled the resources of the cassandra.

Expand Down
58 changes: 31 additions & 27 deletions docs/guides/cassandra/autoscaler/storage/storage-autoscale.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ This guide will show you how to use `KubeDB` to autoscale the storage of a Cassa
To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial.

```bash
$ kubectl create ns demo
namespace/demo created
kubectl create ns demo
```
namespace/demo created

## Storage Autoscaling of Cluster Database

At first verify that your cluster has a storage class, that supports volume expansion. Let's check,

```bash
$ kubectl get storageclass
kubectl get storageclass
```
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
local-path (default) rancher.io/local-path Delete WaitForFirstConsumer false 6h2m
longhorn (default) driver.longhorn.io Delete Immediate true 9m41s
longhorn-static driver.longhorn.io Delete Immediate true 9m24s
```

We can see from the output the `longhorn` storage class has `ALLOWVOLUMEEXPANSION` field as true. So, this storage class supports volume expansion. We can use it.

Expand Down Expand Up @@ -103,34 +103,35 @@ spec:
Let's create the `Cassandra` CRO we have shown above,

```bash
$ kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/storage/cassandra-autoscale.yaml
cassandra.kubedb.com/cassandra-autoscale created
kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/storage/cassandra-autoscale.yaml
```
cassandra.kubedb.com/cassandra-autoscale created

Now, wait until `cassandra-autoscale` has status `Ready`. i.e,

```bash
$ kubectl get cassandra -n demo
kubectl get cassandra -n demo
```
NAME TYPE VERSION STATUS AGE
cassandra-autoscale kubedb.com/v1alpha2 5.0.3 Ready 16m
```

Let's check volume size from petset, and from the persistent volume,

```bash
$ kubectl get petset -n demo cassandra-autoscale-rack-r0 -o json | jq '.spec.volumeClaimTemplates[0].spec.resources.requests.storage'
kubectl get petset -n demo cassandra-autoscale-rack-r0 -o json | jq '.spec.volumeClaimTemplates[0].spec.resources.requests.storage'
```
"600Mi"


$ kubectl get pv -n demo
```bash
kubectl get pv -n demo
```
NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS VOLUMEATTRIBUTESCLASS REASON AGE
pvc-394fefad-d4ad-4dfa-ba11-df96e015da30 600Mi RWO Delete Bound demo/cassandra-autoscale-main-config-volume-cassandra-autoscale-rack-r0-1 longhorn <unset> 21m
pvc-86ece3c8-520a-4d41-834e-66108867ca36 600Mi RWO Delete Bound demo/cassandra-autoscale-data-cassandra-autoscale-rack-r0-1 longhorn <unset> 21m
pvc-c35bb138-9f13-4098-b2b0-cc151f013f6d 600Mi RWO Delete Bound demo/cassandra-autoscale-main-config-volume-cassandra-autoscale-rack-r0-0 longhorn <unset> 21m
pvc-cc932132-de53-425f-bd31-91af255a47e8 600Mi RWO Delete Bound demo/cassandra-autoscale-data-cassandra-autoscale-rack-r0-0 longhorn <unset> 21m
pvc-cd57fb5f-b2f3-48de-b9d2-03059b05113f 600Mi RWO Delete Bound demo/cassandra-autoscale-nodetool-cassandra-autoscale-rack-r0-1 longhorn <unset> 21m
pvc-e550c573-60c7-4ec0-9e01-cf22683c502c 600Mi RWO Delete Bound demo/cassandra-autoscale-nodetool-cassandra-autoscale-rack-r0-0 longhorn <unset> 21m
```

You can see the petset has 600Mi storage, and the capacity of all the persistent volume is also 600Mi.

Expand Down Expand Up @@ -172,20 +173,23 @@ Here,
Let's create the `cassandraAutoscaler` CR we have shown above,

```bash
$ kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/storage/cassandra-autoscaler-ops.yaml
cassandraautoscaler.autoscaling.kubedb.com/cassandra-storage-autosclaer created
kubectl apply -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/cassandra/autoscaling/storage/cassandra-autoscaler-ops.yaml
```
cassandraautoscaler.autoscaling.kubedb.com/cassandra-storage-autosclaer created

#### Storage Autoscaling is set up successfully

Let's check that the `cassandraautoscaler` resource is created successfully,

```bash
$ kubectl get cassandraautoscaler -n demo
kubectl get cassandraautoscaler -n demo
```
NAME AGE
cassandra-storage-autoscaler 1m25s

$ kubectl describe cassandraautoscaler cassandra-storage-autoscaler -n demo
```bash
kubectl describe cassandraautoscaler cassandra-storage-autoscaler -n demo
```
Name: cassandra-storage-autoscaler
Namespace: demo
Labels: <none>
Expand Down Expand Up @@ -219,29 +223,29 @@ Spec:
Trigger: On
Usage Threshold: 2
Events: <none>
```
So, the `cassandraautoscaler` resource is created successfully.

Let's watch the `cassandraopsrequest` in the demo namespace to see if any `cassandraopsrequest` object is created. After some time you'll see that a `cassandraopsrequest` of type `VolumeExpansion` will be created based on the `scalingThreshold`.

```bash
$ kubectl get cassandraopsrequest -n demo
kubectl get cassandraopsrequest -n demo
```
NAME TYPE STATUS AGE
casops-cassandra-autoscale-xojkua VolumeExpansion Progressing 15s
```

Let's wait for the ops request to become successful.

```bash
$ kubectl get cassandraopsrequest -n demo
kubectl get cassandraopsrequest -n demo
```
NAME TYPE STATUS AGE
casops-cassandra-autoscale-9ah2rp VolumeExpansion Successful 10m
```

We can see from the above output that the `CassandraOpsRequest` has succeeded. If we describe the `CassandraOpsRequest` we will get an overview of the steps that were followed to expand the volume of the database.

```bash
$kubectl describe cassandraopsrequest -n demo casops-cassandra-autoscale-9ah2rp
kubectl describe cassandraopsrequest -n demo casops-cassandra-autoscale-9ah2rp
```
Name: casops-cassandra-autoscale-9ah2rp
Namespace: demo
Labels: app.kubernetes.io/component=database
Expand Down Expand Up @@ -549,15 +553,17 @@ Events:
Normal ReadyPetSets 63s KubeDB Ops-manager Operator PetSet is recreated
Normal Starting 63s KubeDB Ops-manager Operator Resuming Cassandra database: demo/cassandra-autoscale
Normal Successful 63s KubeDB Ops-manager Operator Successfully resumed Cassandra database: demo/cassandra-autoscale for CassandraOpsRequest: casops-cassandra-autoscale-9ah2rp
```

Now, we are going to verify from the `Petset`, and the `Persistent Volume` whether the volume of the replicaset database has expanded to meet the desired state, Let's check,

```bash
$ kubectl get petset -n demo cassandra-autoscale-rack-r0 -o json | jq '.spec.volumeClaimTemplates[0].spec.resources.requests.storage'
kubectl get petset -n demo cassandra-autoscale-rack-r0 -o json | jq '.spec.volumeClaimTemplates[0].spec.resources.requests.storage'
```
"1203126272"

$ kubectl get pv -n demo
```bash
kubectl get pv -n demo
```
NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS VOLUMEATTRIBUTESCLASS REASON AGE
pvc-394fefad-d4ad-4dfa-ba11-df96e015da30 600Mi RWO Delete Bound demo/cassandra-autoscale-main-config-volume-cassandra-autoscale-rack-r0-1 longhorn <unset> 45m
pvc-86ece3c8-520a-4d41-834e-66108867ca36 1148Mi RWO Delete Bound demo/cassandra-autoscale-data-cassandra-autoscale-rack-r0-1 longhorn <unset> 45m
Expand All @@ -566,8 +572,6 @@ pvc-cc932132-de53-425f-bd31-91af255a47e8 1148Mi RWO Delete
pvc-cd57fb5f-b2f3-48de-b9d2-03059b05113f 600Mi RWO Delete Bound demo/cassandra-autoscale-nodetool-cassandra-autoscale-rack-r0-1 longhorn <unset> 45m
pvc-e550c573-60c7-4ec0-9e01-cf22683c502c 600Mi RWO Delete Bound demo/cassandra-autoscale-nodetool-cassandra-autoscale-rack-r0-0 longhorn <unset> 45m

```

The above output verifies that we have successfully autoscaled the volume related to data of the cassandra cluster.

## Cleaning Up
Expand Down
Loading
Loading