https://github.com/greptimeteam/greptimedb-operator

Run GreptimeDB on Kubernetes.
https://github.com/greptimeteam/greptimedb-operator

cloud-native go greptimedb kubernetes time-series

Last synced: 10 months ago
JSON representation

Run GreptimeDB on Kubernetes.

• Host: GitHub
• URL: https://github.com/greptimeteam/greptimedb-operator
• Owner: GreptimeTeam
• License: apache-2.0
• Created: 2022-08-04T03:29:46.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-09-06T21:47:42.000Z (10 months ago)
• Last Synced: 2025-09-06T23:31:32.998Z (10 months ago)
• Topics: cloud-native, go, greptimedb, kubernetes, time-series
• Language: Go
• Homepage:
• Size: 1.25 MB
• Stars: 46
• Watchers: 9
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# GreptimeDB Operator

[![license](https://img.shields.io/github/license/GreptimeTeam/greptimedb-operator)](https://github.com/GreptimeTeam/greptimedb-operator/blob/main/LICENSE)

[![report](https://goreportcard.com/badge/github.com/GreptimeTeam/greptimedb-operator)](https://goreportcard.com/report/github.com/GreptimeTeam/greptimedb-operator)

[![GitHub release](https://img.shields.io/github/tag/GreptimeTeam/greptimedb-operator.svg?label=release)](https://github.com/GreptimeTeam/greptimedb-operator/releases)

[![GoDoc](https://img.shields.io/badge/Godoc-reference-blue.svg)](https://godoc.org/github.com/GreptimeTeam/greptimedb-operator)

[![Docker Pulls](https://img.shields.io/docker/pulls/greptime/greptimedb-operator)](https://hub.docker.com/r/greptime/greptimedb-operator)

## Overview

The GreptimeDB Operator manages the [GreptimeDB](https://github.com/GrepTimeTeam/greptimedb) resources on [Kubernetes](https://kubernetes.io/) using the [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). It is like an autopilot that automates the deployment, provisioning, and orchestration of the GreptimeDB cluster and standalone.

## Features

The GreptimeDB Operator includes, but is not limited to, the following features:

- **Automated Provisioning**

  Automates the deployment of the GreptimeDB cluster and standalone on Kubernetes by providing CRD `GreptimeDBCluster` and `GreptimeDBStandalone`.

- **Multi-Cloud Support**

  Users can deploy the GreptimeDB on any Kubernetes cluster, including on-premises and cloud environments(like AWS, GCP, Aliyun etc.).

- **Scaling**

  Scale the GreptimeDB cluster as easily as changing the `replicas` field in the `GreptimeDBCluster` CR.

- **Monitoring Bootstrap**

  Bootstrap the GreptimeDB monitoring stack for the GreptimeDB cluster by providing the `monitoring` field in the `GreptimeDBCluster` CR.

## Prerequisites

The GreptimeDB Operator requires at least Kubernetes `1.18.0`.

## Compatibility Matrix

| GreptimeDB Operator | API group/version      | Supported GreptimeDB version |

|---------------------|------------------------|------------------------------|

| < v0.2.0            | `greptime.io/v1alpha1` | < v0.12.0                    |

| ≥ v0.2.0            | `greptime.io/v1alpha1` | ≥ v0.12.0                    |

## Quick Start

The fastest way to install the GreptimeDB Operator is to use `bundle.yaml`:

```console

kubectl apply -f \

  https://github.com/GreptimeTeam/greptimedb-operator/releases/latest/download/bundle.yaml \

  --server-side 

```

The `greptimedb-operator` will be installed in the `greptimedb-admin` namespace. When the `greptimedb-operator` is running, you can see the following output:

```console

$ kubectl get pods -n greptimedb-admin

NAME                                   READY   STATUS    RESTARTS   AGE

greptimedb-operator-7947d785b5-b668p   1/1     Running   0          2m18s

```

Once the operator is running, you can experience the GreptimeDB by creating a basic standalone instance:

```console

cat <