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

Fix prod docker image #2618

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Fix prod docker image #2618

merged 2 commits into from
Nov 26, 2024

Conversation

sainak
Copy link
Member

@sainak sainak commented Nov 26, 2024

Proposed Changes

  • fix prod docker image

Merge Checklist

  • Tests added/fixed
  • Update docs in /docs
  • Linting Complete
  • Any other necessary step

Only PR's with test cases included and passing lint and test pipelines will be reviewed

@ohcnetwork/care-backend-maintainers @ohcnetwork/care-backend-admins

Summary by CodeRabbit

  • Chores
    • Simplified the Dockerfile by removing unnecessary user management commands in the builder stage.
    • Enhanced the runtime environment with additional packages and improved security by setting file ownership to the django user.
    • Adjusted health check parameters for better performance.
    • Streamlined the celery_beat.sh script by removing the command that loads event types, maintaining existing functionality.

@sainak sainak requested a review from a team as a code owner November 26, 2024 06:18
Copy link

coderabbitai bot commented Nov 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the Dockerfile and the celery_beat.sh script. The Dockerfile sees a restructuring of the build process, including user management adjustments and the addition of runtime packages, enhancing security and permissions. The celery_beat.sh script has had a command removed, streamlining its execution without affecting the overall logic. These updates aim to improve the manageability and security of the application environment. Because who wouldn’t want a more secure and tidy setup, right?

Changes

File Change Summary
docker/prod.Dockerfile - Removed user/group creation in builder stage.
- Reinstated user/group creation in runtime stage.
- Added packages: gettext, curl, gnupg.
- Set ownership for $APP_HOME to django user.
- Updated COPY commands with ownership settings.
- Modified HEALTHCHECK parameters (--start-period from 10s to 20s, added --start-interval of 1s).
scripts/celery_beat.sh - Removed command python manage.py load_event_types, simplifying the script.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docker
    participant Django

    User->>Docker: Build Docker Image
    Docker->>Django: Set up user/group (runtime)
    Docker->>Django: Install packages
    Docker->>Django: Set ownership of $APP_HOME
    Docker->>Django: Run HEALTHCHECK
Loading

🎉 In Docker's embrace, we find our way,
With permissions set, come what may.
Celery beats without the load,
A simpler path, a lighter road.
Security's tight, the structure's neat,
In this code dance, we can't be beat! 🎶


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 70155e2 and 585dd41.

📒 Files selected for processing (1)
  • docker/prod.Dockerfile (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docker/prod.Dockerfile

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
🪧 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
docker/prod.Dockerfile (3)

59-61: Oh, look who finally decided to add proper user management! 🎉

While it's wonderful to see proper user isolation being implemented, we could make it ever so slightly more efficient.

Here's a teensy suggestion to combine the commands:

-RUN addgroup --system django \
-  && adduser --system --ingroup django django
+RUN addgroup --system django && adduser --system --ingroup django django --no-create-home

67-67: Directory ownership set after package installation, interesting choice...

While the ownership change is correct, it might be more logical to set it before installing packages to ensure no root-owned files sneak in.

Consider moving the chown command before the package installation.


Line range hint 71-74: Nice to see proper file permissions, for a change!

The ownership and permissions are correctly set, but let's make sure we're being crystal clear about our intentions.

Consider adding a comment explaining the permission choices:

+# Set executable permissions for scripts and ensure proper ownership
COPY --chmod=0755 --chown=django:django ./scripts/*.sh $APP_HOME
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f0f0c8b and 70155e2.

📒 Files selected for processing (2)
  • docker/prod.Dockerfile (2 hunks)
  • scripts/celery_beat.sh (0 hunks)
💤 Files with no reviewable changes (1)
  • scripts/celery_beat.sh
🔇 Additional comments (2)
docker/prod.Dockerfile (2)

Line range hint 76-76: Verify complete non-root execution

Let's ensure we're not running any sensitive operations as root.

✅ Verification successful

Non-root execution appears to be properly configured... if you must know

The Dockerfile actually demonstrates quite good security practices (not that I'm impressed or anything):

  • Creates a non-root user 'django' with minimal system privileges
  • Switches to this user with USER django before running the application
  • All application files are properly owned by django:django
  • Even the shell scripts are given appropriate permissions (0755) and ownership
  • The only root operation is during the initial setup, which is, unfortunately, necessary

The only root-related path is the pip cache directory, but this is only used during the builder stage and doesn't persist to the runtime image.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential root operations in scripts
rg -l 'sudo|su root' scripts/

Length of output: 31


Script:

#!/bin/bash
# Let's check the Dockerfile itself for root-related operations and user switching
rg -i 'USER|sudo|root' docker/prod.Dockerfile

# Also check for any chmod/chown operations that might indicate root operations
rg -i 'chmod|chown' docker/prod.Dockerfile

# And let's see the actual content of the Dockerfile to analyze the execution context
cat docker/prod.Dockerfile

Length of output: 2985


82-83: Interesting choice of healthcheck timing parameters...

The reduced start period and new start interval might be a bit aggressive for some deployment scenarios.

Let's verify if these timings align with your orchestration setup:

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.58%. Comparing base (f0f0c8b) to head (585dd41).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2618   +/-   ##
========================================
  Coverage    69.58%   69.58%           
========================================
  Files          211      211           
  Lines        11875    11875           
  Branches      1201     1201           
========================================
  Hits          8263     8263           
  Misses        3246     3246           
  Partials       366      366           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vigneshhari vigneshhari merged commit f217f3a into develop Nov 26, 2024
8 checks passed
@vigneshhari vigneshhari deleted the sainak/fix/prod-docker-image branch November 26, 2024 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants