DevOps Infrastructure Implementation for EasyShop #54

iemafzalhassan · 2025-03-24T08:48:50Z

Overview

This PR adds comprehensive DevOps infrastructure to the EasyShop e-commerce platform, including Docker containerization, Kubernetes deployment manifests, and CI/CD pipeline configurations. These changes enable seamless deployment to both local and cloud environments.

Changes

Added Docker containerization for the application, MongoDB, and Redis
Created Kubernetes deployment manifests for orchestration
Implemented database migration scripts for automated setup
Added environment configuration for different deployment scenarios
Updated authentication to work properly in containerized environments
Enhanced CORS settings for cross-domain compatibility
Added detailed deployment documentation

Features

Docker Compose : Easy local development with a single command
Kubernetes Manifests : Production-ready deployment configurations
Database Migration : Automated data seeding and schema setup
EC2 Deployment : Instructions for AWS cloud deployment
Authentication : Fixed token handling in containerized environments
Documentation : Comprehensive setup and troubleshooting guides

Testing Done

Tested Docker Compose setup locally
Verified Kubernetes deployment on Kind cluster
Confirmed EC2 deployment functionality
Validated authentication flows in all environments
Tested database migrations and data persistence

Screenshots

N/A

Notes for Reviewers

Docker images have been pushed to Docker Hub under the iemafzal namespace
The EC2 instance is running at 13.50.235.247
Environment variables need to be properly configured as per the README

Summary by CodeRabbit

Documentation
- Enhanced deployment instructions with updated branch checkout guidance and configuration details.
- Expanded guidelines to include new steps for additional infrastructure components.
New Features
- Introduced commands to deploy a Redis service, broadening the application’s infrastructure.
- Upgraded the application’s Docker image to the latest build.
Bug Fixes
- Corrected naming inconsistencies and updated the service endpoint details for proper connectivity.

coderabbitai · 2025-03-24T08:48:57Z

Walkthrough

The pull request updates the EasyShop deployment instructions in the project guide. It adds a branch checkout command and revises several file references and configuration details. Specifically, the changes include inserting a new environment variable in the ConfigMap, renaming YAML files for deployment and the migration job, updating the Docker image, and modifying the ingress host. Additionally, new commands for applying Redis service and deployment configurations have been included.

Changes

File(s)	Change Summary
`projectGuide/easyshop-kind.md`	Added `git checkout DevOps` command; corrected YAML file references for deployment and migration jobs; updated Docker image to `iemafzal/easyshop-app:latest`; revised ingress host to `13.50.235.247.nip.ioo`; introduced Redis deployment instructions.
`kubernetes/*.yaml`	Added new environment variable `REDIS_URI` in ConfigMap; renamed deployment file (`08easyshop-deployment.yaml` → `08-easyshop-deployment.yaml`) and migration job (`migration-job.yaml` → `12-migration-job.yaml`); added commands for applying Redis service (`13-redis-service.yaml`) and deployment (`14-redis-deployment.yaml`).

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Repo as Repository
    participant K8s as Kubernetes Cluster

    Dev->>Repo: Clone repository
    Dev->>Repo: Checkout DevOps branch
    Dev->>K8s: Apply ConfigMap (with REDIS_URI)
    Dev->>K8s: Deploy EasyShop (08-easyshop-deployment.yaml)
    Dev->>K8s: Update Ingress (with revised host)
    Dev->>K8s: Run Migration Job (12-migration-job.yaml)
    Dev->>K8s: Apply Redis service & deployment YAMLs

Possibly related PRs

Docs: EasyShop-setup.md #49: Contains similar updates to deployment templates and migration job configurations, indicating a direct code-level connection.

Suggested reviewers

LondheShubham153

Poem

I'm a bunny hopping through YAML files all day,
Cheering "git checkout DevOps" in a clever way.
With REDIS_URI added and images anew,
Ingress and migration steps now in view.
I nibble on code, joyful and bright—
Celebrating changes with pure delight! 🐰

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

🪧 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.
@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: 1

