DevSecOps Project!

Deploy a Netflix Clone with a Complete CI/CD Pipeline using jenkins on a cloud in a DevSecOps Environment

In this project we deploy a Netflix clone application using a secure CI/CD pipeline built with Jenkins, Docker, and Kubernetes. This project includes implementing code quality and security tools (SonarQube, Trivy), as well as monitoring solutions (Prometheus, Grafana) to ensure reliability and visibility. Key components you'll explore include:

Dockerized Local Testing

• Deploy the application in a Docker container for local testing.

Code Quality and Security Analysis

• Set up SonarQube and Trivy for code quality analysis and security scanning.

CI/CD Pipeline with Jenkins

• Install and configure Jenkins on Ubuntu for CI/CD automation.
• Build Docker images within Jenkins and push them to Docker Hub.

Security Scanning

• Use Trivy to scan Docker images for vulnerabilities.

Automated Application Deployment

• Deploy the application to a Docker container.

Monitoring Setup

• Install and configure Prometheus and Grafana for monitoring the application’s health and performance.
• Set up Prometheus and Node Exporter via Helm in Kubernetes.

Notifications

• Configure email notifications within Jenkins for pipeline updates.

Kubernetes Cluster Deployment

• Create a Kubernetes cluster with Amazon EKS.
• Use ArgoCD to deploy the Netflix clone on Kubernetes for streamlined app management.

Phase 1: Initial Setup and Deployment

Step 1: Launch EC2 (Ubuntu):

• Provision an EC2 instance on AWS with Ubuntu.
• Connect to the instance using SSH.

Step 2: Clone the Code:

• Update all the packages and then clone the code.

• Clone your application's code repository onto the EC2 instance:

  git clone git@github.com:imran1509/DevSecOps-Project-Netflix-Deployment.git

Step 3: Install Docker and Run the App Using a Container:

• Set up Docker on the EC2 instance:

  sudo apt-get update
  sudo apt-get install docker.io -y
  sudo usermod -aG docker $USER  # Replace with your system's username, e.g., 'ubuntu'
  newgrp docker
  sudo chmod 777 /var/run/docker.sock

• Build and run your application using Docker containers:

  docker build -t netflix .
  docker run -d --name netflix -p 8081:80 netflix:latest

  #to delete
  docker stop <containerid>
  docker rmi -f netflix

It will show an error cause you need API key

Step 4: Get the API Key:

• Open a web browser and navigate to TMDB (The Movie Database) website.

• Click on "Login" and create an account.

• Once logged in, go to your profile and select "Settings."

• Click on "API" from the left-side panel.

• Create a new API key by clicking "Create" and accepting the terms and conditions.

• Provide the required basic details and click "Submit."

• You will receive your TMDB API key.

• Now recreate the Docker image with your api key:

   docker build --build-arg TMDB_V3_API_KEY=<your-api-key> -t netflix .

Phase 2: Security

Step 1: Install SonarQube and Trivy:

• Install SonarQube and Trivy on the EC2 instance to scan for vulnerabilities.

• sonarqube

        docker run -d --name sonar -p 9000:9000 sonarqube:lts-community

• To access Sonarqube:

  http://Your_public_IP:9000 (by default username & password is admin)

• To install Trivy:

           sudo apt-get install wget apt-transport-https gnupg lsb-release
           wget -qO - https://aquasecurity.github.io/trivy-repo/deb/public.key | sudo apt-key add -
           echo deb https://aquasecurity.github.io/trivy-repo/deb $(lsb_release -sc) main | sudo tee -a /etc/apt/sources.list.d/trivy.list
           sudo apt-get update
           sudo apt-get install trivy        

• to scan image using trivy

        trivy image <imageid>

Step 2: Integrate SonarQube and Configure:

• Integrate SonarQube with your CI/CD pipeline.
• Configure SonarQube to analyze code for quality and security issues.

Phase 3: CI/CD Setup

Step 1: Install Jenkins for Automation:

