AppsCode
  • KubeDB

    Run Production-Grade Databases on Kubernetes

    Stash

    Backup and Recovery Solution for Kubernetes

    KubeVault

    Run Production-Grade Vault on Kubernetes

    Voyager

    Secure Ingress Controller for Kubernetes

    ConfigSyncer

    Kubernetes Configuration Syncer

    Guard

    Kubernetes Authentication WebHook Server

    KubeDB

    KubeDB simplifies Provisioning, Upgrading, Scaling, Volume Expansion, Monitor, Backup, Restore for various Databases in Kubernetes on any Public & Private Cloud

    • check-boxLower administrative burden
    • check-boxNative Kubernetes Support
    • check-boxPerformance
    • check-boxAvailability and durability
    • check-boxManageability
    • check-boxCost-effectiveness
    • check-boxSecurity
    Stash

    A complete Kubernetes native disaster recovery solution for backup and restore your volumes and databases in Kubernetes on any public and private clouds.

    • check-boxDeclarative API
    • check-boxBackup Kubernetes Volumes
    • check-boxBackup Database
    • check-boxMultiple Storage Support
    • check-boxDeduplication
    • check-boxData Encryption
    • check-boxVolume Snapshot
    • check-boxPolicy Based Backup
    KubeVault

    KubeVault is a Git-Ops ready, production-grade solution for deploying and configuring Hashicorp's Vault on Kubernetes.

    • check-boxVault Kubernetes Deployment
    • check-boxAuto Initialization & Unsealing
    • check-boxVault Backup & Restore
    • check-boxConsume KubeVault Secrets with CSI
    • check-boxManage DB Users Privileges
    • check-boxStorage Backend
    • check-boxAuthentication Method
    • check-boxDatabase Secret Engine
    Voyager

    Secure Ingress Controller for Kubernetes

    • check-boxHTTP & TCP
    • check-boxSSL
    • check-boxPlatform support
    • check-boxHAProxy
    • check-boxPrometheus
    • check-boxLet's Encrypt
    configsyncer

    Kubernetes Configuration Syncer

    • check-boxConfiguration Syncer
    Guard

    Kubernetes Authentication WebHook Server

    • check-boxIdentity Providers
    • check-boxCLI
    • check-boxRBAC
  • RESOURCES
  • Webinar New
CONTACT SALES
KubeDB
github-icon twitterx-icon
TRY NOW FREE

New to KubeDB? Please start here.

Horizontal Scale FerretDB

This guide will show you how to use KubeDB Ops-manager operator to scale the replicaset of a FerretDB.

Before You Begin

  • At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using kind.

  • Install KubeDB Provisioner and Ops-manager operator in your cluster following the steps here.

  • You should be familiar with the following KubeDB concepts:

To keep everything isolated, we are going to use a separate namespace called demo throughout this tutorial.

$ kubectl create ns demo
namespace/demo created

Note: YAML files used in this tutorial are stored in docs/examples/ferretdb directory of kubedb/docs repository.

Apply Horizontal Scaling on ferretdb

Here, we are going to deploy a FerretDB using a supported version by KubeDB operator. Then we are going to apply horizontal scaling on it.

Prepare FerretDB

Now, we are going to deploy a FerretDB with version 1.23.0.

Deploy FerretDB

In this section, we are going to deploy a FerretDB. Then, in the next section we will scale the ferretdb using FerretDBOpsRequest CRD. Below is the YAML of the FerretDB CR that we are going to create,

apiVersion: kubedb.com/v1alpha2
kind: FerretDB
metadata:
  name: fr-horizontal
  namespace: demo
spec:
  version: "1.23.0"
  replicas: 1
  backend:
    externallyManaged: false
  storage:
    accessModes:
      - ReadWriteOnce
    resources:
      requests:
        storage: 500Mi
  deletionPolicy: WipeOut

$ kubectl create -f https://github.com/kubedb/docs/raw/v2024.12.18/docs/examples/ferretdb/scaling/fr-horizontal.yaml
ferretdb.kubedb.com/fr-horizontal created

