garage/src/util/Cargo.toml

[package]
name = "garage_util"
version = "0.8.1"
authors = ["Alex Auvolat <alex@adnab.me>"]
edition = "2018"
license = "AGPL-3.0"
description = "Utility crate for the Garage object store"
repository = "https://git.deuxfleurs.fr/Deuxfleurs/garage"
readme = "../../README.md"

[lib]
path = "lib.rs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
garage_db = { version = "0.8.1", path = "../db" }

arc-swap = "1.0"
async-trait = "0.1"
blake2 = "0.9"
bytes = "1.0"
digest = "0.10"
err-derive = "0.3"
git-version = "0.3.4"
hexdump = "0.1"
xxhash-rust = { version = "0.8", default-features = false, features = ["xxh3"] }
hex = "0.4"
lazy_static = "1.4"
tracing = "0.1.30"
rand = "0.8"
sha2 = "0.10"

chrono = "0.4"
rmp-serde = "0.15"
serde = { version = "1.0", default-features = false, features = ["derive", "rc"] }
serde_json = "1.0"
toml = "0.6"

futures = "0.3"
tokio = { version = "1.0", default-features = false, features = ["rt", "rt-multi-thread", "io-util", "net", "time", "macros", "sync", "signal", "fs"] }

netapp = "0.5"

http = "0.2"
hyper = "0.14"

opentelemetry = { version = "0.17", features = [ "rt-tokio", "metrics", "trace" ] }

[dev-dependencies]
mktemp = "0.4"

[features]
k2v = []
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`[package]`
			`name = "garage_util"`
Bump everything to v0.8.1 2023-01-02 13:15:33 +00:00			`version = "0.8.1"`
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`authors = ["Alex Auvolat <alex@adnab.me>"]`
			`edition = "2018"`
Update Cargo.toml files with AGPL license info 2021-03-18 20:59:17 +00:00			`license = "AGPL-3.0"`
Add license, description and repository to .toml files 2020-07-07 12:14:58 +00:00			`description = "Utility crate for the Garage object store"`
			`repository = "https://git.deuxfleurs.fr/Deuxfleurs/garage"`
Improve how node roles are assigned in Garage - change the terminology: the network configuration becomes the role table, the configuration of a nodes becomes a node's role - the modification of the role table takes place in two steps: first, changes are staged in a CRDT data structure. Then, once the user is happy with the changes, they can commit them all at once (or revert them). - update documentation - fix tests - implement smarter partition assignation algorithm This patch breaks the format of the network configuration: when migrating, the cluster will be in a state where no roles are assigned. All roles must be re-assigned and commited at once. This migration should not pose an issue. 2021-11-09 11:24:04 +00:00			`readme = "../../README.md"`
Split code for modular compilation 2020-04-24 10:10:01 +00:00
			`[lib]`
			`path = "lib.rs"`

			`# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html`

			`[dependencies]`
