Added solution for Day 17: Docker Projects for DevOps Engineers - Django Notes App and Node.js To-Do App #349
Conversation
WalkthroughThe pull request involves the removal of two files, Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
2024/day17/solution.md (1)
76-76: Consider using Docker Compose for managing multiple containersInstead of manually managing port conflicts, consider using Docker Compose to define and run both applications with different ports.
Create a
docker-compose.yml:version: '3.8' services: django-app: build: ./django-notes-app ports: - "8000:8000" healthcheck: test: ["CMD", "curl", "-f", "http://localhost:8000/health/"] interval: 30s timeout: 3s node-app: build: ./node-todo-cicd ports: - "8001:8000" healthcheck: test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:8000/health"] interval: 30s timeout: 3sThen use:
docker-compose up -d🧰 Tools
🪛 LanguageTool
[formatting] ~76-~76: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...container to avoid error regarding ports, because we are using same port, you can use dif...(COMMA_BEFORE_BECAUSE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
2024/day17/solution.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
2024/day17/solution.md
[style] ~3-~3: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ngineers ### You people are doing just amazing in #90daysofdevops. Today's challen...
(AWESOME)
[formatting] ~76-~76: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...container to avoid error regarding ports, because we are using same port, you can use dif...
(COMMA_BEFORE_BECAUSE)
🪛 Markdownlint (0.37.0)
2024/day17/solution.md
3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
147-147: Expected: 0; Actual: 3
Unordered list indentation
(MD007, ul-indent)
14-14: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
19-19: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
84-84: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
| #### **3. Login to Docker Hub** | ||
|
|
||
| Before tagging or pushing your images, log in to Docker Hub with your credentials: | ||
| ```bash | ||
| docker login | ||
| ``` | ||
|
|
||
| - Enter your **Docker Hub username** and **password/token** when prompted. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### **4. Pushing Images to Docker Hub** | ||
|
|
||
| For both projects: | ||
|
|
||
| 1. **Tag the Image**: | ||
|
|
||
| ```bash | ||
| docker tag <image-name> <your-dockerhub-username>/<repository-name>:<tag> | ||
| ``` | ||
|
|
||
| - Example for Django Notes App: | ||
|
|
||
| ```bash | ||
| docker tag django-notes-app yourusername/django-notes-app:latest | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| - Example for Node.js To-Do App: | ||
|
|
||
| ```bash | ||
| docker tag node-todo-app yourusername/node-todo-app:latest | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| 2. **Push to Docker Hub**: | ||
|
|
||
| ```bash | ||
| docker push <your-dockerhub-username>/<repository-name>:<tag> | ||
| ``` | ||
|
|
||
|  |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve Docker Hub authentication and tagging strategy
A few recommendations for the Docker Hub instructions:
- Use access tokens instead of password for better security
- Avoid using the
latesttag in production as it's mutable - Implement a proper versioning strategy
Here's an improved version:
-docker login
+# Create a Personal Access Token in Docker Hub and use it instead of password
+docker login -u <username>
-docker tag django-notes-app yourusername/django-notes-app:latest
+# Use semantic versioning and git commit hash for immutable tags
+VERSION=$(git describe --tags --always)
+docker tag django-notes-app yourusername/django-notes-app:${VERSION}
+docker tag django-notes-app yourusername/django-notes-app:1.0.0
-docker tag node-todo-app yourusername/node-todo-app:latest
+docker tag node-todo-app yourusername/node-todo-app:${VERSION}
+docker tag node-todo-app yourusername/node-todo-app:1.0.0
# Push all tags
-docker push <your-dockerhub-username>/<repository-name>:<tag>
+docker push yourusername/django-notes-app:${VERSION}
+docker push yourusername/django-notes-app:1.0.0
+docker push yourusername/node-todo-app:${VERSION}
+docker push yourusername/node-todo-app:1.0.0Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 Markdownlint (0.37.0)
147-147: Expected: 0; Actual: 3
Unordered list indentation
(MD007, ul-indent)
| ```dockerfile | ||
| FROM python:3.9-slim | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| COPY requirements.txt . | ||
|
|
||
| RUN pip install --no-cache-dir -r requirements.txt | ||
|
|
||
| COPY . . | ||
|
|
||
| EXPOSE 8000 | ||
|
|
||
| CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"] | ||
| ``` |
There was a problem hiding this comment.
Security and production readiness concerns in Django Dockerfile
The current Dockerfile has several issues that should be addressed for production use:
- Using Django's development server (
runserver) in production is not recommended for security and performance reasons - Running as root user (no USER instruction) poses security risks
- Missing health checks for container orchestration
- Missing environment variables for Django settings (SECRET_KEY, DEBUG, etc.)
Here's an improved version:
FROM python:3.9-slim
WORKDIR /app
+# Create a non-root user
+RUN useradd -m -r appuser
+
COPY requirements.txt .
-RUN pip install --no-cache-dir -r requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt gunicorn
COPY . .
+# Set environment variables
+ENV DJANGO_SETTINGS_MODULE=notes.settings \
+ DJANGO_SECRET_KEY=changeme \
+ DJANGO_DEBUG=0
+
+# Switch to non-root user
+USER appuser
+
EXPOSE 8000
-CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+# Add health check
+HEALTHCHECK --interval=30s --timeout=3s \
+ CMD curl -f http://localhost:8000/health/ || exit 1
+
+# Use gunicorn for production
+CMD ["gunicorn", "--bind", "0.0.0.0:8000", "notes.wsgi:application"]Also, create a .dockerignore file to exclude unnecessary files:
.git
.gitignore
Dockerfile
*.pyc
__pycache__
*.md
Committable suggestion skipped: line range outside the PR's diff.
| ```dockerfile | ||
| FROM node:12.2.0-alpine | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| COPY . /app | ||
|
|
||
| RUN npm install | ||
|
|
||
| EXPOSE 8000 | ||
|
|
||
| CMD ["node","app.js"] | ||
| ``` |
There was a problem hiding this comment.
Security and optimization concerns in Node.js Dockerfile
The current Dockerfile has several issues:
- Node.js 12.2.0 is outdated and has known security vulnerabilities
- Inefficient layer caching (copying all files before npm install)
- Running as root user poses security risks
- Missing health checks
Here's an improved version:
-FROM node:12.2.0-alpine
+FROM node:20-alpine
WORKDIR /app
-COPY . /app
+# Copy package files first for better layer caching
+COPY package*.json ./
RUN npm install
+# Create a non-root user
+RUN addgroup -S appgroup && adduser -S appuser -G appgroup
+
+# Copy application code
+COPY . .
+
+# Switch to non-root user
+USER appuser
+
EXPOSE 8000
+# Add health check
+HEALTHCHECK --interval=30s --timeout=3s \
+ CMD wget --no-verbose --tries=1 --spider http://localhost:8000/health || exit 1
+
CMD ["node","app.js"]Also, create a .dockerignore file:
node_modules
npm-debug.log
Dockerfile
.git
.gitignore
*.md
Committable suggestion skipped: line range outside the PR's diff.
This PR contains solutions and tasks completed for Day 17 of the #90DaysOfDevOps challenge. The focus was on working with Docker to containerize and deploy two applications:
Django Notes Application:
Dockerfileto build and deploy the app.http://localhost:8000.Node.js To-Do Application:
Dockerfilefor the app.http://localhost:8000.Additionally:
Highlights
Dockerfiles, building and running containers, and managing Docker images.Links to reference content, images, and commands are included for a comprehensive understanding.
Summary by CodeRabbit