Now, wait until fr-horizontal has status Ready. i.e,

$ kubectl get fr -n demo
NAME            TYPE                  VERSION   STATUS   AGE
fr-horizontal   kubedb.com/v1alpha2   1.23.0    Ready    2m

Let’s check the number of replicas this ferretdb has from the FerretDB object, number of pods the petset have,

$ kubectl get ferretdb -n demo fr-horizontal -o json | jq '.spec.replicas'
1

$ kubectl get petset -n demo fr-horizontal -o json | jq '.spec.replicas'
1

We can see from both command that the ferretdb has 1 replicas.

We are now ready to apply the FerretDBOpsRequest CR to scale this ferretdb.

Scale Up Replicas

Here, we are going to scale up the replicas of the ferretdb to meet the desired number of replicas after scaling.

Create FerretDBOpsRequest

In order to scale up the replicas of the ferretdb, we have to create a FerretDBOpsRequest CR with our desired replicas. Below is the YAML of the FerretDBOpsRequest CR that we are going to create,

apiVersion: ops.kubedb.com/v1alpha1
kind: FerretDBOpsRequest
metadata:
  name: ferretdb-horizontal-scale-up
  namespace: demo
spec:
  type: HorizontalScaling
  databaseRef:
    name: fr-horizontal
  horizontalScaling:
    node: 3

Here,

  • spec.databaseRef.name specifies that we are performing horizontal scaling operation on fr-horizontal ferretdb.
  • spec.type specifies that we are performing HorizontalScaling on our ferretdb.
  • spec.horizontalScaling.replicas specifies the desired replicas after scaling.

Let’s create the FerretDBOpsRequest CR we have shown above,

$ kubectl apply -f https://github.com/kubedb/docs/raw/v2024.12.18/docs/examples/ferretdb/scaling/horizontal-scaling/frops-hscale-up-ops.yaml
ferretdbopsrequest.ops.kubedb.com/ferretdb-horizontal-scale-up created

Verify replicas scaled up successfully

If everything goes well, KubeDB Ops-manager operator will update the replicas of FerretDB object and related PetSet.

Let’s wait for FerretDBOpsRequest to be Successful. Run the following command to watch FerretDBOpsRequest CR,

$ watch kubectl get ferretdbopsrequest -n demo
Every 2.0s: kubectl get ferretdbopsrequest -n demo
NAME                           TYPE                STATUS       AGE
ferretdb-horizontal-scale-up   HorizontalScaling   Successful   102s

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

$ kubectl describe ferretdbopsrequest -n demo ferretdb-horizontal-scale-up
Name:         ferretdb-horizontal-scale-up
Namespace:    demo
Labels:       <none>
Annotations:  <none>
API Version:  ops.kubedb.com/v1alpha1
Kind:         FerretDBOpsRequest
Metadata:
  Creation Timestamp:  2024-10-21T10:03:39Z
  Generation:          1
  Resource Version:    353610
  UID:                 ce6c9e66-6196-4746-851a-ea49084eda05
Spec:
  Apply:  IfReady
  Database Ref:
    Name:  fr-horizontal
  Horizontal Scaling:
    Node:  3
  Type:    HorizontalScaling