• Install Jenkins on the EC2 instance to automate deployment:

  • Install Java & Jenkins

  sudo apt update
  sudo apt install fontconfig openjdk-17-jre
  java -version
  openjdk version "17.0.8" 2023-07-18
  OpenJDK Runtime Environment (build 17.0.8+7-Debian-1deb12u1)
  OpenJDK 64-Bit Server VM (build 17.0.8+7-Debian-1deb12u1, mixed mode, sharing)
  
  #jenkins
  sudo wget -O /usr/share/keyrings/jenkins-keyring.asc \
  https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key
  echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] \
  https://pkg.jenkins.io/debian-stable binary/ | sudo tee \
  /etc/apt/sources.list.d/jenkins.list > /dev/null
  sudo apt-get update
  sudo apt-get install jenkins
  sudo systemctl start jenkins
  sudo systemctl enable jenkins

• Access Jenkins in a web browser using the public IP of your EC2 instance.

  http://Your_public_Ip:8080

Step 2: Install Necessary Plugins in Jenkins:

• Goto Manage Jenkins →Plugins → Available Plugins →

• Install below plugins

  • Eclipse Temurin Installer (Install without restart)

  • SonarQube Scanner (Install without restart)

  • NodeJs Plugin (Install Without restart)

  • Email Extension Plugin

Step 3: Configure Java and Nodejs in Global Tool Configuration:

• Goto Manage Jenkins → Tools → Install JDK(17) and NodeJs(16)→ Click on Apply and Save

Step 4: SonarQube

• Go to Administration → Secuirity → Users and under token, generate the token

• Goto Jenkins Dashboard → Manage Jenkins → Credentials → System → Global Credentials → Add credential

• select secret text as kind and paste your token in secret. textAdd Secret Text.

• In ID and description write sonar-token

• After adding sonar token

• Click on Apply and Save

• The Configure System option is used in Jenkins to configure different server

• Global Tool Configuration is used to configure different tools that we install using Plugins

• We will install a sonar scanner in the tools.

Step 5: Configure CI/CD Pipeline in Jenkins:

• Create a CI/CD pipeline in Jenkins to automate your application deployment.

pipeline {
    agent any
    tools {
        jdk 'jdk17'
        nodejs 'node16'
    }
    environment {
        SCANNER_HOME = tool 'sonar-scanner'
    }
    stages {
        stage('clean workspace') {
            steps {
                cleanWs()
            }
        }
        stage('Checkout from Git') {
            steps {
                git branch: 'main', url: 'https://github.com/imran1509/DevSecOps-Project-Netflix-Deployment.git'
            }
        }
        stage("Sonarqube Analysis") {
            steps {
                withSonarQubeEnv('sonar-server') {
                    sh '''$SCANNER_HOME/bin/sonar-scanner -Dsonar.projectName=Netflix \
                    -Dsonar.projectKey=Netflix-test'''
                }
            }
        }
        stage("quality gate") {
            steps {
                script {
                    waitForQualityGate abortPipeline: false, credentialsId: 'Sonar-token'
                }
            }
        }
        stage('Install Dependencies') {
            steps {
                sh "npm install"
            }
        }
    }
}

Certainly, here are the instructions without step numbers:

Install Dependency-Check and Docker Tools in Jenkins

Install Dependency-Check Plugin:

• Go to "Dashboard" in your Jenkins web interface.
• Navigate to "Manage Jenkins" → "Manage Plugins."
• Click on the "Available" tab and search for "OWASP Dependency-Check."
• Check the checkbox for "OWASP Dependency-Check" and click on the "Install without restart" button.

Configure Dependency-Check Tool:

• After installing the Dependency-Check plugin, you need to configure the tool.
• Go to "Dashboard" → "Manage Jenkins" → "Global Tool Configuration."
• Find the section for "OWASP Dependency-Check."
• Add the tool's name, e.g., "DP-Check."
• Save your settings.

Install Docker Tools and Docker Plugins:

