README_en.md

中文版

CURVE

CURVE is a distributed storage system designed and developed independently by NetEase, featured with high performance, high availability, high reliability and well expansibility, and it can serve as the basis for storage systems designed for different scenario (e.g. block storage, object storage and cloud database).

So far, we have implemented a high performance block storage system, which supports snapshot, clone and recovery, and it can be attached on QEMU virtual machine or physical machine (by curve-nbd). CURVE has been served as an elastic block storage service inside NetEase for a certain time, during which high performance and reliability have shown.

Design Documentation

• Wanna have a glance at CURVE? Click here for Intro to CURVE!
• Want more details? Our documentation for every component:
  • NEBD
  • MDS
  • Chunkserver
  • Snapshotcloneserver
  • CURVE quality control
  • CURVE monitoring
  • Client
  • Client Python API
• Application based on CURVE
  • Work with k8s

Quick Start

Want to try on it? Take it easy! We'll help you step by step, but make sure you've read this Special Statement before you start.

Deploy an all-in-one environment (to try how CURVE works)

Deploy on single machine

Deploy multi-machine cluster (try it in production environment)

Deploy on multiple machines

curve_ops_tool introduction

curve_ops_tool introduction

For Developers

Deploy build and development environment

development environment deployment

Compile test cases and run

test cases compiling and running

Coding style guides

CURVE is coded following Google C++ Style Guide strictly. Please follow this guideline if you're trying to contribute your codes.

Code coverage requirement

1. Unit tests: Incremental line coverage ≥ 80%, incremental branch coverage ≥ 70%
2. Integration tests: Measure together with unit tests, and should fulfill the same requirement
3. Exception tests: Not required yet

Other processes

After finishing the development of your code, you should submit a pull request to master branch of CURVE and fill out a pull request template. The pull request will trigger the CI automatically, and the code will only be merged after passing the CI and being reviewed.

For more detail, please refer to CONTRIBUTING.

Release Cycle

• CURVE release cycle：Half a year for major version, 1~2 months for minor version

• Versioning format: We use a sequence of three digits and a suffix (x.y.z{-suffix}), x is the major version, y is the minor version, and z is for bugfix. The suffix is for distinguishing beta (-beta), RC (-rc) and GA version (without any suffix). Major version x will increase 1 every half year, and y will increase every 1~2 months. After a version is released, number z will increase if there's any bugfix.

Branch

All the developments will be done under master branch. If there's any new version to establish, a new branch release-x.y will be pulled from the master, and the new version will be released from this branch.

Feedback & Contact

• Github Issues：You are sincerely welcomed to issue any bugs you came across or any suggestions through Github issues. If you have any question you can refer to our FAQ or join our user group for more details.
• FAQ：Frequently asked question in our user group, and we'll keep working on it.
• User group：We use Wechat group currently.