Bump everything to v0.8.1 2023-01-02 13:15:33 +00:00			`garage_db = { version = "0.8.1", path = "../db" }`
Abstract database behind generic interface and implement alternative drivers (#322) - [x] Design interface - [x] Implement Sled backend - [x] Re-implement the SledCountedTree hack ~~on Sled backend~~ on all backends (i.e. over the abstraction) - [x] Convert Garage code to use generic interface - [x] Proof-read converted Garage code - [ ] Test everything well - [x] Implement sqlite backend - [x] Implement LMDB backend - [ ] (Implement Persy backend?) - [ ] (Implement other backends? (like RocksDB, ...)) - [x] Implement backend choice in config file and garage server module - [x] Add CLI for converting between DB formats - Exploit the new interface to put more things in transactions - [x] `.updated()` trigger on Garage tables Fix #284 Bugs - [x] When exporting sqlite, trees iterate empty?? - [x] LMDB doesn't work Known issues for various back-ends - Sled: - Eats all my RAM and also all my disk space - `.len()` has to traverse the whole table - Is actually quite slow on some operations - And is actually pretty bad code... - Sqlite: - Requires a lock to be taken on all operations. The lock is also taken when iterating on a table with `.iter()`, and the lock isn't released until the iterator is dropped. This means that we must be VERY carefull to not do anything else inside a `.iter()` loop or else we will have a deadlock! Most such cases have been eliminated from the Garage codebase, but there might still be some that remain. If your Garage-over-Sqlite seems to hang/freeze, this is the reason. - (adapter uses a bunch of unsafe code) - Heed (LMDB): - Not suited for 32-bit machines as it has to map the whole DB in memory. - (adpater uses a tiny bit of unsafe code) My recommendation: avoid 32-bit machines and use LMDB as much as possible. Converting databases is actually quite easy. For example from Sled to LMDB: ```bash cd src/db cargo run --features cli --bin convert -- -i path/to/garage/meta/db -a sled -o path/to/garage/meta/db.lmdb -b lmdb ``` Then, just add this to your `config.toml`: ```toml db_engine = "lmdb" ``` Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/322 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me> 2022-06-08 08:01:44 +00:00
Move version back into util 2022-09-07 16:36:46 +00:00			`arc-swap = "1.0"`
Background task manager (#332) - [x] New background worker trait - [x] Adapt all current workers to use new API - [x] Command to list currently running workers, and whether they are active, idle, or dead - [x] Error reporting - Optimizations - [x] Merkle updater: several items per iteration - [ ] Use `tokio::task::spawn_blocking` where appropriate so that CPU-intensive tasks don't block other things going on - scrub: - [x] have only one worker with a channel to start/pause/cancel - [x] automatic scrub - [x] ability to view and change tranquility from CLI - [x] persistence of a few info - [ ] Testing Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/332 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me> 2022-07-08 11:30:26 +00:00			`async-trait = "0.1"`
Add blake2 and xxhash hash functions 2021-02-23 16:52:28 +00:00			`blake2 = "0.9"`
Compute hashes on dedicated threads 2022-07-18 15:18:47 +00:00			`bytes = "1.0"`
			`digest = "0.10"`
Update dependencies 2021-03-16 14:58:40 +00:00			`err-derive = "0.3"`
Move version back into util 2022-09-07 16:36:46 +00:00			`git-version = "0.3.4"`
Refactor how things are migrated 2023-01-03 13:44:47 +00:00			`hexdump = "0.1"`
Support old CPUs 2021-03-19 11:19:40 +00:00			`xxhash-rust = { version = "0.8", default-features = false, features = ["xxh3"] }`
Update Cargo.toml files with AGPL license info 2021-03-18 20:59:17 +00:00			`hex = "0.4"`
Move version back into util 2022-09-07 16:36:46 +00:00			`lazy_static = "1.4"`
Add tracing integration with opentelemetry 2022-02-17 22:28:23 +00:00			`tracing = "0.1.30"`
Update Cargo.toml files with AGPL license info 2021-03-18 20:59:17 +00:00			`rand = "0.8"`
Compute hashes on dedicated threads 2022-07-18 15:18:47 +00:00			`sha2 = "0.10"`
Split code for modular compilation 2020-04-24 10:10:01 +00:00
Update Cargo.toml files with AGPL license info 2021-03-18 20:59:17 +00:00			`chrono = "0.4"`
Update dependencies 2021-03-16 14:58:40 +00:00			`rmp-serde = "0.15"`
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`serde = { version = "1.0", default-features = false, features = ["derive", "rc"] }`
			`serde_json = "1.0"`
{garage,util}/Cargo.toml: Updated toml from 0.5 to 0.6. 2023-01-23 22:00:17 +00:00			`toml = "0.6"`
Split code for modular compilation 2020-04-24 10:10:01 +00:00
			`futures = "0.3"`
WIP migrate to tokio 1 2021-03-15 21:36:41 +00:00			`tokio = { version = "1.0", default-features = false, features = ["rt", "rt-multi-thread", "io-util", "net", "time", "macros", "sync", "signal", "fs"] }`
Split code for modular compilation 2020-04-24 10:10:01 +00:00
Use netapp 0.5 published from crates.io 2022-09-13 11:11:44 +00:00			`netapp = "0.5"`
Use published netapp crate instead of git repo 2021-10-26 08:36:57 +00:00
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`http = "0.2"`
WIP migrate to tokio 1 2021-03-15 21:36:41 +00:00			`hyper = "0.14"`
add support for kubernetes service discovery This commit adds support to discover garage instances running in kubernetes. Once enabled by setting `kubernetes_namespace` and `kubernetes_service_name` garage will create a Custom Resources `garagenodes.deuxfleurs.fr` with nodes public key as the resource name. and IP and Port information as spec in the namespace configured by `kubernetes_namespace`. For discovering nodes the resources are filtered with the optionally set `kubernetes_service_name` which sets a label `garage.deuxfleurs.fr/service` on the resources. This allows to separate multiple garage deployments in a single namespace. the `kubernetes_skip_crd` variable allows to disable the creation of the CRD by garage itself. The user must deploy this manually. 2022-03-06 13:50:00 +00:00
Add missing opentelemetry features 2022-04-08 12:21:04 +00:00			`opentelemetry = { version = "0.17", features = [ "rt-tokio", "metrics", "trace" ] }`
First implementation of K2V (#293) Specification: View spec at [this URL](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/k2v/doc/drafts/k2v-spec.md) - [x] Specify the structure of K2V triples - [x] Specify the DVVS format used for causality detection - [x] Specify the K2V index (just a counter of number of values per partition key) - [x] Specify single-item endpoints: ReadItem, InsertItem, DeleteItem - [x] Specify index endpoint: ReadIndex - [x] Specify multi-item endpoints: InsertBatch, ReadBatch, DeleteBatch - [x] Move to JSON objects instead of tuples - [x] Specify endpoints for polling for updates on single values (PollItem) Implementation: - [x] Table for K2V items, causal contexts - [x] Indexing mechanism and table for K2V index - [x] Make API handlers a bit more generic - [x] K2V API endpoint - [x] K2V API router - [x] ReadItem - [x] InsertItem - [x] DeleteItem - [x] PollItem - [x] ReadIndex - [x] InsertBatch - [x] ReadBatch - [x] DeleteBatch Testing: - [x] Just a simple Python script that does some requests to check visually that things are going right (does not contain parsing of results or assertions on returned values) - [x] Actual tests: - [x] Adapt testing framework - [x] Simple test with InsertItem + ReadItem - [x] Test with several Insert/Read/DeleteItem + ReadIndex - [x] Test all combinations of return formats for ReadItem - [x] Test with ReadBatch, InsertBatch, DeleteBatch - [x] Test with PollItem - [x] Test error codes - [ ] Fix most broken stuff - [x] test PollItem broken randomly - [x] when invalid causality tokens are given, errors should be 4xx not 5xx Improvements: - [x] Descending range queries - [x] Specify - [x] Implement - [x] Add test - [x] Batch updates to index counter - [x] Put K2V behind `k2v` feature flag Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/293 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me> 2022-05-10 11:16:57 +00:00
Add tests for `rpc_secret_file` 2023-01-07 12:49:15 +00:00			`[dev-dependencies]`
			`mktemp = "0.4"`
Configure structopt to report the right version By default, structopt reports the value provided by the env var CARGO_PKG_VERSION, feeded by Cargo when reading Cargo.toml. However for Garage we use a versioning based on git, so we often report a version that is behind the real version. In this commit, we create garage_util::version::garage() that reports the right version and configure all structopt subcommands to call this function instead of using the env var. 2022-08-10 10:18:44 +00:00
First implementation of K2V (#293) Specification: View spec at [this URL](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/k2v/doc/drafts/k2v-spec.md) - [x] Specify the structure of K2V triples - [x] Specify the DVVS format used for causality detection - [x] Specify the K2V index (just a counter of number of values per partition key) - [x] Specify single-item endpoints: ReadItem, InsertItem, DeleteItem - [x] Specify index endpoint: ReadIndex - [x] Specify multi-item endpoints: InsertBatch, ReadBatch, DeleteBatch - [x] Move to JSON objects instead of tuples - [x] Specify endpoints for polling for updates on single values (PollItem) Implementation: - [x] Table for K2V items, causal contexts - [x] Indexing mechanism and table for K2V index - [x] Make API handlers a bit more generic - [x] K2V API endpoint - [x] K2V API router - [x] ReadItem - [x] InsertItem - [x] DeleteItem - [x] PollItem - [x] ReadIndex - [x] InsertBatch - [x] ReadBatch - [x] DeleteBatch Testing: - [x] Just a simple Python script that does some requests to check visually that things are going right (does not contain parsing of results or assertions on returned values) - [x] Actual tests: - [x] Adapt testing framework - [x] Simple test with InsertItem + ReadItem - [x] Test with several Insert/Read/DeleteItem + ReadIndex - [x] Test all combinations of return formats for ReadItem - [x] Test with ReadBatch, InsertBatch, DeleteBatch - [x] Test with PollItem - [x] Test error codes - [ ] Fix most broken stuff - [x] test PollItem broken randomly - [x] when invalid causality tokens are given, errors should be 4xx not 5xx Improvements: - [x] Descending range queries - [x] Specify - [x] Implement - [x] Add test - [x] Batch updates to index counter - [x] Put K2V behind `k2v` feature flag Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/293 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me> 2022-05-10 11:16:57 +00:00			`[features]`
			`k2v = []`