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 Postgres object as specified in postgres.yaml.
$ kubedb create -f postgres-demo.yaml
postgres "postgres-demo" created
You can provide namespace as a flag --namespace. Provided namespace should match with namespace specified in input file.
$ kubedb create -f postgres-demo.yaml --namespace=kube-system
postgres "postgres-demo" created
kubedb create command also considers stdin as input.
cat postgres-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 Postgres objects in default namespace, run the following command:
$ kubedb get postgres
NAME STATUS AGE
postgres-demo Running 5h
postgres-dev Running 4h
postgres-prod Running 30m
postgres-qa Running 2h
To get YAML of an object, use --output=yaml flag.
$ kubedb get postgres postgres-demo --output=yaml
apiVersion: kubedb.com/v1alpha1
kind: Postgres
metadata:
name: postgres-demo
namespace: default
spec:
databaseSecret:
secretName: postgres-demo-auth
version: "9.6"
status:
creationTime: 2017-12-12T05:46:16Z
phase: Running
To get JSON of an object, use --output=json flag.
$ kubedb get postgres postgres-demo --output=json
To list all KubeDB objects, use following command:
$ kubedb get all -o wide
NAME VERSION STATUS AGE
es/elasticsearch-demo 2.3.1 Running 17m
NAME VERSION STATUS AGE
pg/postgres-demo 9.6.7 Running 3h
pg/postgres-dev 9.6.7 Running 3h
pg/postgres-prod 9.6.7 Running 3h
pg/postgres-qa 9.6.7 Running 3h
NAME DATABASE BUCKET STATUS AGE
snap/postgres-demo-20170605-073557 pg/postgres-demo gs:bucket-name Succeeded 9m
snap/snapshot-20171212-114700 pg/postgres-demo gs:bucket-name Succeeded 1h
snap/snapshot-xyz es/elasticsearch-demo local:/directory Succeeded 5m
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:
- Postgres:
pg - Elasticsearch:
es - 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
postgres-demo-20170605-073557 pg/postgres-demo Succeeded 11m kubedb.com/kind=Postgres,kubedb.com/name=postgres-demo
snapshot-20171212-114700 pg/postgres-demo Succeeded 1h kubedb.com/kind=Postgres,kubedb.com/name=postgres-demo
snapshot-xyz es/elasticsearch-demo Succeeded 6m kubedb.com/kind=Elasticsearch,kubedb.com/name=elasticsearch-demo
You can also filter list using --selector flag.
$ kubedb get snap --selector='kubedb.com/kind=Postgres' --show-labels
NAME DATABASE STATUS AGE LABELS
postgres-demo-20171212-073557 pg/postgres-demo Succeeded 14m kubedb.com/kind=Postgres,kubedb.com/name=postgres-demo
snapshot-20171212-114700 pg/postgres-demo Succeeded 2h kubedb.com/kind=Postgres,kubedb.com/name=postgres-demo
To print only object name, run the following command:
$ kubedb get all -o name
elasticsearch/elasticsearch-demo
postgres/postgres-demo
postgres/postgres-dev
postgres/postgres-prod
postgres/postgres-qa
snapshot/postgres-demo-20170605-073557
snapshot/snapshot-20170505-114700
snapshot/snapshot-xyz
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 PostgreSQL database postgres-demo with relevant information.
$ kubedb describe pg postgres-demo
Name: postgres-demo
Namespace: default
StartTimestamp: Tue, 12 Dec 2017 11:46:16 +0600
Status: Running
Volume:
StorageClass: standard
Capacity: 50Mi
Access Modes: RWO
StatefulSet:
Name: postgres-demo
Replicas: 1 current / 1 desired
CreationTimestamp: Tue, 12 Dec 2017 11:46:21 +0600
Pods Status: 1 Running / 0 Waiting / 0 Succeeded / 0 Failed
Service:
Name: postgres-demo
Type: ClusterIP
IP: 10.111.209.148
Port: api 5432/TCP
Service:
Name: postgres-demo-primary
Type: ClusterIP
IP: 10.102.192.231
Port: api 5432/TCP
Database Secret:
Name: postgres-demo-auth
Type: Opaque
Data
====
.admin: 35 bytes
Topology:
Type Pod StartTime Phase
---- --- --------- -----
primary postgres-demo-0 2017-12-12 11:46:22 +0600 +06 Running
No Snapshots.
Events:
FirstSeen LastSeen From Type Reason Message
--------- -------- ---- ---- ------ -------
5s 5s Postgres operator Normal SuccessfulCreate Successfully created StatefulSet
5s 5s Postgres operator Normal SuccessfulCreate Successfully created Postgres
55s 55s Postgres operator Normal SuccessfulValidate Successfully validate Postgres
55s 55s Postgres operator Normal Creating Creating Kubernetes objects
kubedb describe command provides following basic information about a database.
- StatefulSet
- Storage (Persistent Volume)
- Service
- Secret (If available)
- Topology (If available)
- Snapshots (If any)
- Monitoring system (If available)
To hide details about StatefulSet & Service, use flag --show-workload=false
To hide details about Secret, use flag --show-secret=false
To hide events on KubeDB object, use flag --show-events=false
To describe all Postgres objects in default namespace, use following command
$ kubedb describe pg
To describe all Postgres objects from every namespace, provide --all-namespaces flag.
$ kubedb describe pg --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 Elasticsearch & Postgres objects with specified labels from every namespace.
$ kubedb describe pg,es --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 nano.
Lets edit an existing running Postgres object to setup Scheduled Backup. The following command will open Postgres postgres-demo in editor.
$ kubedb edit pg postgres-demo
# Add following under Spec to configure periodic backups
# backupSchedule:
# cronExpression: "@every 6h"
# storageSecretName: "secret-name"
# gcs:
# bucket: "bucket-name"
postgres "postgres-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
- status
If StatefulSets or Deployments exists for a database, following fields can’t be modified as well.
Postgres:
- spec.version
- spec.standby
- spec.streaming
- spec.archiver
- spec.databaseSecret
- spec.storageType
- spec.storage
- spec.nodeSelector
- spec.init
Elasticsearch:
- spec.version
- spec.storageType
- spec.storage
- spec.nodeSelector
- spec.init
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 Postgres postgres-dev in default namespace
$ kubedb delete postgres postgres-dev
postgres "postgres-dev" deleted
You can also use YAML files to delete objects. The following command will delete a postgres using the type and name specified in postgres.yaml.
$ kubedb delete -f postgres.yaml
postgres "postgres-dev" deleted
kubedb delete command also takes input from stdin.
cat postgres.yaml | kubedb delete -f -
To delete database with matching labels, use --selector flag. The following command will delete postgres with label postgres.kubedb.com/name=postgres-demo.
$ kubedb delete postgres -l postgres.kubedb.com/name=postgres-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 postgres
$ kubectl get postgres.kubedb.com
# Delete objects
$ kubectl delete postgres <name>
Next Steps
- Learn how to use KubeDB to run a PostgreSQL database here.
- Want to hack on KubeDB? Check our contribution guidelines.