🧹 Nitpick comments (3)

projectGuide/easyshop-kind.md (3)

177-178: Placeholder Reminder in ConfigMap:
The placeholders YOUR_EC2_PUBLIC_IP in NEXT_PUBLIC_API_URL and NEXTAUTH_URL should be replaced with the actual public IP addresses before deploying to production.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

177-177: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

178-178: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

200-200: Remove Trailing Punctuation in Heading:
The heading “Create or update kubernetes/08-easyshop-deployment.yaml:” includes an unnecessary trailing colon. Removing the colon will improve markdown style compliance.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

200-200: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

1-429: Markdown Formatting Cleanup:
Multiple markdown lint warnings (e.g., MD027 for extra spaces after blockquote symbols and MD028 for blank lines within blockquotes) have been reported. Although these do not affect functionality, cleaning up these formatting issues will improve overall readability and maintain consistency across the documentation.

🧰 Tools

🪛 LanguageTool

[grammar] ~378-~378: This phrase is duplicated. You should probably use “the Application” only once.
Context: ...db.serverStatus()" ``` ## Accessing the Application The application should now be accessible at: > [!WARNIN...

(PHRASE_REPETITION)

🪛 Gitleaks (8.21.2)

180-180: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🪛 markdownlint-cli2 (0.17.2)

22-22: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

42-42: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

58-58: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

112-112: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

113-113: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

114-114: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

115-115: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

117-117: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

122-122: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

123-123: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

127-127: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

128-128: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

129-129: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

131-131: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

132-132: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

136-136: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

137-137: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

138-138: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

140-140: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

141-141: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5

(MD001, heading-increment)

148-148: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

149-149: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

150-150: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

152-152: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

153-153: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

155-155: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

156-156: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

158-158: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

160-160: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

161-161: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

162-162: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

164-164: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

167-167: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

168-168: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

169-169: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

170-170: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

171-171: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

172-172: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

173-173: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

174-174: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

175-175: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

176-176: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

177-177: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

178-178: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

179-179: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

180-180: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

182-182: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

183-183: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

184-184: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

186-186: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

187-187: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

188-188: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5

(MD001, heading-increment)

192-192: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

200-200: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

201-201: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

205-205: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

206-206: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

208-208: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

209-209: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

210-210: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

211-211: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

212-212: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

213-213: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

214-214: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

215-215: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

216-216: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

217-217: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

218-218: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

219-219: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

220-220: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

221-221: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

222-222: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

223-223: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

224-224: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

225-225: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

226-226: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

227-227: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

228-228: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

229-229: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

230-230: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

231-231: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

232-232: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

233-233: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

234-234: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

235-235: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

236-236: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

237-237: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

238-238: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

239-239: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

240-240: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

241-241: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

242-242: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

243-243: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

244-244: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

245-245: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

246-246: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

247-247: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

248-248: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

249-249: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

250-250: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

251-251: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

252-252: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

253-253: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

254-254: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

255-255: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

256-256: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

257-257: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

258-258: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

259-259: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

260-260: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

261-261: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

262-262: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

263-263: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

264-264: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

265-265: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

266-266: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

267-267: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

268-268: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

271-271: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

272-272: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

273-273: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

276-276: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

277-277: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

279-279: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

280-280: Headings must start at the beginning of the line
null

(MD023, heading-start-left)

280-280: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

281-281: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

282-282: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

283-283: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

285-285: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

286-286: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

287-287: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

288-288: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

289-289: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

290-290: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

291-291: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

293-293: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

294-294: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

296-296: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

319-319: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

320-320: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

321-321: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

323-323: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

325-325: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

344-344: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

345-345: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

346-346: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

347-347: Multiple spaces after blockquote symbol
null

(MD027, no-multiple-space-blockquote)

349-349: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

385-385: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fe92dde and 5038caa.

📒 Files selected for processing (1)

projectGuide/easyshop-kind.md (5 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

projectGuide/easyshop-kind.md

115-115: Multiple spaces after blockquote symbol
null