Status:
  Conditions:
    Last Transition Time:  2024-10-21T10:04:30Z
    Message:               FerretDB ops-request has started to horizontally scaling the nodes
    Observed Generation:   1
    Reason:                HorizontalScaling
    Status:                True
    Type:                  HorizontalScaling
    Last Transition Time:  2024-10-21T10:04:33Z
    Message:               Successfully paused database
    Observed Generation:   1
    Reason:                DatabasePauseSucceeded
    Status:                True
    Type:                  DatabasePauseSucceeded
    Last Transition Time:  2024-10-21T10:04:58Z
    Message:               Successfully Scaled Up Node
    Observed Generation:   1
    Reason:                HorizontalScaleUp
    Status:                True
    Type:                  HorizontalScaleUp
    Last Transition Time:  2024-10-21T10:04:38Z
    Message:               patch petset; ConditionStatus:True; PodName:fr-horizontal-1
    Observed Generation:   1
    Status:                True
    Type:                  PatchPetset--fr-horizontal-1
    Last Transition Time:  2024-10-21T10:04:43Z
    Message:               is pod ready; ConditionStatus:True; PodName:fr-horizontal-1
    Observed Generation:   1
    Status:                True
    Type:                  IsPodReady--fr-horizontal-1
    Last Transition Time:  2024-10-21T10:04:43Z
    Message:               client failure; ConditionStatus:True; PodName:fr-horizontal-1
    Observed Generation:   1
    Status:                True
    Type:                  ClientFailure--fr-horizontal-1
    Last Transition Time:  2024-10-21T10:04:43Z
    Message:               is node healthy; ConditionStatus:True; PodName:fr-horizontal-1
    Observed Generation:   1
    Status:                True
    Type:                  IsNodeHealthy--fr-horizontal-1
    Last Transition Time:  2024-10-21T10:04:48Z
    Message:               patch petset; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  PatchPetset--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:04:48Z
    Message:               fr-horizontal already has desired replicas
    Observed Generation:   1
    Reason:                HorizontalScale
    Status:                True
    Type:                  HorizontalScale
    Last Transition Time:  2024-10-21T10:04:53Z
    Message:               is pod ready; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  IsPodReady--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:04:53Z
    Message:               client failure; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  ClientFailure--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:04:53Z
    Message:               is node healthy; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  IsNodeHealthy--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:04:58Z
    Message:               Successfully updated FerretDB
    Observed Generation:   1
    Reason:                UpdateDatabase
    Status:                True
    Type:                  UpdateDatabase
    Last Transition Time:  2024-10-21T10:04:58Z
    Message:               Successfully completed the HorizontalScaling for FerretDB
    Observed Generation:   1
    Reason:                Successful
    Status:                True
    Type:                  Successful
  Observed Generation:     1
  Phase:                   Successful
Events:
  Type     Reason                                                          Age   From                         Message
  ----     ------                                                          ----  ----                         -------
  Normal   Starting                                                        67s   KubeDB Ops-manager Operator  Start processing for FerretDBOpsRequest: demo/ferretdb-horizontal-scale-up
  Normal   Starting                                                        67s   KubeDB Ops-manager Operator  Pausing FerretDB database: demo/fr-horizontal
  Normal   Successful                                                      67s   KubeDB Ops-manager Operator  Successfully paused FerretDB database: demo/fr-horizontal for FerretDBOpsRequest: ferretdb-horizontal-scale-up
  Warning  patch petset; ConditionStatus:True; PodName:fr-horizontal-1     59s   KubeDB Ops-manager Operator  patch petset; ConditionStatus:True; PodName:fr-horizontal-1
  Warning  is pod ready; ConditionStatus:True; PodName:fr-horizontal-1     54s   KubeDB Ops-manager Operator  is pod ready; ConditionStatus:True; PodName:fr-horizontal-1
  Warning  client failure; ConditionStatus:True; PodName:fr-horizontal-1   54s   KubeDB Ops-manager Operator  client failure; ConditionStatus:True; PodName:fr-horizontal-1
  Warning  is node healthy; ConditionStatus:True; PodName:fr-horizontal-1  54s   KubeDB Ops-manager Operator  is node healthy; ConditionStatus:True; PodName:fr-horizontal-1
  Warning  patch petset; ConditionStatus:True; PodName:fr-horizontal-2     49s   KubeDB Ops-manager Operator  patch petset; ConditionStatus:True; PodName:fr-horizontal-2
  Warning  is pod ready; ConditionStatus:True; PodName:fr-horizontal-2     44s   KubeDB Ops-manager Operator  is pod ready; ConditionStatus:True; PodName:fr-horizontal-2
  Warning  client failure; ConditionStatus:True; PodName:fr-horizontal-2   44s   KubeDB Ops-manager Operator  client failure; ConditionStatus:True; PodName:fr-horizontal-2
  Warning  is node healthy; ConditionStatus:True; PodName:fr-horizontal-2  44s   KubeDB Ops-manager Operator  is node healthy; ConditionStatus:True; PodName:fr-horizontal-2
  Normal   HorizontalScaleUp                                               39s   KubeDB Ops-manager Operator  Successfully Scaled Up Node
  Normal   UpdateDatabase                                                  39s   KubeDB Ops-manager Operator  Successfully updated FerretDB
  Normal   Starting                                                        39s   KubeDB Ops-manager Operator  Resuming FerretDB database: demo/fr-horizontal
  Normal   Successful                                                      39s   KubeDB Ops-manager Operator  Successfully resumed FerretDB database: demo/fr-horizontal for FerretDBOpsRequest: ferretdb-horizontal-scale-up

