Xline
A geo-distributed KV store for metadata management
File Explorer
Download Latest Version (.zip)- hakari.toml
- nextest.toml
- bug_report.yaml
- feature_request.yaml
- benchmark.yml
- build_env.yml
- build_xline.yml
- docker_image.yml
- gen_release_note.yml
- issue-cmds.yml
- issue-welcome.yml
- merge_image.yml
- pull_request.yml
- release.yml
- stale.yml
- validation.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- kind-node-xline.Dockerfile
- kind.yaml
- xline-pod.yaml
- Dockerfile.aarch64-unknown-linux-gnu
- Dockerfile.x86_64-unknown-linux-gnu
- check-trailing-spaces.sh
- install_macos_deps.sh
- kind.sh
- build-env.sh
- Dockerfile
- rust-toolchain.toml
- args.rs
- bench_client.rs
- lib.rs
- main.rs
- runner.rs
- Cargo.toml
- common
- inner_message.proto
- mod.rs
- propose_impl.rs
- metrics.rs
- mod.rs
- retry.rs
- state.rs
- stream.rs
- tests.rs
- connect.rs
- metrics.rs
- mod.rs
- reconnect.rs
- mod.rs
- mod.rs
- spec_pool_new.rs
- test_pools.rs
- tests.rs
- uncommitted_pool.rs
- log.rs
- mod.rs
- state.rs
- tests.rs
- mod.rs
- codec.rs
- config.rs
- error.rs
- framed.rs
- mod.rs
- pipeline.rs
- remover.rs
- segment.rs
- storage.rs
- test_util.rs
- tests.rs
- util.rs
- db.rs
- mod.rs
- cmd_board.rs
- curp_node.rs
- gc.rs
- lease_manager.rs
- metrics.rs
- mod.rs
- error.rs
- lib.rs
- log_entry.rs
- members.rs
- response.rs
- snapshot.rs
- tracker.rs
- curp_group.rs
- mod.rs
- main.rs
- server.rs
- curp.pdf
- curp.tla
- README.md
- build.rs
- Cargo.toml
- README.md
- cmd.rs
- conflict.rs
- lib.rs
- role_change.rs
- Cargo.toml
- README.md
- lib.rs
- test_cmd.rs
- Cargo.toml
- README.md
- engine_api.rs
- mod.rs
- operation.rs
- snapshot_api.rs
- transaction_api.rs
- mod.rs
- transaction.rs
- mod.rs
- transaction.rs
- error.rs
- lib.rs
- metrics.rs
- mock_rocksdb_engine.rs
- proxy.rs
- snapshot_allocator.rs
- Cargo.toml
- curp_group.rs
- lib.rs
- xline_group.rs
- mod.rs
- server_election.rs
- server_recovery.rs
- main.rs
- xline.rs
- Cargo.toml
- README.md
- no_abort.rs
- with_abort.rs
- lib.rs
- test_abort.rs
- Cargo.toml
- README.md
- mod.rs
- tasks.rs
- barrier.rs
- config.rs
- lca_tree.rs
- lib.rs
- metrics.rs
- parking_lot_lock.rs
- parser.rs
- std_lock.rs
- table_names.rs
- tokio_lock.rs
- tracing.rs
- Cargo.toml
- README.md
- mod.rs
- spec_pool.rs
- tests.rs
- uncommitted_pool.rs
- auth_server.rs
- auth_wrapper.rs
- cluster_server.rs
- command.rs
- kv_server.rs
- lease_server.rs
- lock_server.rs
- maintenance.rs
- mod.rs
- watch_server.rs
- xline_server.rs
- backend.rs
- mod.rs
- perms.rs
- store.rs
- mod.rs
- periodic_compactor.rs
- revision_compactor.rs
- lease.rs
- lease_collection.rs
- lease_queue.rs
- mod.rs
- alarm_store.rs
- db.rs
- index.rs
- kv_store.rs
- kvwatcher.rs
- mod.rs
- revision.rs
- storage_api.rs
- args.rs
- metrics.rs
- mod.rs
- trace.rs
- header_gen.rs
- id_gen.rs
- lib.rs
- main.rs
- metrics.rs
- restore.rs
- revision_check.rs
- revision_number.rs
- state.rs
- auth_test.rs
- cluster_test.rs
- kv_test.rs
- lease_test.rs
- lock_test.rs
- main.rs
- maintenance_test.rs
- tls_test.rs
- watch_test.rs
- Cargo.toml
- auth.rs
- auth_role.rs
- auth_user.rs
- cluster.rs
- error_handling.rs
- kv.rs
- lease.rs
- lock.rs
- maintenance.rs
- watch.rs
- auth.rs
- cluster.rs
- election.rs
- kv.rs
- lease.rs
- lock.rs
- maintenance.rs
- mod.rs
- watch.rs
- auth.rs
- kv.rs
- lease.rs
- mod.rs
- range_end.rs
- watch.rs
- error.rs
- lease_gen.rs
- lib.rs
- auth.rs
- common.rs
- kv.rs
- lease.rs
- lock.rs
- main.rs
- maintenance.rs
- watch.rs
- Cargo.toml
- README.md
- test_cluster.rs
- lib.rs
- Cargo.toml
- README.md
- classifier.rs
- command.rs
- execute_error.rs
- interval.rs
- lib.rs
- request_validation.rs
- build.rs
- Cargo.toml
- proto
- README.md
- disable.rs
- enable.rs
- mod.rs
- status.rs
- grant.rs
- keep_alive.rs
- list.rs
- mod.rs
- revoke.rs
- timetolive.rs
- add.rs
- list.rs
- mod.rs
- promote.rs
- remove.rs
- update.rs
- add.rs
- delete.rs
- get.rs
- grant_perm.rs
- list.rs
- mod.rs
- revoke_perm.rs
- add.rs
- delete.rs
- get.rs
- grant_role.rs
- list.rs
- mod.rs
- passwd.rs
- revoke_role.rs
- compaction.rs
- delete.rs
- get.rs
- lock.rs
- mod.rs
- put.rs
- snapshot.rs
- txn.rs
- watch.rs
- macros.rs
- mod.rs
- parser.rs
- printer.rs
- main.rs
- Cargo.toml
- README.md
- mod.rs
- snapshot.rs
- main.rs
- printer.rs
- Cargo.toml
- README.md
- cncf-logo.png
- prom_demo.png
- xline-horizontal-black.png
- xline-key-perf.png
- xline_test_deployment.jpg
- metrics.md
- QUICK_START.md
- ca.crt
- private.pem
- public.pem
- root_client.crt
- root_client.key
- server.crt
- server.key
- u1_client.crt
- u1_client.key
- u2_client.crt
- u2_client.key
- benchmark.sh
- certgen.sh
- common.sh
- Dockerfile
- log.sh
- prometheus.yml
- quick_start.sh
- validation_test.sh
- lib.rs
- .gitattributes
- build.rs
- Cargo.toml
- .dockerignore
- .gitignore
- .gitmodules
- .mergify.yml
- .pre-commit-config.yaml
- .typos.toml
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- cliff.toml
- clippy.toml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- Cross.toml
- LICENSE
- MAINTAINERS
- README.md
- rust-toolchain.toml
- VALIDATION_REPORT.md
- xline_server.conf
# Installation Guide
1. Get the code
git clone https://github.com/xline-kv/Xline
Downloads the entire project code from GitHub to your computer.
cd Xline
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f ci/Dockerfile -t xline .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 xline
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)