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. 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.

Currently the best supported and most comprehensive deployment solution is to . 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 and Binary options.

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

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

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.