Add new make target to remove docker volumes along with containers

[saltykheera]

closes #2657

@sainak

Summary by CodeRabbit

• New Features

  • Introduced a teardown command for cleaning up Docker containers and associated volumes.
  • Added new commands in the README for managing Docker containers: make down and make teardown.

• Documentation

  • Updated README.md with enhanced instructions for Docker container management.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new teardown target in the Makefile, providing a convenient method to stop and remove Docker containers along with their associated volumes. This enhancement simplifies the process of cleaning up the Docker environment, offering users more granular control over container and volume management. The README.md has been correspondingly updated to document these new commands.

Changes

File	Change Summary
Makefile	Added teardown target to stop and remove Docker containers with volumes
README.md	Updated "Self hosting" section with new make down and make teardown commands

Possibly related issues

• Create a new make target to remove volumes along with the docker containers #2657: Directly addresses the issue's request to create a make target for removing volumes along with Docker containers

Poem

🐳 Docker's dance of rise and fall,
Volumes vanish at make's call
Containers fold, no trace remains
Clean slate beckons, freedom reigns!
Teardown's magic, swift and light 🧹

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

Makefile (1)

31-33: Perhaps we should add a warning about permanent data loss?

While the command works perfectly fine, it might be worth adding a comment above the target to warn users about the permanent nature of volume removal. You know, just in case someone accidentally runs it thinking it's the same as down.

+# Warning: This will permanently delete all data volumes
 teardown:
 	docker compose -f docker-compose.yaml -f $(docker_config_file) down -v
-	

Oh, and that trailing blank line at line 33 seems a bit... lonely. Maybe we could remove it?

README.md (1)

62-71: The documentation could be a tiny bit more explicit

While the commands are documented, we might want to make the distinction between them more... apparent. You know, for those who tend to run commands without reading carefully.

-Stops and removes the containers without affecting the volumes:
+# Safe option: Stops and removes containers only
 
 ```bash
 make down

-Stops and removes the containers and their volumes:
+# ⚠️ Destructive option: Stops and removes containers AND permanently deletes all data volumes

make teardown

Also, those extra blank lines between the text and code blocks are giving me slight OCD, but I suppose that's just me being particular.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7d3d958 and ea14899.

📒 Files selected for processing (2)

• Makefile (1 hunks)
• README.md (1 hunks)