• Go to "Dashboard" in your Jenkins web interface.
• Navigate to "Manage Jenkins" → "Manage Plugins."
• Click on the "Available" tab and search for "Docker."
• Check the following Docker-related plugins:
  • Docker
  • Docker Commons
  • Docker Pipeline
  • Docker API
  • docker-build-step
• Click on the "Install without restart" button to install these plugins.

Add DockerHub Credentials:

• To securely handle DockerHub credentials in your Jenkins pipeline, follow these steps:
  • Go to "Dashboard" → "Manage Jenkins" → "Manage Credentials."
  • Click on "System" and then "Global credentials (unrestricted)."
  • Click on "Add Credentials" on the left side.
  • Choose "Secret text" as the kind of credentials.
  • Enter your DockerHub credentials (Username and Password) and give the credentials an ID (e.g., "docker").
  • Click "OK" to save your DockerHub credentials.

Now, you have installed the Dependency-Check plugin, configured the tool, and added Docker-related plugins along with your DockerHub credentials in Jenkins. You can now proceed with configuring your Jenkins pipeline to include these tools and credentials in your CI/CD process.

pipeline{
    agent any
    tools{
        jdk 'jdk17'
        nodejs 'node16'
    }
    environment {
        SCANNER_HOME=tool 'sonar-scanner'
    }
    stages {
        stage('clean workspace'){
            steps{
                cleanWs()
            }
        }
        stage('Checkout from Git'){
            steps{
                git branch: 'main', url: 'https://github.com/imran1509/DevSecOps-Project-Netflix-Deployment.git'
            }
        }
        stage("Sonarqube Analysis "){
            steps{
                withSonarQubeEnv('sonar-server') {
                    sh ''' $SCANNER_HOME/bin/sonar-scanner -Dsonar.projectName=Netflix \
                    -Dsonar.projectKey=Netflix-test '''
                }
            }
        }
        stage("quality gate"){
           steps {
                script {
                    waitForQualityGate abortPipeline: false, credentialsId: 'Sonar-token' 
                }
            } 
        }
        stage('Install Dependencies') {
            steps {
                sh "npm install"
            }
        }
        stage('OWASP FS SCAN') {
            steps {
                dependencyCheck additionalArguments: '--scan ./ --disableYarnAudit --disableNodeAudit', odcInstallation: 'DP-Check'
                dependencyCheckPublisher pattern: '**/dependency-check-report.xml'
            }
        }
        stage('TRIVY FS SCAN') {
            steps {
                sh "trivy fs . > trivyfs.txt"
            }
        }
        stage("Docker Build & Push"){
            steps{
                script{
                   withDockerRegistry(credentialsId: 'docker', toolName: 'docker'){   
                       sh "docker build --build-arg TMDB_V3_API_KEY=<your_API_key> -t netflix ."
                       sh "docker tag netflix imran1509/netflix:latest "
                       sh "docker push imran1509/netflix:latest "
                    }
                }
            }
        }
        stage("TRIVY"){
            steps{
                sh "trivy image imran1509/netflix:latest > trivyimage.txt" 
            }
        }
        stage('Deploy to container'){
            steps{
                sh 'docker run -d --name netflix -p 8081:80 imran1509/netflix:latest'
            }
        }
    }
}

• If you get docker login failed errorr

   sudo su
   sudo usermod -aG docker jenkins
   sudo systemctl restart jenkins

Phase 4: Monitoring

Install Prometheus and Grafana:

Set up Prometheus and Grafana to monitor your application.

Installing Prometheus:

• First, create a dedicated Linux user for Prometheus and download Prometheus:

  sudo useradd --system --no-create-home --shell /bin/false prometheus
  wget https://github.com/prometheus/prometheus/releases/download/v2.47.1/prometheus-2.47.1.linux-amd64.tar.gz

