Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chuyangliu/rawkv
Cloud-native distributed key-value database.
https://github.com/chuyangliu/rawkv
cloud-native consensus database distributed-systems docker golang grpc key-value kubernetes log-structured raft replication transaction
Last synced: 2 months ago
JSON representation
Cloud-native distributed key-value database.
- Host: GitHub
- URL: https://github.com/chuyangliu/rawkv
- Owner: chuyangliu
- License: apache-2.0
- Created: 2020-05-05T16:11:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T16:22:00.000Z (7 months ago)
- Last Synced: 2024-06-19T06:46:16.206Z (7 months ago)
- Topics: cloud-native, consensus, database, distributed-systems, docker, golang, grpc, key-value, kubernetes, log-structured, raft, replication, transaction
- Language: Go
- Homepage:
- Size: 189 KB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RawKV
[![][goreport-badge]][goreport] [![][godoc-badge]][godoc]
RawKV is a cloud-native distributed key-value database aiming to run on Kubernetes clusters, with focuses on:
- Arbitrary raw bytes as keys and values
- Write-optimized storage engine based on log-structured merge-tree
- Reliable data replication with Raft consensus algorithm
- Favor availability over consistency in the presence of network partitions
## Installation
### Build
Pass unit tests:
```
go test ./pkg/...
```
Install RawKV client:
```
go install ./pkg/cmd/rawkvcli
```
Build docker image of RawKV server:
```
docker build -t rawkvsvr:latest .
```
### Deploy
RawKV requires a running Kubernetes cluster to function. Once the cluster has been established, start deployment:
```
kubectl apply -f rawkv.yaml
```
Get exposed port number of RawKV load balancer specified under `service/rawkv-lb`:
```
kubectl get -f rawkv.yaml
```
Use RawKV client `rawkvcli` to send requests to the load balancer:
```
$GOPATH/bin/rawkvcli put -addr 127.0.0.1: -key name -val rawkv
$GOPATH/bin/rawkvcli get -addr 127.0.0.1: -key name
$GOPATH/bin/rawkvcli del -addr 127.0.0.1: -key name
```
Stop services and clean up:
```
kubectl delete -f rawkv.yaml
kubectl delete pvc -l app=rawkv
```
### Debug
By default, [`rawkv.yaml`](./rawkv.yaml) creates three RawKV replicas:
```
kubectl get pods -l app=rawkv
```
View logs emitted from a replica (index starts with 0):
```
kubectl logs -f rawkv-
```
Delete a replica to simulate node crash:
```
kubectl delete pod rawkv-
```
## License
See the [LICENSE](./LICENSE) file for license rights and limitations.
[goreport]: https://goreportcard.com/report/github.com/chuyangliu/rawkv
[goreport-badge]: https://goreportcard.com/badge/github.com/chuyangliu/rawkv
[godoc]: https://pkg.go.dev/mod/github.com/chuyangliu/rawkv
[godoc-badge]: https://img.shields.io/badge/godoc-reference-blue