mirror of
https://github.com/neondatabase/neon.git
synced 2026-01-06 21:12:55 +00:00
Update README.md
This commit is contained in:
35
README.md
35
README.md
@@ -1,29 +1,14 @@
|
||||
# zenith
|
||||
# Zenith
|
||||
|
||||
This is the top level repo containing the following submodules
|
||||
Zenith substitutes PostgreSQL storage layer and redistributes data across a cluster of nodes
|
||||
|
||||
1. vendor/postgres - upstream postgres code
|
||||
* zenith branch contains our changes
|
||||
* These changes are relatively small and will be either upstreamed or
|
||||
moved to an extension
|
||||
|
||||
2. pageserver - the code that deals with buffer pages disaggregated from
|
||||
compute nodes.
|
||||
|
||||
3. walkeeper - the code that takes the WAL from postgres and signals to
|
||||
postgres when it's safe to consider a transaction committed.
|
||||
|
||||
4. consensus - Implement distributed consensus between compute and storage
|
||||
nodes.
|
||||
|
||||
5. cli - Tooling used to have a friendly workflow that allows migration to/from
|
||||
zenith storage system and cloud provider's object storage services.
|
||||
|
||||
Recommended workflow:
|
||||
## Running tests
|
||||
|
||||
```sh
|
||||
git clone --recursive https://github.com/libzenith/zenith.git
|
||||
./pgbuild.sh # builds postgres and installs it to ./tmp_install
|
||||
cargo test
|
||||
```
|
||||
$ git clone https://github.com/libzenith/zenith
|
||||
$ git submodule update --init --recursive
|
||||
$ cargo build
|
||||
$ cargo test
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user