Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ldb RocksDB query tool to the Dockerfile #8074

Merged
merged 5 commits into from
Dec 8, 2023
Merged

Add ldb RocksDB query tool to the Dockerfile #8074

merged 5 commits into from
Dec 8, 2023

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Dec 7, 2023

Motivation

This adds the ldb RocksDB tool to support expert users querying scanner databases in Docker images. It's also useful for diagnosing chain state database issues in Docker images.

Close #8051.
Initial framework for #8046.

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?
For significant changes:
  • Is there a summary in the CHANGELOG?
  • Can these changes be split into multiple PRs?

If a checkbox isn't relevant to the PR, mark it as done.

I expect we'll deal with the changelog in the docs ticket #8046.

Debian Package File List

https://packages.debian.org/bullseye/amd64/rocksdb-tools/filelist

Complex Code or Requirements

This adds around 30 MB to the size of the Docker image. But it's already around 1 GB, so that doesn't matter much.

Solution

  • Add the RocksDB tools to the test, experimental, and non-experimental production Docker images
  • Add a rough framework for a scanner doc, and link to it from other docs
  • Add an install doc for the ldb tool

Testing

This image is built in every Rust PR.

Review

This is a routine change.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

Follow Up Work

@teor2345 teor2345 added A-dependencies Area: Dependency file updates C-enhancement Category: This is an improvement P-Medium ⚡ I-usability Zebra is hard to understand or use A-blockchain-scanner Area: Blockchain scanner of shielded transactions labels Dec 7, 2023
@teor2345 teor2345 self-assigned this Dec 7, 2023
@teor2345 teor2345 requested a review from a team as a code owner December 7, 2023 20:52
@teor2345 teor2345 requested review from arya2 and removed request for a team December 7, 2023 20:52
@teor2345 teor2345 requested a review from a team as a code owner December 7, 2023 20:55
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mergify mergify bot merged commit 5dd33d7 into main Dec 8, 2023
149 checks passed
@mergify mergify bot deleted the docker-ldb branch December 8, 2023 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-blockchain-scanner Area: Blockchain scanner of shielded transactions A-dependencies Area: Dependency file updates C-enhancement Category: This is an improvement I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the RocksDB ldb tool to the Docker image, so technical users can query the database
2 participants