hub / github.com/GreptimeTeam/gtctl

github.com/GreptimeTeam/gtctl @main

294 symbols 1,064 edges 61 files 103 documented · 35% ● updated 2mo agov0.1.0-beta.11 · 2024-07-09★ 3721 open issues

Browse by type

⨍ Functions 231◇ Types & classes 63

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

gtctl

Overview

gtctl is a command-line tool for managing GreptimeDB cluster. gtctl integrates the multiple operations in one binary.

Getting Started

Prerequisites

Kubernetes 1.18 or higher version is required

You can use kind to create your own Kubernetes cluster:

$ kind create cluster

Usage

Create GreptimeDB cluster

$ gtctl create cluster -n mydb

Get GreptimeDB cluster

$ gtctl get cluster -n mydb

Scale GreptimeDB cluster

``` # Scale datanode to 3 replicas. $ gtctl scale cluster -n mydb -c datanode --replicas 3

# Scale frontend to 5 replicas. $ gtctl scale cluster -n mydb -c frontend --replicas 5 ```

Delete GreptimeDB cluster

``` # Delete GreptimeDB cluster. $ gtctl delete cluster -n mydb

# Delete GreptimeDB cluster, including etcd cluster. $ gtctl delete cluster -n mydb --tear-down-etcd ```

Development

Just make it:

$ make

Extension points exported contracts — how you extend this code

ClusterComponent (Interface)

ClusterComponent is the basic component of running GreptimeDB Cluster in bare-metal mode. [4 implementers]

pkg/components/types.go

Logger (Interface)

Logger is the new interface and base on log.Logger that from kind project.

pkg/logger/logger.go

Manager (Interface)

Manager is the interface of the metadata manager. The metadata manager is responsible for managing all the metadata of g

pkg/metadata/manager.go

Operations (Interface)

(no doc) [2 implementers]

browse all types & interfaces →

Core symbols most depended-on inside this repo

↓ 42 fileslogger

logger is an implementation of Logger interface. The implementation of logger is based on the 'kind/pkg/internal/cli/logger.go' …

pkg/logger/logger.go

↓ 18 filesinfoLogger

infoLogger implements log.InfoLogger for logger.

pkg/logger/logger.go

↓ 14 filesManager

Manager is the interface of the metadata manager. The metadata manager is responsible for managing all the metadata of gtctl.

pkg/metadata/manager.go

↓ 16 filesOperations

pkg/cluster/types.go

↓ 12 filesClusterComponent

ClusterComponent is the basic component of running GreptimeDB Cluster in bare-metal mode.

pkg/components/types.go

↓ 8 filesCluster

pkg/cluster/baremetal/cluster.go

browse all functions →

Shape

Method 137

Function 94

Struct 49

Interface 6

FuncType 5

TypeAlias 3

Languages

Go100%

Modules by API surface

pkg/logger/logger.go30 symbols

pkg/artifacts/manager.go23 symbols

pkg/metadata/manager.go18 symbols

pkg/kube/client.go17 symbols

pkg/cluster/types.go17 symbols

pkg/utils/file/file.go9 symbols

pkg/config/baremetal.go9 symbols

pkg/cluster/baremetal/cluster.go9 symbols

pkg/helm/loader.go8 symbols

pkg/components/types.go7 symbols

pkg/helm/values.go6 symbols

pkg/components/metasrv.go6 symbols

For agents

$ claude mcp add gtctl \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/GreptimeTeam/gtctl @main

gtctl

Overview

Getting Started

Prerequisites

Usage

Development

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

For agents

Ask about this repo answers extend the page