Now, we are going to verify the number of replicas this ferretdb has from the FerretDB object, number of pods the petset have,

$ kubectl get fr -n demo fr-horizontal -o json | jq '.spec.replicas'
3

$ kubectl get petset -n demo fr-horizontal -o json | jq '.spec.replicas'
3

From all the above outputs we can see that the replicas of the ferretdb is 3. That means we have successfully scaled up the replicas of the FerretDB.

Scale Down Replicas

Here, we are going to scale down the replicas of the ferretdb to meet the desired number of replicas after scaling.

Create FerretDBOpsRequest

In order to scale down the replicas of the ferretdb, we have to create a FerretDBOpsRequest CR with our desired replicas. Below is the YAML of the FerretDBOpsRequest CR that we are going to create,

apiVersion: ops.kubedb.com/v1alpha1
kind: FerretDBOpsRequest
metadata:
  name: ferretdb-horizontal-scale-down
  namespace: demo
spec:
  type: HorizontalScaling
  databaseRef:
    name: fr-horizontal
  horizontalScaling:
    node: 2

Here,

  • spec.databaseRef.name specifies that we are performing horizontal scaling down operation on fr-horizontal ferretdb.
  • spec.type specifies that we are performing HorizontalScaling on our ferretdb.
  • spec.horizontalScaling.replicas specifies the desired replicas after scaling.

Let’s create the FerretDBOpsRequest CR we have shown above,

$ kubectl apply -f https://github.com/kubedb/docs/raw/v2024.12.18/docs/examples/ferretdb/scaling/horizontal-scaling/frops-hscale-down-ops.yaml
ferretdbopsrequest.ops.kubedb.com/ferretdb-horizontal-scale-down created

Verify replicas scaled down successfully

If everything goes well, KubeDB Ops-manager operator will update the replicas of FerretDB object and related PetSet.

Let’s wait for FerretDBOpsRequest to be Successful. Run the following command to watch FerretDBOpsRequest CR,

$ watch kubectl get ferretdbopsrequest -n demo
Every 2.0s: kubectl get ferretdbopsrequest -n demo
NAME                             TYPE                STATUS       AGE
ferretdb-horizontal-scale-down   HorizontalScaling   Successful   40s

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

$ kubectl describe ferretdbopsrequest -n demo ferretdb-horizontal-scale-down
Name:         ferretdb-horizontal-scale-down
Namespace:    demo
Labels:       <none>
Annotations:  <none>
API Version:  ops.kubedb.com/v1alpha1
Kind:         FerretDBOpsRequest
Metadata:
  Creation Timestamp:  2024-10-21T10:06:42Z
  Generation:          1
  Resource Version:    353838
  UID:                 69cb9e8a-ec89-41e2-9e91-ce61a68044b9
Spec:
  Apply:  IfReady
  Database Ref:
    Name:  fr-horizontal
  Horizontal Scaling:
    Node:  2
  Type:    HorizontalScaling
