From 5d1b76e031d53b3cce6971ecfd645bd739200c1c Mon Sep 17 00:00:00 2001 From: iGxnon Date: Wed, 30 Oct 2024 17:24:23 +0800 Subject: [PATCH] chore: remove redundant stuff Signed-off-by: iGxnon --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- .github/workflows/benchmark.yml | 11 --- .github/workflows/validation.yml | 11 --- CHANGELOG.md | 6 +- USAGE.md | 84 --------------------- 6 files changed, 3 insertions(+), 113 deletions(-) delete mode 100644 USAGE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 2b4c7532b..b44cea89b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -46,7 +46,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/datenlord/Xline/blob/master/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/xline-kv/Xline/blob/master/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 46594997e..400bb7d74 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -23,7 +23,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/datenlord/Xline/blob/master/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/xline-kv/Xline/blob/master/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml index 8d38ad63e..8c489334f 100644 --- a/.github/workflows/benchmark.yml +++ b/.github/workflows/benchmark.yml @@ -10,17 +10,6 @@ env: jobs: benchmark: - name: benchmark - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - submodules: recursive - - - name: Setup sccache-cache - uses: mozilla-actions/sccache-action@v0.0.5 - - call_build_xline: name: Build and Upload Artifacts uses: ./.github/workflows/build_xline.yml with: diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml index cef9c3851..053808f10 100644 --- a/.github/workflows/validation.yml +++ b/.github/workflows/validation.yml @@ -9,17 +9,6 @@ on: jobs: validation: - name: Validation - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - submodules: recursive - - - name: Setup sccache-cache - uses: mozilla-actions/sccache-action@v0.0.5 - - call_build_xline: name: Build and Upload Artifacts uses: ./.github/workflows/build_xline.yml with: diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fc36d72b..c8db39b79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -252,16 +252,12 @@ Existing distributed KV stores mostly adopt the `Raft` consensus protocol, which - basic `Xline` client (use `Curp` directly) - benchmark tool -### Usage -[Usage doc](./USAGE.md) - ### Note In this release, we only provide binary files for X86_64 linux. Other platforms need to be compiled by yourself. we will add more support in the future. - ### Links -- GitHub: https://github.com/datenlord/Xline +- GitHub: https://github.com/xline-kv/Xline - Crate: https://crates.io/crates/xline - Docs: https://docs.rs/xline - Paper of Curp: https://www.usenix.org/system/files/nsdi19-park.pdf diff --git a/USAGE.md b/USAGE.md deleted file mode 100644 index 44c208c32..000000000 --- a/USAGE.md +++ /dev/null @@ -1,84 +0,0 @@ -# Usage - -## Configurations - -The Xline configuration file is written in toml format and the default path is `/etc/xline_server`.conf. If you need to change the path of the configuration file, you can set it via the environment variable `XLINE_SERVER_CONFIG`. - -The configuration file has four sections, as follows: - -1. cluster section: contains information about curp cluster, including basic information, cluster member configuration, curp server timeout settings (optional), curp client timeout settings (optional). -2. log section: contains the Xline log-related configuration, where path is required, rotation (optional, default value is `daily`), level (optional, default value is `info`) -3. trace section: contains the jaeger's trace mode (online or offline), trace level and the log directory in offline mode -4. auth section: contains the address of the key pair required for authentication - -A minimum config file looks like: - -```toml -[cluster] -name = 'node1' # server identity -is_leader = true # leader flag which indicates that the current server - # is a leader or not when booting up a cluster - -[cluster.members] -node1 = '127.0.0.1:2379' # the server name and its address -node2 = '127.0.0.1:2380' -node3 = '127.0.0.1:2381' - -[log] -path = '/var/log/xline' - -[trace] -jaeger_online = false # jaeger tracing online pattern -jaeger_offline = false # jaeger tracing offline pattern -jaeger_output_dir = 'var/log/xline/jaeger_jsons' -jaeger_level = 'info' # tracing log level - -[auth] -auth_public_key = '/etc/xline/public_key.pem' -auth_private_key = '/etc/xline/private_key.pem' -``` - -For tuning and development purpose, the cluster section provides two subsections, curp_cfg, and client_config, with the following definitions and default values. - -```toml -[cluster.curp_config] -heartbeat_interval = '300ms' # the curp heartbeat(tick) interval of which default value is 300ms -wait_synced_timeout = '5s' # server wait synced timeout -rpc_timeout = '50ms' # the rpc timeout of which default value is 50ms -retry_timeout = '50ms' # the rpc retry interval of which default value is 50ms -follower_timeout_ticks = 5 # if a follower cannot receive heartbeats from a leader during - # after `follower_timeout_ticks` ticks, then it will issue an - # election. Its default value is 5. -candidate_timeout_ticks = 2 # if a candidate cannot win an election, it will retry election - # after `candidate_timeout_ticks` ticks. Its default value is 2 - - -[cluster.client_config] -propose_timeout = '1s' # client propose timeout -wait_synced_timeout = '2s' # client wait synced timeout -retry_timeout = '50ms' # the rpc retry interval, of which the default is 50ms -``` - -## Boot up an Xline cluster - -1. Download binary from [release](https://github.com/xline-kv/Xline/releases) page. -2. Use the following command to start cluster: - - ```bash - # Run in 3 terminals. If you want more logs, add `RUST_LOG=curp=debug,xline=debug` before the command. - - ./xline --name node1 --members node1=127.0.0.1:2379,node2=127.0.0.1:2380,node3=127.0.0.1:2381 --is-leader - - ./xline --name node2 --members node1=127.0.0.1:2379,node2=127.0.0.1:2380,node3=127.0.0.1:2381 - - ./xline --name node3 --members node1=127.0.0.1:2379,node2=127.0.0.1:2380,node3=127.0.0.1:2381 - ``` - -3. Download or build `etcdctl` from [etcd](https://github.com/etcd-io/etcd) project. -4. Use `etcdctl` to operate the cluster: - - ```bash - etcdctl --endpoints=http://127.0.0.1:2379 put foo bar - - etcdctl --endpoints=http://127.0.0.1:2379 get foo - ```