bcb52f8548
* ci(tests): use create-with-container for integration test deployment
Refactors the `sub-deploy-integration-tests-gcp.yml` workflow to launch the Zebra test container directly using `gcloud compute instances create-with-container`. This replaces the previous method of launching a `busybox` container and then using `docker run` via SSH.
Key changes include:
- Replaced `busybox` + `docker run` with `create-with-container` using the specific test image (`${{ vars.CI_IMAGE_NAME }}`).
- Removed separate "Format volume" and "Launch test" steps.
- Configured container environment variables and disk mounts directly via `gcloud` parameters.
- Reverted log checking and retrieval steps back to the SSH + `docker logs`/`docker wait` approach after experimenting with Cloud Logging, adapting them to find the container ID dynamically.
This aligns the instance creation part more closely with the `cd-deploy-nodes-gcp.yml` workflow and removes the indirection layer of the `busybox` container, while retaining the familiar SSH-based log monitoring.
* chore: fix
* fix(deploy): use trimmed image
* fix(deploy): use specific dynamic name
* fix: typo
* fix(deploy): do not double wait for logs
* fix: better deployment configurations
* chore: exit status handling to avoid false-positives
* Update .github/workflows/sub-deploy-integration-tests-gcp.yml
Co-authored-by: Arya <aryasolhi@gmail.com>
---------
Co-authored-by: Arya <aryasolhi@gmail.com>
|
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| docker | ||
| docs/decisions | ||
| grafana | ||
| supply-chain | ||
| tower-batch-control | ||
| tower-fallback | ||
| zebra-chain | ||
| zebra-consensus | ||
| zebra-grpc | ||
| zebra-network | ||
| zebra-node-services | ||
| zebra-rpc | ||
| zebra-scan | ||
| zebra-script | ||
| zebra-state | ||
| zebra-test | ||
| zebra-utils | ||
| zebrad | ||
| .codespellrc | ||
| .dockerignore | ||
| .firebaserc | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| SECURITY.md | ||
| clippy.toml | ||
| codecov.yml | ||
| deny.toml | ||
| firebase.json | ||
| katex-header.html | ||
| openapi.yaml | ||
| prometheus.yaml | ||
| release.toml | ||
| rust-toolchain.toml | ||
README.md
Zebra is a Zcash full-node written in Rust.
Getting Started
You can run Zebra using our Docker image or you can build it manually.
Docker
This command will run our latest release, and sync it to the tip:
docker run zfnd/zebra:latest
For more information, read our Docker documentation.
Manual Build
Building Zebra requires Rust, libclang, and a C++ compiler. Below are quick summaries for installing the dependencies.
General instructions for installing dependencies
-
Install
cargoandrustc. -
Install Zebra's build dependencies:
- libclang is a library that might have different names depending on your
package manager. Typical names are
libclang,libclang-dev,llvm, orllvm-dev. - clang or another C++ compiler:
g++(all platforms) orXcode(macOS). protoc
- libclang is a library that might have different names depending on your
package manager. Typical names are
[!NOTE] Zebra uses the
--experimental_allow_proto3_optionalflag withprotocduring compilation. This flag was introduced in Protocol Buffers v3.12.0 released in May 16, 2020, so make sure you're not using a version ofprotocolder than 3.12.
Dependencies on Arch
sudo pacman -S rust clang protobuf
Note that the package clang includes libclang as well as the C++ compiler.
Recently the GCC version on Arch has broken a build script in the rocksdb dependency. A workaround is:
export CXXFLAGS="$CXXFLAGS -include cstdint"
Once you have the dependencies in place, you can build and install Zebra with:
cargo install --locked zebrad
You can start Zebra by running
zebrad start
Refer to the Installing Zebra and Running Zebra sections in the book for enabling optional features, detailed configuration and further details.
CI/CD Architecture
Zebra uses a comprehensive CI/CD system built on GitHub Actions to ensure code quality, maintain stability, and automate routine tasks. Our CI/CD infrastructure:
- Runs automated tests on every PR and commit.
- Manages deployments to various environments.
- Handles cross-platform compatibility checks.
- Automates release processes.
For a detailed understanding of our CI/CD system, including workflow diagrams, infrastructure details, and best practices, see our CI/CD Architecture Documentation.
Documentation
The Zcash Foundation maintains the following resources documenting Zebra:
-
The Zebra Book:
-
The documentation of the public APIs for the latest releases of the individual Zebra crates.
-
The documentation of the internal APIs for the
mainbranch of the whole Zebra monorepo.
User support
If Zebra doesn't behave the way you expected, open an issue. We regularly triage new issues and we will respond. We maintain a list of known issues in the Troubleshooting section of the book.
If you want to chat with us, Join the Zcash Foundation Discord Server and find the "zebra-support" channel.
Security
Zebra has a responsible disclosure policy, which we encourage security researchers to follow.
License
Zebra is distributed under the terms of both the MIT license and the Apache License (Version 2.0). Some Zebra crates are distributed under the MIT license only, because some of their code was originally from MIT-licensed projects. See each crate's directory for details.
See LICENSE-APACHE and LICENSE-MIT.