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

docs(docker): update examples for running Zebra in Docker #9269

Merged
merged 23 commits into from
Feb 19, 2025

Conversation

upbqdn
Copy link
Member

@upbqdn upbqdn commented Feb 18, 2025

Motivation

Update our Docker docs to reflect the changes in #8923.

Solution

  • Update the Docker chapter in the Zebra book.
    • Add information on configuring Zebra, enabling the RPC server, and disabling the cookie authentication.
    • Add information on running Zebra with Prometheus and Grafana.
  • Update the chapter on mining with Zebra in Docker.
  • Prepare a new docker/.env file.
  • Prepare a new docker/test.env file.
  • Rename default_zebra_conf.toml to default-zebra-conf.toml.
  • Make the cookie authentication easily configurable.
  • Add a new docker compose file for running Zebra with Prometheus and Grafana.
  • Update the default docker compose file.
  • Update the docker compose file for running Zebra with lwd.
  • Update the docker compose file for running CI tests locally.
  • Fix a bug where the entrypoint would try to write to a mounted config file. The fix consists of copying the config file to a new location in the container and then writing to it. This change made the CI tests that check the loading of custom conf files fail because they were relying on file paths. I updated them so they check the content of the loaded conf file.

Tests

  • Locally tested all commands stated in the updated docs.
  • Locally tested all docker compose files.

PR Author's Checklist

  • The PR name will make sense to users.
  • The PR provides a CHANGELOG summary.
  • The solution is tested.
  • The documentation is up to date.
  • The PR has a priority label.

PR Reviewer's Checklist

  • The PR Author's checklist is complete.
  • The PR resolves the issue.

@upbqdn upbqdn added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles P-Medium ⚡ labels Feb 18, 2025
@upbqdn upbqdn self-assigned this Feb 18, 2025
@upbqdn upbqdn requested review from a team as code owners February 18, 2025 14:47
@upbqdn upbqdn requested review from gustavovalverde and arya2 and removed request for a team February 18, 2025 14:47
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Feb 18, 2025
Copy link
Member

@gustavovalverde gustavovalverde left a comment

Choose a reason for hiding this comment

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

This is great @upbqdn. Thank you!!

@gustavovalverde gustavovalverde changed the title Update docs and examples for running Zebra in Docker docs(docker): update examples for running Zebra in Docker Feb 19, 2025
@gustavovalverde gustavovalverde merged commit ac25192 into main Feb 19, 2025
167 of 168 checks passed
@gustavovalverde gustavovalverde deleted the refactor-docker-docs branch February 19, 2025 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation P-Critical 🚑
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove CI functionality related to experimental features
2 participants