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

Update examples using Docker Compose #4857

Merged
merged 4 commits into from
Jul 11, 2024
Merged

Conversation

dreglad
Copy link
Contributor

@dreglad dreglad commented Jul 6, 2024

Pull Request Description

This PR updates the docker-compose and event-driven-architecture example README files to reflect updated commands and practices, along with minor text adjustments.

Details / Rationale

  1. Update to Docker Compose v2 Commands:

    • The README files previously used Docker Compose v1 commands (the standalone docker-compose command), which has passed its end-of-life. It has now been replaced by the built-in docker compose subcommands (removing the dash from docker-compose) and eliminated Docker Compose as a separate requirement since it is included with Docker.
  2. Replace docker system prune with docker compose down:

    • The previous instructions suggested using docker system prune --volumes to clear the environment. This command has been replaced with docker compose down --volumes. The earlier is potentially destructive as it affects all other containers and volumes, not just those related to the Apicurio Registry setup as intended. docker compose down is safer and the appropriate command for stopping and removing containers, networks, and volumes defined in the Docker Compose file without impacting other Docker resources on the user's system.

- Update to Docker Compose v2 commands.
- Replace `docker system prune` with `docker compose down`.
@apicurio-bot
Copy link

apicurio-bot bot commented Jul 6, 2024

Thank you for creating a pull request!

Pinging @andreaTP to respond or triage.

@dreglad dreglad changed the title Update docker-compose example README Update examples using Docker Compose Jul 7, 2024
Make docker-compose.yml name consistent between examples
@jsenko jsenko added area/documentation Documentation and removed triage/needs-triage labels Jul 8, 2024
@jsenko jsenko self-requested a review July 8, 2024 09:22
@EricWittmann EricWittmann merged commit a160baa into Apicurio:main Jul 11, 2024
1 check passed
@EricWittmann
Copy link
Member

Thanks for the updates! Much appreciated.

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

Successfully merging this pull request may close these issues.

3 participants