irrdnet / irrd

IRRd version 4
http://irrd.readthedocs.io/en/stable/
Other
157 stars 52 forks source link

chore: adding Docker compose example/documentation #948

Open kiraum opened 6 months ago

kiraum commented 6 months ago

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:

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:

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

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

mxsasha commented 6 months ago

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 commented 6 months ago

@mxsasha Thanks for the quick answer, sorry I didn't noticed https://github.com/irrdnet/irrd/pull/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 commented 2 months ago

@mxsasha , should I close this PR?