You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
New to KubeDB? Please start here.
Initialize MongoDB with Snapshot
This tutorial will show you how to use KubeDB to initialize a MongoDB database with an existing snapshot.
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 Minikube.
Now, install KubeDB cli on your workstation and KubeDB operator in your cluster following the steps here.
This tutorial assumes that you have created a namespace
demoand a snapshotsnapshot-instant. Follow the steps here to create a database and take instant snapshot, if you have not done so already. If you have changed the name of either namespace or snapshot object, please modify the YAMLs used in this tutorial accordingly.
Note: The yaml files used in this tutorial are stored in docs/examples/mongodb folder in GitHub repository kubedb/docs.
Create MongoDB with Init-Snapshot
Below is the MongoDB object created in this tutorial.
apiVersion: kubedb.com/v1alpha1
kind: MongoDB
metadata:
name: mgo-init-snapshot
namespace: demo
spec:
version: "3.4-v3"
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
init:
snapshotSource:
name: snapshot-instant
namespace: demo
$ kubedb create -f https://github.com/kubedb/docs/raw/v0.13.0-rc.0/docs/examples/mongodb/Initialization/demo-2.yaml
mongodb.kubedb.com/mgo-init-snapshot created
Here,
spec.init.snapshotSource.namerefers to a Snapshot object for a MongoDB database in the same namespaces as this newmgo-init-snapshotMongoDB object.
Now, wait several seconds. KubeDB operator will create a new StatefulSet. Then KubeDB operator launches a Kubernetes Job to initialize the new database using the data from snapshot-instant Snapshot.
$ kubedb get mg -n demo
NAME VERSION STATUS AGE
mgo-instant 3.4-v3 Running 4m
mgo-init-snapshot 3.4-v3 Initializing 53s
$ kubedb describe mg -n demo mgo-init-snapshot
Name: mgo-init-snapshot
Namespace: demo
CreationTimestamp: Wed, 06 Feb 2019 15:51:44 +0600
Labels: <none>
Annotations: kubedb.com/initialized=
Replicas: 1 total
Status: Running
StorageType: Durable
Volume:
StorageClass: standard
Capacity: 1Gi
Access Modes: RWO
StatefulSet:
Name: mgo-init-snapshot
CreationTimestamp: Wed, 06 Feb 2019 15:51:44 +0600
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mgo-init-snapshot
Annotations: <none>
Replicas: 824637966784 desired | 1 total
Pods Status: 1 Running / 0 Waiting / 0 Succeeded / 0 Failed
Service:
Name: mgo-init-snapshot
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mgo-init-snapshot
Annotations: <none>
Type: ClusterIP
IP: 10.100.3.243
Port: db 27017/TCP
TargetPort: db/TCP
Endpoints: 172.17.0.8:27017
Service:
Name: mgo-init-snapshot-gvr
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mgo-init-snapshot
Annotations: service.alpha.kubernetes.io/tolerate-unready-endpoints=true
Type: ClusterIP
IP: None
Port: db 27017/TCP
TargetPort: 27017/TCP
Endpoints: 172.17.0.8:27017
Database Secret:
Name: mgo-init-snapshot-auth
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mgo-init-snapshot
Annotations: <none>
Type: Opaque
Data
====
password: 16 bytes
username: 4 bytes
No Snapshots.
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal Successful 20s KubeDB operator Successfully created Service
Normal Successful 12s KubeDB operator Successfully created StatefulSet
Normal Successful 12s KubeDB operator Successfully created MongoDB
Normal Initializing 12s KubeDB operator Initializing from Snapshot: "snapshot-instant"
Normal Successful 12s KubeDB operator Successfully patched StatefulSet
Normal Successful 12s KubeDB operator Successfully patched MongoDB
Normal Successful 4s KubeDB operator Successfully patched StatefulSet
Normal Successful 4s KubeDB operator Successfully patched MongoDB
Normal SuccessfulInitialize 4s KubeDB operator Successfully completed initialization
Normal Successful 4s KubeDB operator Successfully created appbinding
Normal Successful 4s KubeDB operator Successfully patched StatefulSet
Normal Successful 4s KubeDB operator Successfully patched MongoDB
Cleaning up
To cleanup the Kubernetes resources created by this tutorial, run:
kubectl patch -n demo mg/mgo-instant mg/mgo-init-snapshot -p '{"spec":{"terminationPolicy":"WipeOut"}}' --type="merge"
kubectl delete -n demo mg/mgo-instant mg/mgo-init-snapshot
kubectl patch -n demo drmn/mgo-instant drmn/mgo-init-snapshot -p '{"spec":{"wipeOut":true}}' --type="merge"
kubectl delete -n demo drmn/mgo-instant drmn/mgo-init-snapshot
kubectl delete ns demo
Next Steps
- Monitor your MongoDB database with KubeDB using out-of-the-box CoreOS Prometheus Operator.
- Monitor your MongoDB database with KubeDB using out-of-the-box builtin-Prometheus.
- Use private Docker registry to deploy MongoDB with KubeDB.
- Detail concepts of MongoDB object.
- Detail concepts of MongoDBVersion object.
- Detail concepts of Snapshot object.
- Want to hack on KubeDB? Check our contribution guidelines.