https://github.com/notharshhaa/ci-cd_eks-github_actions
A fully automated CI/CD pipeline that builds, tests, and deploys a Node.js application on Amazon EKS using GitHub Actions, Terraform, and Kubernetes.
https://github.com/notharshhaa/ci-cd_eks-github_actions
aws aws-eks cicd devops eks eks-cluster github-actions jenkins nodejs
Last synced: 17 days ago
JSON representation
A fully automated CI/CD pipeline that builds, tests, and deploys a Node.js application on Amazon EKS using GitHub Actions, Terraform, and Kubernetes.
- Host: GitHub
- URL: https://github.com/notharshhaa/ci-cd_eks-github_actions
- Owner: NotHarshhaa
- Created: 2023-09-09T16:54:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T05:48:25.000Z (3 months ago)
- Last Synced: 2025-03-27T06:28:26.184Z (3 months ago)
- Topics: aws, aws-eks, cicd, devops, eks, eks-cluster, github-actions, jenkins, nodejs
- Language: HCL
- Homepage:
- Size: 18.6 KB
- Stars: 74
- Watchers: 2
- Forks: 56
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **🚀 End-to-End CI/CD Pipeline for Node.js App Deployment on EKS using GitHub Actions**
---
## **📌 Table of Contents**
- [**🚀 End-to-End CI/CD Pipeline for Node.js App Deployment on EKS using GitHub Actions**](#-end-to-end-cicd-pipeline-for-nodejs-app-deployment-on-eks-using-github-actions)
- [**📌 Table of Contents**](#-table-of-contents)
- [**📂 Repository Structure**](#-repository-structure)
- [**🔧 Prerequisites**](#-prerequisites)
- [**⚙️ CI/CD Workflow**](#️-cicd-workflow)
- [**🔨 Build Job**](#-build-job)
- [**🚀 Deployment Job**](#-deployment-job)
- [**🏗️ Infrastructure Details**](#️-infrastructure-details)
- [**📦 Application Deployment Strategy**](#-application-deployment-strategy)
- [**🔄 GitOps Principles**](#-gitops-principles)
- [**🔒 Security Best Practices**](#-security-best-practices)
- [**📢 Notifications \& Alerts**](#-notifications--alerts)
- [**📊 Monitoring \& Logging**](#-monitoring--logging)
- [**📜 Contributing**](#-contributing)
- [**⭐ Support \& Author**](#-support--author)
- [**⭐ Hit the Star!**](#-hit-the-star)
- [🛠️ **Author \& Community**](#️-author--community)
- [📧 **Let's Connect!**](#-lets-connect)
- [📢 **Stay Updated!**](#-stay-updated)
---
## **📂 Repository Structure**
The repository is structured for **modularity and maintainability**.:
```tree
📂 root
├── 📂 app # Application source code
│ ├── app.py # Python application logic (if applicable)
│ ├── calculator.js # Business logic for calculations
│ ├── calculator.test.js # Unit tests for calculator functions
│ ├── Dockerfile # Dockerfile for building the Node.js app
│ ├── Dockerfile-python # Dockerfile for a Python-based version (if needed)
│ ├── index.js # Main entry point of the Node.js application
│ └── package.json # Project dependencies and scripts
│
├── 📂 kustomize # Kubernetes manifests managed with Kustomize
│ ├── 📂 base # Base configurations common for all environments
│ │ ├── deploy.yaml # Deployment definition for the application
│ │ ├── ingress.yaml # Ingress configuration for routing traffic
│ │ ├── kustomization.yaml # Kustomize configuration file
│ │ └── svc.yaml # Kubernetes Service definition
│ │
│ ├── 📂 overlays # Environment-specific configurations
│ │ ├── 📂 dev # Dev environment-specific Kustomize configs
│ │ │ ├── deploy-dev.yaml # Dev-specific deployment file
│ │ │ ├── ingress-dev.yaml # Dev-specific ingress settings
│ │ │ ├── kustomization.yaml # Kustomize configuration for Dev
│ │ │ └── svc-dev.yaml # Dev-specific service settings
│ │ │
│ │ ├── 📂 prod # Production environment-specific Kustomize configs
│ │ │ ├── deploy-prod.yaml # Production-specific deployment file
│ │ │ ├── ingress-prod.yaml # Production-specific ingress settings
│ │ │ ├── kustomization.yaml # Kustomize configuration for Prod
│ │ │ └── svc-prod.yaml # Production-specific service settings
│ │ │
│ │ ├── 📂 staging # Staging environment-specific Kustomize configs
│ │ │ ├── deploy-staging.yaml # Staging-specific deployment file
│ │ │ ├── ingress-staging.yaml # Staging-specific ingress settings
│ │ │ ├── kustomization.yaml # Kustomize configuration for Staging
│ │ │ └── svc-staging.yaml # Staging-specific service settings
│
├── README.md # Project documentation and setup guide
│
├── 📂 terraform # Terraform configuration for infrastructure provisioning
│ ├── ingress-nginx.tf # Terraform script for setting up NGINX Ingress
│ ├── main.tf # Main Terraform file defining AWS infrastructure
│ ├── outputs.tf # Defines Terraform outputs (e.g., cluster endpoints)
│ ├── terraform.tf # Backend configuration for Terraform state management
│ └── variables.tf # Input variables for Terraform modules
│
└── VERSION # Tracks application versioning (Semantic Versioning)
```
---
## **🔧 Prerequisites**
Before you proceed, ensure you have the following installed:
- 🛠 **Node.js (>=14.x)**
- 🐳 **Docker (latest version)**
- 🏗️ **Terraform (>=1.0)**
- ☸ **kubectl (latest version)**
- 🎭 **Kustomize**
- ☁ **AWS CLI & eksctl**
- ⚙️ **GitHub Actions configured**
- 🔑 **AWS IAM permissions to manage EKS**
---
## **⚙️ CI/CD Workflow**
The **CI/CD pipeline** automates the entire deployment process using **GitHub Actions**.
### **🔨 Build Job**
1️⃣ **Set Up the Environment**
- Install **Node.js dependencies** using `npm install`.
- Lint the code to ensure quality standards.
2️⃣ **Run Tests**
- Execute **unit tests** with `npm test`.
- Generate test reports for visibility.
3️⃣ **Version Management**
- Uses **Semantic Versioning** (`major.minor.patch`).
- Auto-increments the version based on commit messages.
4️⃣ **Build & Push Docker Image**
- **Builds a Docker image** of the application.
- Pushes it to **Amazon Elastic Container Registry (ECR)**.
---
### **🚀 Deployment Job**
1️⃣ **Terraform Setup**
- Initializes Terraform with `terraform init`.
- Ensures correct **state management**.
2️⃣ **Infrastructure Provisioning**
- Executes `terraform plan` and `terraform apply`.
- Deploys EKS clusters, networking, and storage.
3️⃣ **Kubernetes Configuration**
- Configures `kubectl` to interact with the cluster.
- Applies `Kustomize` overlays for environment-specific settings.
4️⃣ **Ingress Controller Setup**
- Uses **Helm** to install **NGINX Ingress**.
5️⃣ **Application Deployment**
- Deploys the latest **Docker image** to Kubernetes.
- Exposes the service via **Ingress and Load Balancer**.
---
## **🏗️ Infrastructure Details**
| Environment | Instance Type | Replica Count |
|-------------|--------------|---------------|
| **Dev** | `t3.small` | 1 |
| **Staging** | `t3.medium` | 3 |
| **Prod** | `t3.large` | 3 |
✅ **DNS Automation via Cloudflare**
- Environment-specific subdomains:
- `dev.example.com`
- `staging.example.com`
- `prod.example.com`
---
## **📦 Application Deployment Strategy**
This project supports **multiple deployment strategies**:
✅ **Rolling Updates** – Default strategy, ensuring zero downtime.
✅ **Blue-Green Deployment** – Used in production environments.
✅ **Canary Deployments** – Gradual rollout for safe updates.
---
## **🔄 GitOps Principles**
✔ **Git as the Source of Truth**
✔ **Declarative Infrastructure** (Terraform & Kubernetes)
✔ **Automated Deployments via GitHub Actions**
Every infrastructure change must be made via a **Git commit**.
---
## **🔒 Security Best Practices**
🔐 **Secrets Management**
- Uses **AWS Secrets Manager** & GitHub Actions **encrypted secrets**.
🛡 **Container Security**
- Uses **Trivy** and **Docker Bench Security** for vulnerability scanning.
🚧 **IAM & Least Privilege**
- Uses **AWS IAM roles** with restricted access.
---
## **📢 Notifications & Alerts**
🔔 **Slack & Email Notifications**
- **CI/CD Job Updates** – Pipeline status alerts.
- **DNS Updates** – Cloudflare integration for alerts.
📡 **Monitoring & Logging**
- **AWS CloudWatch** for logs & metrics.
- **Prometheus & Grafana** for observability.
---
## **📊 Monitoring & Logging**
✅ **Application Logs** – Aggregated using **Fluent Bit**.
✅ **Infrastructure Logs** – Stored in **AWS CloudWatch Logs**.
✅ **Metrics Monitoring** – Tracked using **Prometheus & Grafana**.
---
## **📜 Contributing**
Want to contribute? Here’s how:
1. **Fork the repository** & create a new branch.
2. Make your changes and **commit with a descriptive message**.
3. Open a **Pull Request (PR)** for review.
---
## **⭐ Support & Author**
## **⭐ Hit the Star!**
If you find this repository helpful and plan to use it for learning, please consider giving it a star ⭐. Your support motivates me to keep improving and adding more valuable content! 🚀
---
## 🛠️ **Author & Community**
This project is crafted with passion by **[Harshhaa](https://github.com/NotHarshhaa)** 💡.
I’d love to hear your feedback! Feel free to open an issue, suggest improvements, or just drop by for a discussion. Let’s build a strong DevOps community together!
---
## 📧 **Let's Connect!**
Stay connected and explore more DevOps content with me:
[](https://linkedin.com/in/harshhaa-vardhan-reddy) [](https://github.com/NotHarshhaa) [](https://t.me/prodevopsguy) [](https://dev.to/notharshhaa) [](https://hashnode.com/@prodevopsguy)
---
## 📢 **Stay Updated!**
Want to stay up to date with the latest DevOps trends, best practices, and project updates? Follow me on my blogs and social channels!
