search

lehuygiang28 / vphim

Full-stack movie web/mobile app built with NestJS + Next.js + Expo
https://vephim.online
1 stars 0 forks source link

chore(api): :zap: add bundle image to run api with pm2 #5

Closed lehuygiang28 closed 3 days ago

lehuygiang28 commented 3 days ago

Summary by Sourcery

Integrate PM2 for running the API in a clustered mode by adding a new PM2 configuration and entrypoint script. Update the CI workflow to streamline Docker image building and pushing processes, and replace the 'vphim_api_redis_cloudflared' service with 'vphim_api_redis_pm2' in the Docker setup.

Enhancements:

CI:

Deployment:

Summary by CodeRabbit

vercel[bot] commented 3 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vphim-fe ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 11:48am
vphim-mnt ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 11:48am
coderabbitai[bot] commented 3 days ago

Walkthrough

The changes in this pull request involve modifications to Docker-related configurations, including the addition of a new branch trigger in the GitHub Actions workflow for building Docker images, the deletion of old configuration files, and the introduction of new ones for managing services with PM2. The Dockerfile and Docker Compose configurations have been updated to reflect these changes, including service restructuring and adjustments to environment file handling.

Changes

File Path Change Summary
.github/workflows/build-push-docker.yml Added ci/tunnel branch trigger; modified .env file target path in the build job.
containers/be-redis-cloudflared/ecosystem.config.js Deleted file; contained configuration for cloudflared, redis, and vphim-api.
containers/be-redis-cloudflared/entrypoint.sh Deleted file; initialized Docker container environment for Redis.
containers/be-redis-pm2/Dockerfile Updated file; simplified copy commands, removed cloudflared, added supervisor, changed entry point.
containers/be-redis-pm2/ecosystem.config.js New file; configuration for managing vphim-api application with PM2.
containers/be-redis-pm2/entrypoint.sh New file; initializes PM2 linking and starts supervisord.
containers/be-redis-pm2/supervisord.conf New file; defines process management for redis and vphim-api.
docker-compose.bundle.yml Updated service configurations; changed port for vphim_api_redis, removed vphim_api_redis_cloudflared, added vphim_api_redis_pm2.

Suggested labels

api

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sourcery-ai[bot] commented 3 days ago

Reviewer's Guide by Sourcery

This pull request adds a bundle image to run the API with PM2, replacing the previous Cloudflared setup. The changes primarily affect Docker configurations, GitHub Actions workflow, and the introduction of PM2-specific files.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Replace Cloudflared with PM2 for API management
  • Rename container from 'vphim_api_redis_cloudflared' to 'vphim_api_redis_pm2'
  • Update Dockerfile path from 'be-redis-cloudflared' to 'be-redis-pm2'
  • Change Docker image name to reflect PM2 usage
  • Update environment file path for the new PM2 setup
 docker-compose.bundle.yml
Modify GitHub Actions workflow for Docker build and push
  • Add 'ci/tunnel' branch to trigger the workflow
  • Update .env file creation for the new PM2 container
  • Modify Docker Compose commands to only build and push the bundle configuration
 .github/workflows/build-push-docker.yml
Add PM2 configuration file
  • Create ecosystem.config.js for PM2
  • Configure PM2 to run the API with 4 instances in cluster mode
  • Set memory limit and logging options for the PM2-managed application
 containers/be-redis-pm2/ecosystem.config.js
Add entrypoint script for PM2 setup
  • Create entrypoint.sh to handle PM2 linking and supervisor startup
  • Check for PM2_ID and PM2_SEC environment variables
  • Start supervisord with the appropriate configuration
 containers/be-redis-pm2/entrypoint.sh
Remove Cloudflared-specific files
  • Delete ecosystem.config.js for Cloudflared setup
  • Remove entrypoint.sh script for Cloudflared configuration
 containers/be-redis-cloudflared/ecosystem.config.js
containers/be-redis-cloudflared/entrypoint.sh
Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).