Return to top
On this page

GreptimeDB in Kubernetes

What's GreptimeDB Operator

The GreptimeDB Operator manages GreptimeDB clusters on Kubernetes by using Operator pattern.

The GreptimeDB operator abstracts the model of maintaining the highly available GreptimeDB cluster. You can create your own cluster as easily as possible:

shell
cat <<EOF | kubectl apply -f -
apiVersion: greptime.io/v1alpha1
kind: GreptimeDBCluster
metadata:
  name: basic
spec:
  base:
    main:
      image: greptime/greptimedb
  frontend:
    replicas: 1
  meta:
    replicas: 1
    etcdEndpoints:
      - "etcd.default:2379"
  datanode:
    replicas: 3
EOF

Getting Started with GreptimeDB Operator on Kubernetes

1. Create a test Kubernetes cluster

You can use kind to create your own test Kubernetes cluster:

shell
kind create cluster

2. Use Helm to install GreptimeDB Operator

Make sure you have already installed Helm. Use the following commands to install greptimedb-operator in the default namespace:

shell
helm repo add greptime https://greptimeteam.github.io/helm-charts/
helm repo update
helm install gtcloud greptime/greptimedb-operator -n default --devel

The maintained Helm charts are in helm-charts.

3. Create your own GreptimeDB cluster

shell
helm install mydb greptime/greptimedb -n default --devel

After the installation, you can use kubectl port-forward to access GreptimeDB cluster:

shell
kubectl port-forward svc/mydb-frontend 4002:4002 > connections.out &

Use mysql to connect GreptimeDB:

shell
mysql -h 127.0.0.1 -P 4002

4. Destroy GreptimeDB cluster

You can use the following commands to uninstall operator and cluster:

shell
# Uninstall the cluster.
helm uninstall mydb

# Uninstall the operator.
helm uninstall gtcloud

# Delete crds.
kubectl delete crds greptimedbclusters.greptime.io