• Extract Prometheus files, move them, and create directories:

  tar -xvf prometheus-2.47.1.linux-amd64.tar.gz
  cd prometheus-2.47.1.linux-amd64/
  sudo mkdir -p /data /etc/prometheus
  sudo mv prometheus promtool /usr/local/bin/
  sudo mv consoles/ console_libraries/ /etc/prometheus/
  sudo mv prometheus.yml /etc/prometheus/prometheus.yml

• Set ownership for directories:

  sudo chown -R prometheus:prometheus /etc/prometheus/ /data/

• Create a systemd unit configuration file for Prometheus:

  sudo nano /etc/systemd/system/prometheus.service

• Add the following content to the prometheus.service file:

  [Unit]
  Description=Prometheus
  Wants=network-online.target
  After=network-online.target
  
  StartLimitIntervalSec=500
  StartLimitBurst=5
  
  [Service]
  User=prometheus
  Group=prometheus
  Type=simple
  Restart=on-failure
  RestartSec=5s
  ExecStart=/usr/local/bin/prometheus \
    --config.file=/etc/prometheus/prometheus.yml \
    --storage.tsdb.path=/data \
    --web.console.templates=/etc/prometheus/consoles \
    --web.console.libraries=/etc/prometheus/console_libraries \
    --web.listen-address=0.0.0.0:9090 \
    --web.enable-lifecycle
  
  [Install]
  WantedBy=multi-user.target
  

• Here's a brief explanation of the key parts in this prometheus.service file:

  • User and Group specify the Linux user and group under which Prometheus will run.

  • ExecStart is where you specify the Prometheus binary path, the location of the configuration file (prometheus.yml), the storage directory, and other settings.

  • web.listen-address configures Prometheus to listen on all network interfaces on port 9090.

  • web.enable-lifecycle allows for management of Prometheus through API calls.

• Enable and start Prometheus:

  sudo systemctl enable prometheus
  sudo systemctl start prometheus

• Verify Prometheus's status:

  sudo systemctl status prometheus

• You can access Prometheus in a web browser using your server's IP and port 9090:

  http://<your-server-ip>:9090

  Installing Node Exporter:

• Create a system user for Node Exporter and download Node Exporter:

  sudo useradd --system --no-create-home --shell /bin/false node_exporter
  wget https://github.com/prometheus/node_exporter/releases/download/v1.6.1/node_exporter-1.6.1.linux-amd64.tar.gz

• Extract Node Exporter files, move the binary, and clean up:

  tar -xvf node_exporter-1.6.1.linux-amd64.tar.gz
  sudo mv node_exporter-1.6.1.linux-amd64/node_exporter /usr/local/bin/
  rm -rf node_exporter*

• Create a systemd unit configuration file for Node Exporter:

  sudo nano /etc/systemd/system/node_exporter.service

• Add the following content to the node_exporter.service file:

  [Unit]
  Description=Node Exporter
  Wants=network-online.target
  After=network-online.target
  
  StartLimitIntervalSec=500
  StartLimitBurst=5
  
  [Service]
  User=node_exporter
  Group=node_exporter
  Type=simple
  Restart=on-failure
  RestartSec=5s
  ExecStart=/usr/local/bin/node_exporter --collector.logind
  
  [Install]
  WantedBy=multi-user.target
  

  Replace --collector.logind with any additional flags as needed.

• Enable and start Node Exporter:

  sudo systemctl enable node_exporter
  sudo systemctl start node_exporter

• Verify the Node Exporter's status:

  sudo systemctl status node_exporter

  You can access Node Exporter metrics in Prometheus.

Configure Prometheus Plugin Integration:

• Integrate Jenkins with Prometheus to monitor the CI/CD pipeline.

  Prometheus Configuration:

• To configure Prometheus to scrape metrics from Node Exporter and Jenkins, you need to modify the prometheus.yml file. Here is an example prometheus.yml configuration for your setup:

  global:
    scrape_interval: 15s
  
  scrape_configs:
    - job_name: "node_exporter"
      static_configs:
        - targets: ["localhost:9100"]
  
    - job_name: "jenkins"
      metrics_path: "/prometheus"
      static_configs:
        - targets: ["<your-jenkins-ip>:<your-jenkins-port>"]

