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

chore: adding Docker compose example/documentation #948

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kiraum
Copy link

@kiraum kiraum commented May 12, 2024

In a nutshell

We are adding Docker Compose support for deploying IRRd, adding necessary Docker configurations, initialisation scripts, and updates to the documentation. It also includes updates to the .gitignore to exclude Docker-related data directories.

Changes

Docker Compose Integration:

  • Dockerfile: Configures a Python 3.12.3 environment and sets up IRRd.
  • docker-compose.yml: Orchestrates the deployment of IRRd with PostgreSQL and Redis, ensuring a cohesive operation of services.
  • init.sh: Script to initialize the IRRd service within the Docker container.
  • irrd.yaml: Provides a Docker-specific configuration template for IRRd.

Documentation Update:

Updated deployment.rst to include a new section detailing the setup process using Docker Compose, aimed at simplifying the deployment of IRRd.

.gitignore update:

  • Added irrd/docker/data to prevent tracking of Docker volume data.

Impact

Facilitates the deployment of IRRd using Docker Compose, ensuring a consistent and isolated environment.
Enhances the documentation to provide clear, step-by-step instructions for Docker Compose deployment.

Testing

  • Test the Docker Compose build and deployment process.
  • Validate the functionality of IRRd in the Dockerized environment.

This update introduces a deployment example for IRRd along with the required infrastructure, simplifying and accelerating the service deployment process.

@mxsasha
Copy link
Collaborator

mxsasha commented May 12, 2024

Thanks for the PR! I will try to review this in more detail soon. There is another Docker PR in #926, and I've left some comments there with my thoughts on that implementation.

One request up front: it seems the PRs I've been seeing from you all have summaries written by an LLM. Could you just write them yourself? They have a verboseness to them that makes me want to put them back into an LLM to extract the key points ;)
For example, no need to specifically document that a .gitignore file was changed, or that the purpose is to simplify and accelerate the service deployment process. Nor was it needed to write that a Docker compose file works for "ensuring a cohesive operation of services".

@kiraum
Copy link
Author

kiraum commented May 12, 2024

@mxsasha Thanks for the quick answer, sorry I didn't noticed #926. I already had something ready, so just decided to raise the PR here, if doubts/questions let me know. Also, if you think/prefer to move forward with #926, feel free to close this one, no problems at all. :)
And about the PR description, noted for next time, and I totally agree that's too verbose, I also prefer quick points, but on another repos/projects, I already heard many times that my description wasn't verbose enough. 🤷‍♂️

@kiraum kiraum changed the title chore: Adding Docker compose example/documentation chore: adding Docker compose example/documentation May 12, 2024
@kiraum
Copy link
Author

kiraum commented Sep 28, 2024

@mxsasha , should I close this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants