{"id":28493175,"url":"https://github.com/greptimeteam/greptimedb-operator","last_synced_at":"2025-09-08T18:37:38.191Z","repository":{"id":63224552,"uuid":"521110180","full_name":"GreptimeTeam/greptimedb-operator","owner":"GreptimeTeam","description":"Run GreptimeDB on Kubernetes.","archived":false,"fork":false,"pushed_at":"2025-09-06T21:47:42.000Z","size":1308,"stargazers_count":46,"open_issues_count":14,"forks_count":3,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-09-06T23:31:32.998Z","etag":null,"topics":["cloud-native","go","greptimedb","kubernetes","time-series"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GreptimeTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-08-04T03:29:46.000Z","updated_at":"2025-09-06T21:47:46.000Z","dependencies_parsed_at":"2024-07-12T09:48:03.219Z","dependency_job_id":"7ad32609-ce2c-4356-8853-73f36d5d7e41","html_url":"https://github.com/GreptimeTeam/greptimedb-operator","commit_stats":{"total_commits":139,"total_committers":6,"mean_commits":"23.166666666666668","dds":0.3309352517985612,"last_synced_commit":"988d76ba03871cfa6baf551e174a0442ff645485"},"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"purl":"pkg:github/GreptimeTeam/greptimedb-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreptimeTeam%2Fgreptimedb-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreptimeTeam%2Fgreptimedb-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreptimeTeam%2Fgreptimedb-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreptimeTeam%2Fgreptimedb-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GreptimeTeam","download_url":"https://codeload.github.com/GreptimeTeam/greptimedb-operator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreptimeTeam%2Fgreptimedb-operator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274229383,"owners_count":25245189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-native","go","greptimedb","kubernetes","time-series"],"created_at":"2025-06-08T09:07:53.991Z","updated_at":"2025-09-08T18:37:38.165Z","avatar_url":"https://github.com/GreptimeTeam.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GreptimeDB Operator\n\n[![license](https://img.shields.io/github/license/GreptimeTeam/greptimedb-operator)](https://github.com/GreptimeTeam/greptimedb-operator/blob/main/LICENSE)\n[![report](https://goreportcard.com/badge/github.com/GreptimeTeam/greptimedb-operator)](https://goreportcard.com/report/github.com/GreptimeTeam/greptimedb-operator)\n[![GitHub release](https://img.shields.io/github/tag/GreptimeTeam/greptimedb-operator.svg?label=release)](https://github.com/GreptimeTeam/greptimedb-operator/releases)\n[![GoDoc](https://img.shields.io/badge/Godoc-reference-blue.svg)](https://godoc.org/github.com/GreptimeTeam/greptimedb-operator)\n[![Docker Pulls](https://img.shields.io/docker/pulls/greptime/greptimedb-operator)](https://hub.docker.com/r/greptime/greptimedb-operator)\n\n## Overview\n\nThe 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.\n\n## Features\n\nThe GreptimeDB Operator includes, but is not limited to, the following features:\n\n- **Automated Provisioning**\n\n  Automates the deployment of the GreptimeDB cluster and standalone on Kubernetes by providing CRD `GreptimeDBCluster` and `GreptimeDBStandalone`.\n\n- **Multi-Cloud Support**\n\n  Users can deploy the GreptimeDB on any Kubernetes cluster, including on-premises and cloud environments(like AWS, GCP, Aliyun etc.).\n\n- **Scaling**\n\n  Scale the GreptimeDB cluster as easily as changing the `replicas` field in the `GreptimeDBCluster` CR.\n\n- **Monitoring Bootstrap**\n\n  Bootstrap the GreptimeDB monitoring stack for the GreptimeDB cluster by providing the `monitoring` field in the `GreptimeDBCluster` CR.\n\n## Prerequisites\n\nThe GreptimeDB Operator requires at least Kubernetes `1.18.0`.\n\n## Compatibility Matrix\n\n| GreptimeDB Operator | API group/version      | Supported GreptimeDB version |\n|---------------------|------------------------|------------------------------|\n| \u003c v0.2.0            | `greptime.io/v1alpha1` | \u003c v0.12.0                    |\n| ≥ v0.2.0            | `greptime.io/v1alpha1` | ≥ v0.12.0                    |\n\n## Quick Start\n\nThe fastest way to install the GreptimeDB Operator is to use `bundle.yaml`:\n\n```console\nkubectl apply -f \\\n  https://github.com/GreptimeTeam/greptimedb-operator/releases/latest/download/bundle.yaml \\\n  --server-side \n```\n\nThe `greptimedb-operator` will be installed in the `greptimedb-admin` namespace. When the `greptimedb-operator` is running, you can see the following output:\n\n```console\n$ kubectl get pods -n greptimedb-admin\nNAME                                   READY   STATUS    RESTARTS   AGE\ngreptimedb-operator-7947d785b5-b668p   1/1     Running   0          2m18s\n```\n\nOnce the operator is running, you can experience the GreptimeDB by creating a basic standalone instance:\n\n```console\ncat \u003c\u003cEOF | kubectl apply -f -\napiVersion: greptime.io/v1alpha1\nkind: GreptimeDBStandalone\nmetadata:\n  name: basic\nspec:\n  base:\n    main:\n      image: greptime/greptimedb:latest\nEOF\n```\n\nWhen the standalone is running, you can see the following output:\n\n```console\n$ kubectl get greptimedbstandalones basic\nNAME    PHASE     VERSION   AGE\nbasic   Running   latest    75s\n```\n\nYou can use `kubectl port-forward` to access the GreptimeDB:\n\n```console\nkubectl port-forward svc/basic-standalone 4001:4001 4002:4002 4003:4003 4000:4000\n```\n\nPlease refer to the [quick-start](https://docs.greptime.com/getting-started/quick-start) to try more examples.\n\n## Examples\n\nThe GreptimeDB Operator provides a set of examples to help you understand how to use the GreptimeDB Operator. You can find the examples in the [examples](./examples/README.md) directory.\n\n## Deployment\n\nFor production use, we recommend deploying the GreptimeDB Operator with the GreptimeDB official Helm [chart](https://github.com/GreptimeTeam/helm-charts). \n\n## Documentation\n\nFor more information, please refer to the following documentation:\n\n- [User Guide](https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/overview)\n\n- [API References](./docs/api-references/docs.md)\n\n## License\n\ngreptimedb-operator uses the [Apache 2.0 license](./LICENSE) to strike a balance between\nopen contributions and allowing you to use the software however you want.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreptimeteam%2Fgreptimedb-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreptimeteam%2Fgreptimedb-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreptimeteam%2Fgreptimedb-operator/lists"}