• Make sure to replace <your-jenkins-ip> and <your-jenkins-port> with the appropriate values for your Jenkins setup.

• Check the validity of the configuration file:

  promtool check config /etc/prometheus/prometheus.yml

• Reload the Prometheus configuration without restarting:

  curl -X POST http://localhost:9090/-/reload

• You can access Prometheus targets at:

  http://<your-prometheus-ip>:9090/targets

Grafana

Install Grafana on Ubuntu and Set it up to Work with Prometheus

Step 1: Install Dependencies:

• First, ensure that all necessary dependencies are installed:

sudo apt-get update
sudo apt-get install -y apt-transport-https software-properties-common

Step 2: Add the GPG Key:

• Add the GPG key for Grafana:

wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -

Step 3: Add Grafana Repository:

• Add the repository for Grafana stable releases:

echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list

Step 4: Update and Install Grafana:

• Update the package list and install Grafana:

sudo apt-get update
sudo apt-get -y install grafana

Step 5: Enable and Start Grafana Service:

• To automatically start Grafana after a reboot, enable the service:

sudo systemctl enable grafana-server

• Then, start Grafana:

sudo systemctl start grafana-server

Step 6: Check Grafana Status:

• Verify the status of the Grafana service to ensure it's running correctly:

sudo systemctl status grafana-server

Step 7: Access Grafana Web Interface:

• Open a web browser and navigate to Grafana using your server's IP address. The default port for Grafana is 3000. For example:

http://<your-server-ip>:3000

• You'll be prompted to log in to Grafana. The default username is "admin," and the default password is also "admin."

Step 8: Change the Default Password:

• When you log in for the first time, Grafana will prompt you to change the default password for security reasons. Follow the prompts to set a new password.

Step 9: Add Prometheus Data Source:

To visualize metrics, you need to add a data source. Follow these steps:

• Go to "Connections" in the left sidebar menu.

• Select "Data Sources."

• Click on the "Add data source" button.

• Choose "Prometheus" as the data source type.

• In the "Connection" section:

  • Set the "URL" to http://<Your_IP>:9090.
  • Click the "Save & Test" button to ensure the data source is working.

Step 10: Import node exporter Dashboard:

To make it easier to view metrics, you can import a pre-configured dashboard. Follow these steps:

• Go to "Dashboards" in the left menu bar.

• Click on the "+" (plus) icon in the top right corner.

• Click on the "Import" dashboard option.

• Enter the dashboard code you want to import (e.g., code 1860 for node exporter). (you can search for code on google)

• Click the "Load" button.

• Select the data source you added (Prometheus) from the dropdown.

• Click on the "Import" button.

You should now have a Grafana dashboard set up to visualize metrics from Prometheus.

Grafana is a powerful tool for creating visualizations and dashboards, and you can further customize it to suit your specific monitoring needs.

That's it! You've successfully installed and set up Grafana to work with Prometheus for monitoring and visualization.

Step 11: Install and Configure Prometheus Plugin Integration in Jenkins:

• Install "Prometheus metrics" in Jenkins

• Restart jenkins

• Go to Manage Jenkins > Systems

• look for Prometheus and don't change anything

• Click on apply and save

• We have already added Jenkins in Prometheus.yml file on monitoring server in Installing node exporter step.

Step 12: Add/Import Jenkins dashboard in grafana:

• Just like we added "Node exporter" dashboard.

• Import "Jenkins" dashboard in grafana.

Phase 5: Notification

Step 1: Implement Notification Services:

• Set up email notifications in Jenkins or other notification mechanisms.

• Go to System: From the Jenkins dashboard, go to Manage Jenkins > System

• Locate ‘Extended E-mail Notification’ Section: Scroll down to find the Extended E-mail Notification section

