rust/neon
1
0
Fork 0
mirror of https://github.com/neondatabase/neon.git synced 2026-01-04 12:02:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
eee0f51e0c3ea2d52269741124b68b8dac0e051c
neon/compute_tools
History
Dmitry Rodionov eee0f51e0c use cargo-hakari to manage workspace_hack crate 
workspace_hack is needed to avoid recompilation when different crates
inside the workspace depend on the same packages but with different
features being enabled. Problem occurs when you build crates separately
one by one. So this is irrelevant to our CI setup because there we build
all binaries at once, but it may be relevant for local development.

this also changes cargo's resolver version to 2
2022-03-29 10:42:04 +03:00
..
src
Fix 1.59 rustc clippy warnings
2022-03-02 21:35:34 +02:00
tests
[compute_tools] Switch cluster_id in spec to string (zenithdb/console#72)
2021-12-29 16:35:29 +03:00
.dockerignore
Move compute_tools from console repo (zenithdb/console#383)
2021-12-28 20:17:29 +03:00
.gitignore
Move compute_tools from console repo (zenithdb/console#383)
2021-12-28 20:17:29 +03:00
Cargo.toml
use cargo-hakari to manage workspace_hack crate
2022-03-29 10:42:04 +03:00
README.md
Move compute_tools from console repo (zenithdb/console#383)
2021-12-28 20:17:29 +03:00
rustfmt.toml
Move compute_tools from console repo (zenithdb/console#383)
2021-12-28 20:17:29 +03:00

README.md

Compute node tools

Postgres wrapper (zenith_ctl) is intended to be run as a Docker entrypoint or as a systemd ExecStart option. It will handle all the zenith specifics during compute node initialization:

  • zenith_ctl accepts cluster (compute node) specification as a JSON file.
  • Every start is a fresh start, so the data directory is removed and initialized again on each run.
  • Next it will put configuration files into the PGDATA directory.
  • Sync safekeepers and get commit LSN.
  • Get basebackup from pageserver using the returned on the previous step LSN.
  • Try to start postgres and wait until it is ready to accept connections.
  • Check and alter/drop/create roles and databases.
  • Hang waiting on the postmaster process to exit.

Also zenith_ctl spawns two separate service threads:

  • compute-monitor checks the last Postgres activity timestamp and saves it into the shared ComputeState;
  • http-endpoint runs a Hyper HTTP API server, which serves readiness and the last activity requests.

Usage example:

zenith_ctl -D /var/db/postgres/compute \
           -C 'postgresql://zenith_admin@localhost/postgres' \
           -S /var/db/postgres/specs/current.json \
           -b /usr/local/bin/postgres

Tests

Cargo formatter:

cargo fmt

Run tests:

cargo test

Clippy linter:

cargo clippy --all --all-targets -- -Dwarnings -Drust-2018-idioms

Cross-platform compilation

Imaging that you are on macOS (x86) and you want a Linux GNU (x86_64-unknown-linux-gnu platform in rust terminology) executable.

Using docker

You can use a throw-away Docker container (rustlang/rust image) for doing that:

docker run --rm \
    -v $(pwd):/compute_tools \
    -w /compute_tools \
    -t rustlang/rust:nightly cargo build --release --target=x86_64-unknown-linux-gnu

or one-line:

docker run --rm -v $(pwd):/compute_tools -w /compute_tools -t rust:latest cargo build --release --target=x86_64-unknown-linux-gnu

Using rust native cross-compilation

Another way is to add x86_64-unknown-linux-gnu target on your host system:

rustup target add x86_64-unknown-linux-gnu

Install macOS cross-compiler toolchain:

brew tap SergioBenitez/osxct
brew install x86_64-unknown-linux-gnu

And finally run cargo build:

CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER=x86_64-unknown-linux-gnu-gcc cargo build --target=x86_64-unknown-linux-gnu --release