tidb-operator

module
v1.0.0-beta.1-p1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2019 License: Apache-2.0

README

TiDB Operator

Build Status

TiDB Operator manages TiDB clusters on Kubernetes and automates tasks related to operating a TiDB cluster. It makes TiDB a truly cloud-native database.

Warning: Currently, TiDB Operator is work in progress [WIP] and is NOT ready for production. Use at your own risk.

Features

  • Safely scaling the TiDB cluster

    TiDB Operator empowers TiDB with horizontal scalability on the cloud.

  • Rolling update of the TiDB cluster

    Gracefully perform rolling updates for the TiDB cluster in order, achieving zero-downtime of the TiDB cluster.

  • Multi-tenant support

    Users can deploy and manage multiple TiDB clusters on a single Kubernetes cluster easily.

  • Automatic failover

    TiDB Operator automatically performs failover for your TiDB cluster when node failures occur.

  • Kubernetes package manager support

    By embracing Kubernetes package manager Helm, users can easily deploy TiDB clusters with only one command.

  • Automatically monitoring TiDB cluster at creating

    Automatically deploy Prometheus, Grafana for TiDB cluster monitoring.

Roadmap

Read the Roadmap.

Quick start

Choose one of the following tutorials:

User guide

Read the user guide.

Contributing

Contributions are welcome and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.

License

TiDB is under the Apache 2.0 license. See the LICENSE file for details.

Directories

Path Synopsis
cmd
pkg
apis/pingcap.com/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.
client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/pingcap.com/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/clientset/versioned/typed/pingcap.com/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
apis Module
client Module
tests
e2e

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL