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.
Manage KubeDB objects using CLIs
KubeDB CLI
KubeDB comes with its own cli. It is called kubedb cli. kubedb can be used to manage any KubeDB object. kubedb cli also performs various validations to improve ux. To install KubeDB cli on your workstation, follow the steps here.
How to Create objects
kubedb create creates a database CRD object in default namespace by default. Following command will create a MongoDB object as specified in mongodb.yaml.
$ kubedb create -f mongodb-demo.yaml
mongodb.kubedb.com/mongodb-demo created
You can provide namespace as a flag --namespace. Provided namespace should match with namespace specified in input file.
$ kubedb create -f mongodb-demo.yaml --namespace=kube-system
mongodb.kubedb.com/mongodb-demo
kubedb create command also considers stdin as input.
cat mongodb-demo.yaml | kubedb create -f -
To learn about various options of create command, please visit here.
How to List Objects
kubedb get command allows users to list or find any KubeDB object. To list all MongoDB objects in default namespace, run the following command:
$ kubedb get mongodb
NAME VERSION STATUS AGE
mongodb-demo 3.4-v1 Running 13m
mongodb-dev 3.4-v1 Running 11m
mongodb-prod 3.4-v1 Running 11m
mongodb-qa 3.4-v1 Running 10m
To get YAML of an object, use --output=yaml flag.
$ kubedb get mongodb mongodb-demo --output=yaml
apiVersion: kubedb.com/v1alpha1
kind: MongoDB
metadata:
creationTimestamp: 2018-09-25T09:30:16Z
finalizers:
- kubedb.com
generation: 2
name: mongodb-demo
namespace: default
resourceVersion: "26192"
selfLink: /apis/kubedb.com/v1alpha1/namespaces/default/mongodbs/mongodb-demo
uid: 9ce4c10e-c0a5-11e8-b4a9-0800272618ed
spec:
databaseSecret:
secretName: mongodb-demo-auth
podTemplate:
controller: {}
metadata: {}
spec:
resources: {}
replicas: 1
serviceTemplate:
metadata: {}
spec: {}
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 50Mi
storageClassName: standard
storageType: Durable
terminationPolicy: Pause
updateStrategy:
type: RollingUpdate
version: 3.4-v1
status:
observedGeneration: 2$4213139756412538772
phase: Running
To get JSON of an object, use --output=json flag.
kubedb get mongodb mongodb-demo --output=json
To list all KubeDB objects, use following command:
$ kubedb get kubedb -o wide
NAME VERSION STATUS AGE
mg/mongodb-demo 3.4 Running 3h
mg/mongodb-dev 3.4 Running 3h
mg/mongodb-prod 3.4 Running 3h
mg/mongodb-qa 3.4 Running 3h
NAME DATABASE BUCKET STATUS AGE
snap/mongodb-demo-20170605-073557 mg/mongodb-demo gs:bucket-name Succeeded 9m
snap/snapshot-20171212-114700 mg/mongodb-demo gs:bucket-name Succeeded 1h
Flag --output=wide is used to print additional information.
List command supports short names for each object types. You can use it like kubedb get <short-name>. Below are the short name for KubeDB objects:
- MongoDB:
mg - Snapshot:
snap - DormantDatabase:
drmn
You can print labels with objects. The following command will list all Snapshots with their corresponding labels.
$ kubedb get snap --show-labels
NAME DATABASE STATUS AGE LABELS
mongodb-demo-20170605-073557 mg/mongodb-demo Succeeded 11m kubedb.com/kind=MongoDB,kubedb.com/name=mongodb-demo
snapshot-20171212-114700 mg/mongodb-demo Succeeded 1h kubedb.com/kind=MongoDB,kubedb.com/name=mongodb-demo
You can also filter list using --selector flag.
$ kubedb get snap --selector='kubedb.com/kind=MongoDB' --show-labels
NAME DATABASE STATUS AGE LABELS
mongodb-demo-20171212-073557 mg/mongodb-demo Succeeded 14m kubedb.com/kind=MongoDB,kubedb.com/name=mongodb-demo
snapshot-20171212-114700 mg/mongodb-demo Succeeded 2h kubedb.com/kind=MongoDB,kubedb.com/name=mongodb-demo
To print only object name, run the following command:
$ kubedb get all -o name
mongodb/mongodb-demo
mongodb/mongodb-dev
mongodb/mongodb-prod
mongodb/mongodb-qa
snapshot/mongodb-demo-20170605-073557
snapshot/snapshot-20170505-114700
To learn about various options of get command, please visit here.
How to Describe Objects
kubedb describe command allows users to describe any KubeDB object. The following command will describe MongoDB database mongodb-demo with relevant information.
$ kubedb describe mg mongodb-demo
Name: mongodb-demo
Namespace: default
CreationTimestamp: Tue, 25 Sep 2018 16:04:23 +0600
Labels: <none>
Annotations: <none>
Replicas: 1 total
Status: Running
StorageType: Durable
Volume:
StorageClass: standard
Capacity: 50Mi
Access Modes: RWO
StatefulSet:
Name: mongodb-demo
CreationTimestamp: Tue, 25 Sep 2018 16:04:25 +0600
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mongodb-demo
Annotations: <none>
Replicas: 824640299728 desired | 1 total
Pods Status: 1 Running / 0 Waiting / 0 Succeeded / 0 Failed
Service:
Name: mongodb-demo
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mongodb-demo
Annotations: <none>
Type: ClusterIP
IP: 10.96.137.225
Port: db 27017/TCP
TargetPort: db/TCP
Endpoints: 172.17.0.5:27017
Service:
Name: mongodb-demo-gvr
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mongodb-demo
Annotations: service.alpha.kubernetes.io/tolerate-unready-endpoints=true
Type: ClusterIP
IP: None
Port: db 27017/TCP
TargetPort: 27017/TCP
Endpoints: 172.17.0.5:27017
Database Secret:
Name: mongodb-demo-auth
Labels: kubedb.com/kind=MongoDB
kubedb.com/name=mongodb-demo
Annotations: <none>
Type: Opaque
Data
====
user: 4 bytes
password: 16 bytes
No Snapshots.
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal Successful 8m MongoDB operator Successfully created Service
Normal Successful 4m MongoDB operator Successfully created StatefulSet
Normal Successful 4m MongoDB operator Successfully created MongoDB
Normal Successful 3m MongoDB operator Successfully patched StatefulSet
Normal Successful 3m MongoDB operator Successfully patched MongoDB
Normal Successful 3m MongoDB operator Successfully patched StatefulSet
Normal Successful 3m MongoDB operator Successfully patched MongoDB
kubedb describe command provides following basic information about a MongoDB database.
- StatefulSet
- Storage (Persistent Volume)
- Service
- Secret (If available)
- Snapshots (If any)
- Monitoring system (If available)
To hide events on KubeDB object, use flag --show-events=false
To describe all MongoDB objects in default namespace, use following command
kubedb describe mg
To describe all MongoDB objects from every namespace, provide --all-namespaces flag.
kubedb describe mg --all-namespaces
To describe all KubeDB objects from every namespace, use the following command:
kubedb describe all --all-namespaces
You can also describe KubeDb objects with matching labels. The following command will describe all MongoDB objects with specified labels from every namespace.
kubedb describe mg --all-namespaces --selector='group=dev'
To learn about various options of describe command, please visit here.
How to Edit Objects
kubedb edit command allows users to directly edit any KubeDB object. It will open the editor defined by KUBEDB_EDITOR, or EDITOR environment variables, or fall back to vim.
Lets edit an existing running MongoDB object to setup Scheduled Backup. The following command will open MongoDB mongodb-demo in editor.
$ kubedb edit mg mongodb-demo
# Add following under Spec to configure periodic backups
# backupSchedule:
# cronExpression: '@every 1m'
# storageSecretName: mg-snap-secret
# gcs:
# bucket: bucket-name
mongodb "mongodb-demo" edited
Edit Restrictions
Various fields of a KubeDb object can’t be edited using edit command. The following fields are restricted from updates for all KubeDB objects:
- apiVersion
- kind
- metadata.name
- metadata.namespace
If StatefulSets exists for a MongoDB database, following fields can’t be modified as well.
- spec.ReplicaSet
- spec.databaseSecret
- spec.init
- spec.storageType
- spec.storage
- spec.podTemplate.spec.nodeSelector
- spec.podTemplate.spec.env
For DormantDatabase, spec.origin can’t be edited using kubedb edit
To learn about various options of edit command, please visit here.
How to Delete Objects
kubedb delete command will delete an object in default namespace by default unless namespace is provided. The following command will delete a MongoDB mongodb-dev in default namespace
$ kubedb delete mongodb mongodb-dev
mongodb.kubedb.com "mongodb-dev" deleted
You can also use YAML files to delete objects. The following command will delete a mongodb using the type and name specified in mongodb.yaml.
$ kubedb delete -f mongodb-demo.yaml
mongodb.kubedb.com "mongodb-dev" deleted
kubedb delete command also takes input from stdin.
cat mongodb-demo.yaml | kubedb delete -f -
To delete database with matching labels, use --selector flag. The following command will delete mongodb with label mongodb.kubedb.com/name=mongodb-demo.
kubedb delete mongodb -l mongodb.kubedb.com/name=mongodb-demo
To learn about various options of delete command, please visit here.
Using Kubectl
You can use Kubectl with KubeDB objects like any other CRDs. Below are some common examples of using Kubectl with KubeDB objects.
# List objects
$ kubectl get mongodb
$ kubectl get mongodb.kubedb.com
# Delete objects
$ kubectl delete mongodb <name>
Next Steps
- Learn how to use KubeDB to run a MongoDB database here.
- Wondering what features are coming next? Please visit here.
- Want to hack on KubeDB? Check our contribution guidelines.