We are currently refactoring our documentation. Please excuse any problems you may find and report them here.

Learn to try, deploy, configure, monitor, and scale TiKV as you adopt the service into your project and infrastructure.

Try

It’s not always desirable to deploy a full production cluster of TiKV. If you just want to take TiKV for a spin, or get familiar with how it works, you may find yourself wanting to run TiKV locally.

In the try section you’ll find out how to get started. Try TiKV teaches you how to get a copy of TiKV running on your machine with Docker. Then you’ll connect and talk to the TiKV cluster using our Rust client.

Deploy

In the deploy section you’ll find several guides to help you deploy & integrate TiKV into your infrastructure.

Currently the best supported and most comprehensive deployment solution is to Deploy TiKV using Ansible. In this guide you’ll learn to deploy and maintain TiKV using the same scripts PingCAP deploys TiKV with inside of many of our adopters.

If you’re determined to strike it out on your own, we’ve done our best to provide you with the tools you need to build your own solution. Start by choosing between the Docker and Binary options.

Configure

Learn about how you can configure TiKV to meet your needs in the configure section. There you’ll find a number of guides including:

• Security: Use TLS security and review security procedures.
• Topology: Use location awareness to improve resilency and performance.
• Namespace: Use namespacing to configure resource isolation.
• Limit: Tweak rate limiting.
• Region Merge: Tweak region merging.
• RocksDB: Tweak RocksDB configuration options.
• Titan: Enable titan to improve performance with large values.

Monitor

Learn how to inspect a TiKV cluster in the Monitor section. You’ll find out how to check the component state interface or collect Prometheus metrics, as well as review the key metrics to be aware of.

Scale

As your dataset and workload change you’ll eventually need to scale TiKV to meet these new demands. In the Scale section you’ll find out how to grow and shrink your TiKV cluster.

If you deployed using Ansible, please check the Ansible Scaling guide.