build: migrate to docker compose v2

[kshitij-k-osmosys]

API PR Checklist

Task Link

Osmosys Developers must include the Pinestem task link in the PR.

REST-1421

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary unit testing.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

• Migrate to docker compose v2 standards for repository
• Remove deprecated version keyword
• Update documentation with docker compose v2 commands

Additional notes:

• https://docs.docker.com/reference/compose-file/version-and-name/
• https://docs.docker.com/compose/releases/migrate/

Summary by CodeRabbit

• Documentation

  • Updated all Docker CLI commands to use the modern docker compose syntax instead of the deprecated docker-compose.
  • Removed a trailing space from the example environment variable in the documentation.
  • Corrected relative links in setup guides for improved navigation.

• Chores

  • Removed the version declaration line from the Docker Compose configuration file.

[coderabbitai]

Walkthrough

The changes remove the version declaration from the Docker Compose configuration file and update documentation to use the modern docker compose command syntax instead of the deprecated docker-compose. Additionally, relative links in the usage guide documentation were corrected for proper navigation.

Changes

File(s)	Change Summary
apps/api/docker-compose.yml	Removed the version: '3' declaration from the Docker Compose file.
apps/api/docs/production-setup.md	Updated all Docker commands from docker-compose to docker compose; removed a trailing space in an environment variable example.
apps/api/docs/usage-guide.md	Changed absolute and incorrect relative links to correct relative paths for setup guide references.

Possibly related PRs

• docs: add usage guide #52: Adds the initial comprehensive usage guide content that the current relative link updates build upon.

Suggested reviewers

• osm-vishnukyatannawar

Poem

Compose commands hop and change their tune,
No more dashes, just a space—how soon!
The version tag hops out of sight,
While docs stay clear and shining bright.
🐇🐳
Compose on, containers, through the night!

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 51698c9 and 983d17e.

📒 Files selected for processing (1)

• apps/api/docs/usage-guide.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• apps/api/docs/usage-guide.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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 (1)

apps/api/docs/production-setup.md (1)

120-120: Convert step emphasis to a markdown heading
Markdown lint warns about using emphasis (**...**) instead of a heading. Consider changing this line to a level-3 heading for consistency:

- **Step 3: Start the Docker Containers**
+ ### Step 3: Start the Docker Containers

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

120-120: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0dd36fb and 51698c9.

📒 Files selected for processing (2)

• apps/api/docker-compose.yml (0 hunks)
• apps/api/docs/production-setup.md (3 hunks)

💤 Files with no reviewable changes (1)

• apps/api/docker-compose.yml

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

apps/api/docs/production-setup.md

120-120: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🔇 Additional comments (6)

apps/api/docs/production-setup.md (6)

52-52: Approve whitespace cleanup on environment variable
The trailing space has been removed from the COMPOSE_PROJECT_NAME assignment, improving markdown formatting.

---

117-117: Use updated Docker Compose v2 syntax for build
Replacing docker-compose build with docker compose build aligns with Docker Compose v2 conventions.

---

125-125: Use updated Docker Compose v2 syntax for up
Switching docker-compose up -d to docker compose up -d is correct for v2 compatibility.

---

145-145: Use updated Docker Compose v2 syntax for down
Changing docker-compose down to docker compose down follows the v2 command structure.

---

151-151: Use updated Docker Compose v2 syntax for rebuild
Updating docker-compose build to docker compose build maintains consistency with v2.

---

157-157: Use updated Docker Compose v2 syntax for restart
Replacing docker-compose up -d with docker compose up -d is the correct v2 approach.