• SMTP Server Configuration:

  • SMTP Server: Enter the address of your SMTP server (e.g., smtp.gmail.com for Gmail).
  • Default User E-mail Suffix: If all emails are from the same domain (like @example.com), you can set it here.
  • Use SMTP Authentication: Enable this if your SMTP server requires authentication.
  • SMTP Username: Enter the username/email id for your email account.
  • SMTP Password: Enter the password for the email account (Create app password and use that instead of your actual password).
  • Use SSL/TLS: Enable this if required by your SMTP server. For Gmail, use SSL on port 465 or TLS on port 587.
  • SMTP Port: Common ports are 587 for TLS and 465 for SSL.
  • In our case we used SSL

• Add this Post build Email notification in Jenkins Pipeline script in the end

   post {
    always {
       emailext attachLog: true,
           subject: "'${currentBuild.result}'",
           body: "Project: ${env.JOB_NAME}<br/>" +
               "Build Number: ${env.BUILD_NUMBER}<br/>" +
               "URL: ${env.BUILD_URL}<br/>",
           to: 'iimransaifi1509@gmail.com',    
           attachmentsPattern: 'trivyfs.txt,trivyimage.txt'
       }
   }

Phase 6: Kubernetes

Create Kubernetes Cluster with Nodegroups

• In this phase, you'll set up a Kubernetes cluster with node groups. This will provide a scalable environment to deploy and manage your applications.

Monitor Kubernetes with Prometheus

• Prometheus is a powerful monitoring and alerting toolkit, and you'll use it to monitor your Kubernetes cluster. Additionally, you'll install the node exporter using Helm to collect metrics from your cluster nodes.

Install Node Exporter using Helm

• To begin monitoring your Kubernetes cluster, you'll install the Prometheus Node Exporter. This component allows you to collect system-level metrics from your cluster nodes. Here are the steps to install the Node Exporter using Helm:

1. Add the Prometheus Community Helm repository:

   helm repo add prometheus-community https://prometheus-community.github.io/helm-charts

2. Create a Kubernetes namespace for the Node Exporter:

   kubectl create namespace prometheus-node-exporter

3. Install the Node Exporter using Helm:

   helm install prometheus-node-exporter prometheus-community/prometheus-node-exporter --namespace prometheus-node-exporter

• Add a Job to Scrape Metrics on nodeip:9100/metrics in prometheus.yml:

• Update your Prometheus configuration (prometheus.yml) to add a new job for scraping metrics from nodeip:9100/metrics. You can do this by adding the following configuration to your prometheus.yml file:

  - job_name: "k8s"
    metrics_path: "/metrics"
    static_configs:
      - targets: ["node1Ip:9100"]

• Replace 'your-job-name' with a descriptive name for your job. The static_configs section specifies the targets to scrape metrics from, and in this case, it's set to nodeip:9100.

• Don't forget to reload or restart Prometheus to apply these changes to your configuration.

• To deploy an application with ArgoCD, you can follow these steps, which I'll outline in Markdown format:

Deploy Application with ArgoCD

1. Install ArgoCD:

   You can install ArgoCD on your Kubernetes cluster by following the instructions provided in the EKS Workshop documentation.

2. Set Your GitHub Repository as a Source:

   After installing ArgoCD, you need to set up your GitHub repository as a source for your application deployment. This typically involves configuring the connection to your repository and defining the source for your ArgoCD application. The specific steps will depend on your setup and requirements.

3. Create an ArgoCD Application:

   • name: Set the name for your application.
   • destination: Define the destination where your application should be deployed.
   • project: Specify the project the application belongs to.
   • source: Set the source of your application, including the GitHub repository URL, revision, and the path to the application within the repository.
   • syncPolicy: Configure the sync policy, including automatic syncing, pruning, and self-healing.

4. Access your Application

   • To Access the app make sure port 30007 is open in your security group and then open a new tab paste your NodeIP:30007, your app should be running.

Home Page

Phase 7: Cleanup

1. Cleanup AWS EC2 Instances:
   • Terminate AWS EC2 instances that are no longer needed.