Google Git
Sign in
apache / incubator-horaedb-meta / refs/tags/v0.3.0
commit641d2f50c45e1df29143eba336a6ae15ca63b783[log] [tgz]
authorchunshao.rcs <chunshao.rcs@antgroup.com>Mon Aug 29 17:42:10 2022 +0800
committerGitHub <noreply@github.com>Mon Aug 29 17:42:10 2022 +0800
tree62cf0600b1a24148984a0af13a2059e8ee022c22
parent7b78a18b7e947589d420ee88491fc1f59476469a [diff]
chore: update README (#48)
1 file changed
tree: 62cf0600b1a24148984a0af13a2059e8ee022c22
  1. .github/
  2. cmd/
  3. docs/
  4. pkg/
  5. server/
  6. .gitignore
  7. .golangci.yml
  8. CONTRIBUTING.md
  9. go.mod
  10. go.sum
  11. LICENSE
  12. Makefile
  13. README.md
  14. revive.toml
  15. tools.go
README.md

Ceresmeta

License

CeresMeta is the meta service for managing the CeresDB cluster.

Status

The project is in a very early stage.

Quick Start

Build ceresmeta binary

make build

Standalone Mode

Although CeresMeta is designed to deployed as a cluster with three or more instances, it can also be started standalone:

# Set correct HostIP here.
export HostIP0="127.0.0.1"

# ceresmeta0
mkdir /tmp/ceresmeta0
./ceresmeta -etcd-start-timeout-ms 30000 \
            -peer-urls "http://${HostIP0}:2380" \
            -advertise-client-urls "http://${HostIP0}:2379" \
            -advertise-peer-urls "http://${HostIP0}:2380" \
            -client-urls "http://${HostIP0}:2379" \
            -wal-dir /tmp/ceresmeta0/wal \
            -data-dir /tmp/ceresmeta0/data \
            -node-name "meta0" \
            -etcd-log-file /tmp/ceresmeta0/etcd.log \
            -initial-cluster "meta0=http://${HostIP0}:2380"

Cluster mode

Here is an example for starting CeresMeta in cluster mode (three instances) on single machine by using different ports:

# Set correct HostIP here.
export HostIP0="127.0.0.1"
export HostIP1="127.0.0.1"
export HostIP2="127.0.0.1"

# ceresmeta0
mkdir /tmp/ceresmeta0
./ceresmeta -etcd-start-timeout-ms 30000 \
            -peer-urls "http://${HostIP0}:2380" \
            -advertise-client-urls "http://${HostIP0}:2379" \
            -advertise-peer-urls "http://${HostIP0}:2380" \
            -client-urls "http://${HostIP0}:2379" \
            -wal-dir /tmp/ceresmeta0/wal \
            -data-dir /tmp/ceresmeta0/data \
            -node-name "meta0" \
            -etcd-log-file /tmp/ceresmeta0/etcd.log \
            -initial-cluster "meta0=http://${HostIP0}:2380,meta1=http://${HostIP1}:12380,meta2=http://${HostIP2}:22380"

# ceresmeta1
mkdir /tmp/ceresmeta1
./ceresmeta -etcd-start-timeout-ms 30000 \
            -peer-urls "http://${HostIP1}:12380" \
            -advertise-client-urls "http://${HostIP1}:12379" \
            -advertise-peer-urls "http://${HostIP1}:12380" \
            -client-urls "http://${HostIP1}:12379" \
            -wal-dir /tmp/ceresmeta1/wal \
            -data-dir /tmp/ceresmeta1/data \
            -node-name "meta1" \
            -etcd-log-file /tmp/ceresmeta1/etcd.log \
            -initial-cluster "meta0=http://${HostIP0}:2380,meta1=http://${HostIP1}:12380,meta2=http://${HostIP2}:22380"

# ceresmeta2
mkdir /tmp/ceresmeta2
./ceresmeta -etcd-start-timeout-ms 30000 \
            -peer-urls "http://${HostIP2}:12380" \
            -advertise-client-urls "http://${HostIP2}:12379" \
            -advertise-peer-urls "http://${HostIP2}:12380" \
            -client-urls "http://${HostIP2}:12379" \
            -wal-dir /tmp/ceresmeta2/wal \
            -data-dir /tmp/ceresmeta2/data \
            -node-name "meta2" \
            -etcd-log-file /tmp/ceresmeta2/etcd.log \
            -initial-cluster "meta0=http://${HostIP0}:2380,meta1=http://${HostIP1}:12380,meta2=http://${HostIP2}:22380"

Acknowledgment

CeresMeta refers to the excellent project pd in design and some module and codes are forked from pd, thanks to the TiKV team.

Contributing

The project is under rapid development so that any contribution is welcome. Check our Contributing Guide and make your first contribution!

License

CeresMeta is under Apache License 2.0.