mirror of https://github.com/tikv/website.git
Ana Hobden
parent
8234ea61ba
commit
77c2fd2e18
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Features
|
||||
description: The features of TiKV
|
||||
menu:
|
||||
docs:
|
||||
parent: Concepts
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: TiKV overview
|
||||
title: Concepts
|
||||
description: Some basic facts about TiKV
|
||||
menu:
|
||||
nav:
|
||||
|
|
@ -7,7 +7,6 @@ menu:
|
|||
parent: Docs
|
||||
weight: 1
|
||||
docs:
|
||||
name: Concepts
|
||||
weight: 1
|
||||
---
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
title: Reference
|
||||
headless: true
|
||||
draft: true
|
||||
menu:
|
||||
nav:
|
||||
parent: Docs
|
||||
weight: 3
|
||||
reference:
|
||||
weight: 4
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: APIs
|
||||
title: Clients
|
||||
description: Interact with TiKV using the raw key-value API or the transactional key-value API
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: APIs
|
||||
title: Rust
|
||||
description: Interact with TiKV using the raw key-value API or the transactional key-value API
|
||||
menu:
|
||||
docs:
|
||||
parent: Concepts
|
||||
parent: Clients
|
||||
---
|
||||
|
||||
TiKV offers two APIs that you can interact with:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Try Two Types of APIs
|
||||
title: Go
|
||||
description: Learn how to use the Raw Key-Value API and the Transactional Key-Value API in TiKV.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: TiKV Coprocessor Configuration
|
||||
description: Learn how to configure Coprocessor in TiKV.
|
||||
title: Coprocessor Options
|
||||
description: Learn how to configure the coprocessor in TiKV.
|
||||
menu:
|
||||
docs:
|
||||
parent: Configuration
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: gRPC Configuration
|
||||
title: gRPC (Remote procedure Calls)
|
||||
description: Learn how to configure gRPC.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: PD Scheduler Configuration
|
||||
title: PD Scheduler Options
|
||||
description: Learn how to configure PD Scheduler.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Raftstore Configuration
|
||||
title: Raftstore Options
|
||||
description: Learn about Raftstore configuration in TiKV.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: RocksDB Option Configuration
|
||||
title: RocksDB Options
|
||||
description: Learn how to configure RocksDB options.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: TiKV Security Configuration
|
||||
title: Security Options
|
||||
description: Learn about the security configuration in TiKV.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: TiKV Storage Configuration
|
||||
title: Storage Options
|
||||
description: Learn how to configure TiKV Storage.
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Reference
|
||||
description: Details about TiKV
|
||||
menu:
|
||||
docs:
|
||||
name: Reference
|
||||
|
||||
weight: 3
|
||||
nav:
|
||||
parent: Docs
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Blerp
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Source Code
|
||||
description: Source Code
|
||||
draft: true
|
||||
menu:
|
||||
docs:
|
||||
parent: Reference
|
||||
---
|
||||
|
|
@ -116,7 +116,7 @@ many keys to print out (30 by default). Use `--cf` to specify which cf to scan (
|
|||
|
||||
```bash
|
||||
$ ./tikv-ctl --db /var/lib/tikv/db/ raw-scan --from 'zt' --limit 2 --cf default
|
||||
key: "zt\200\000\000\000\000\000\000\377\005_r\200\000\000\000\000\377\000\000\001\000\000\000\000\000\372\372b2,^\033\377\364", value: "\010\002\002\002%\010\004\002\010root\010\006\002\000\010\010\t\002\010\n\t\002\010\014\t\002\010\016\t\002\010\020\t\002\010\022\t\002\010\024\t\002\010\026\t\002\010\030\t\002\010\032\t\002\010\034\t\002\010\036\t\002\010 \t\002\010\"\t\002\010$\t\002\010&\t\002\010(\t\002\010*\t\002\010,\t\002\010.\t\002\0100\t\002\0102\t\002\0104\t\002"
|
||||
key: "zt\200\000\000\000\000\000\000\377\005_r\200\000\000\000\000\377\000\000\001\000\000\000\000\000\372\372b2,^\033\377\364", value: "\010\002\002\002%\010\004\002\010root\010\006\002\000\010\010\t\002\010\n\t\002\010\014\t\002\010\016\t\002\010\020\t\002\010\022\t\002\010\024\t\002\010\026\t\002\010\030\t\002\010\032\t\002\010\034\t\002\010\036\t\002\010 \t\002\010\\"\t\002\010$\t\002\010&\t\002\010(\t\002\010*\t\002\010,\t\002\010.\t\002\0100\t\002\0102\t\002\0104\t\002"
|
||||
key: "zt\200\000\000\000\000\000\000\377\025_r\200\000\000\000\000\377\000\000\023\000\000\000\000\000\372\372b2,^\033\377\364", value: "\010\002\002&slow_query_log_file\010\004\002P/usr/local/mysql/data/localhost-slow.log"
|
||||
|
||||
Total scanned keys: 2
|
||||
|
|
|
|||
|
|
@ -1,67 +0,0 @@
|
|||
---
|
||||
title: Quickstart
|
||||
description: Run TiKV in your local environment using Docker Compose
|
||||
menu:
|
||||
nav:
|
||||
name: Tasks
|
||||
parent: Docs
|
||||
weight: 2
|
||||
docs:
|
||||
name: Tasks
|
||||
weight: 2
|
||||
---
|
||||
|
||||
This guide describes how to quickly deploy a TiKV testing cluster using [Docker Compose](https://docs.docker.com/compose/) on a single machine. Currently, this installation method is supported only on Linux.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Make sure that you have the following items installed on your machine:
|
||||
|
||||
* [Docker](https://docker.com) (17.06.0 or later) and [Docker Compose](https://docs.docker.com/compose/)
|
||||
|
||||
```shell
|
||||
sudo yum install docker docker-compose
|
||||
```
|
||||
|
||||
* [Helm](https://helm.sh/)
|
||||
|
||||
```shell
|
||||
curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash
|
||||
```
|
||||
|
||||
* [Git](https://git-scm.com/)
|
||||
|
||||
```shell
|
||||
sudo yum install git
|
||||
```
|
||||
|
||||
## Install and deploy
|
||||
|
||||
1. Clone `tidb-docker-compose`
|
||||
|
||||
```shell
|
||||
git clone https://github.com/pingcap/tidb-docker-compose.git
|
||||
cd tidb-docker-compose
|
||||
```
|
||||
1. Edit the `compose/values.yaml` file to configure the `networkMode` and `host` and comment the `tidb` section out.
|
||||
|
||||
1. Generate the `generated-docker-compose.yml` file
|
||||
|
||||
```shell
|
||||
helm template compose > generated-docker-compose.yml
|
||||
```
|
||||
|
||||
1. Create and start the cluster using the `generated-docker-compose.yml` file
|
||||
|
||||
```shell
|
||||
docker-compose -f generated-docker-compose.yml pull # Get the latest Docker images
|
||||
docker-compose -f generated-docker-compose.yml up -d
|
||||
```
|
||||
|
||||
You can check whether the TiKV cluster has been successfully deployed using the following command:
|
||||
|
||||
```shell
|
||||
curl localhost:2379/pd/api/v1/stores
|
||||
```
|
||||
|
||||
If the state of all the TiKV instances is `Up` then you have successfully deployed a TiKV cluster!
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Backup
|
||||
description: Backup TiKV
|
||||
menu:
|
||||
docs:
|
||||
parent: Tasks
|
||||
---
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Configure TiKV
|
||||
description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more
|
||||
menu:
|
||||
docs:
|
||||
parent: Tasks
|
||||
---
|
||||
|
||||
## RocksDB configuration {#rocksdb}
|
||||
|
||||
TiKV uses [RocksDB](https://rocksdb.org/) as its underlying storage engine for storing both [Raft logs](architecture#raft) and KV (key-value) pairs.
|
||||
|
||||
{{< info >}}
|
||||
RocksDB was chosen for TiKV because it provides a highly customizable persistent key-value store that can be tuned to run in a variety of production environments, including pure memory, Flash, hard disks, or HDFS, it supports various compression algorithms, and it provides solid tools for production support and debugging.
|
||||
{{< /info >}}
|
||||
|
||||
TiKV creates two RocksDB instances on each Node:
|
||||
|
||||
* A `rocksdb` instance that stores most TiKV data
|
||||
* A `raftdb` that stores [Raft logs](architecture#raft) and has a single column family called `raftdb.defaultcf`
|
||||
|
||||
The `rocksdb` instance has three column families:
|
||||
|
||||
Column family | Purpose
|
||||
:-------------|:-------
|
||||
`rocksdb.defaultcf` | Stores actual KV pairs for TiKV
|
||||
`rocksdb.writecf` | Stores commit information in the MVCC model
|
||||
|
||||
RocksDB can be configured on a per-column-family basis. Here's an example:
|
||||
|
||||
```toml
|
||||
[rocksdb]
|
||||
max-background-jobs = 8
|
||||
```
|
||||
|
||||
### RocksDB configuration options
|
||||
|
||||
{{< config "rocksdb" >}}
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Deploy
|
||||
description: Run TiKV using Ansible or Docker
|
||||
draft: true
|
||||
menu:
|
||||
docs:
|
||||
parent: Tasks
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Monitor
|
||||
description: Monitor TiKV
|
||||
draft: true
|
||||
menu:
|
||||
docs:
|
||||
parent: Tasks
|
||||
|
|
|
|||
|
|
@ -1,9 +1,12 @@
|
|||
---
|
||||
title: Quick Start
|
||||
title: Tasks
|
||||
description: Use Docker Compose to quickly deploy a TiKV testing cluster on a single machine.
|
||||
menu:
|
||||
nav:
|
||||
parent: Docs
|
||||
weight: 2
|
||||
docs:
|
||||
parent: Tasks
|
||||
weight: 2
|
||||
---
|
||||
|
||||
# Install and Deploy TiKV Using Docker Compose
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Scale
|
||||
description: SCale TiKV
|
||||
draft: true
|
||||
menu:
|
||||
docs:
|
||||
parent: Tasks
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
title: Deep Dive
|
||||
menu:
|
||||
docs:
|
||||
weight: 3
|
||||
weight: 4
|
||||
nav:
|
||||
parent: Docs
|
||||
weight: 3
|
||||
weight: 4
|
||||
---
|
||||
|
||||
[TiKV](https://github.com/tikv/tikv) is a distributed, transactional key-value database. It has been widely adopted in many critical production environments — see the [TiKV adopters](https://github.com/tikv/tikv/blob/master/docs/adopters.md). It has also been accepted by the [Cloud Native Computing Foundation](https://www.cfnc.org) as a [Sandbox project](https://www.cncf.io/blog/2018/08/28/cncf-to-host-tikv-in-the-sandbox/) in August, 2018.
|
||||
|
|
|
|||
Loading…
Reference in New Issue