Status:
  Conditions:
    Last Transition Time:  2024-10-21T10:06:42Z
    Message:               FerretDB ops-request has started to horizontally scaling the nodes
    Observed Generation:   1
    Reason:                HorizontalScaling
    Status:                True
    Type:                  HorizontalScaling
    Last Transition Time:  2024-10-21T10:06:45Z
    Message:               Successfully paused database
    Observed Generation:   1
    Reason:                DatabasePauseSucceeded
    Status:                True
    Type:                  DatabasePauseSucceeded
    Last Transition Time:  2024-10-21T10:07:00Z
    Message:               Successfully Scaled Down Node
    Observed Generation:   1
    Reason:                HorizontalScaleDown
    Status:                True
    Type:                  HorizontalScaleDown
    Last Transition Time:  2024-10-21T10:06:50Z
    Message:               patch petset; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  PatchPetset--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:06:51Z
    Message:               fr-horizontal already has desired replicas
    Observed Generation:   1
    Reason:                HorizontalScale
    Status:                True
    Type:                  HorizontalScale
    Last Transition Time:  2024-10-21T10:06:55Z
    Message:               get pod; ConditionStatus:True; PodName:fr-horizontal-2
    Observed Generation:   1
    Status:                True
    Type:                  GetPod--fr-horizontal-2
    Last Transition Time:  2024-10-21T10:07:00Z
    Message:               Successfully updated FerretDB
    Observed Generation:   1
    Reason:                UpdateDatabase
    Status:                True
    Type:                  UpdateDatabase
    Last Transition Time:  2024-10-21T10:07:00Z
    Message:               Successfully completed the HorizontalScaling for FerretDB
    Observed Generation:   1
    Reason:                Successful
    Status:                True
    Type:                  Successful
  Observed Generation:     1
  Phase:                   Successful
Events:
  Type     Reason                                                       Age   From                         Message
  ----     ------                                                       ----  ----                         -------
  Normal   Starting                                                     55s   KubeDB Ops-manager Operator  Start processing for FerretDBOpsRequest: demo/ferretdb-horizontal-scale-down
  Normal   Starting                                                     55s   KubeDB Ops-manager Operator  Pausing FerretDB database: demo/fr-horizontal
  Normal   Successful                                                   55s   KubeDB Ops-manager Operator  Successfully paused FerretDB database: demo/fr-horizontal for FerretDBOpsRequest: ferretdb-horizontal-scale-down
  Warning  patch petset; ConditionStatus:True; PodName:fr-horizontal-2  47s   KubeDB Ops-manager Operator  patch petset; ConditionStatus:True; PodName:fr-horizontal-2
  Warning  get pod; ConditionStatus:True; PodName:fr-horizontal-2       42s   KubeDB Ops-manager Operator  get pod; ConditionStatus:True; PodName:fr-horizontal-2
  Normal   HorizontalScaleDown                                          37s   KubeDB Ops-manager Operator  Successfully Scaled Down Node
  Normal   UpdateDatabase                                               37s   KubeDB Ops-manager Operator  Successfully updated FerretDB
  Normal   Starting                                                     37s   KubeDB Ops-manager Operator  Resuming FerretDB database: demo/fr-horizontal
  Normal   Successful                                                   37s   KubeDB Ops-manager Operator  Successfully resumed FerretDB database: demo/fr-horizontal for FerretDBOpsRequest: ferretdb-horizontal-scale-down

Now, we are going to verify the number of replicas this ferretdb has from the FerretDB object, number of pods the petset have,

$ kubectl get fr -n demo fr-horizontal -o json | jq '.spec.replicas'
2

$ kubectl get petset -n demo fr-horizontal -o json | jq '.spec.replicas'
2

From all the above outputs we can see that the replicas of the ferretdb is 2. That means we have successfully scaled up the replicas of the FerretDB.

Cleaning Up

To clean up the Kubernetes resources created by this tutorial, run:

kubectl delete mg -n fr-horizontal
kubectl delete ferretdbopsrequest -n demo ferretdb-horizontal-scale-down

What's on this Page

Search
Improve This Page