How to Create CI/CD Pipeline with Jenkins, Docker and SonarQube

This tutorial will walk you through a comprehensive CI/CD pipeline setup using popular tools like Jenkins, Docker, and SonarQube, all within the robust environment of AWS EC2 instances.

Part 1: CI with GitHub and Jenkins

Continuous Integration (CI) is a crucial first step towards streamlined software development. This involves frequent code merging into a central repository, enabling early detection of integration issues and ensuring code consistency. GitHub, a widely used platform for version control and collaboration, plays a central role in facilitating CI. Jenkins, a powerful open-source automation server, acts as the orchestrator, automating builds, tests, and deployments.

Setting Up Your CI Ecosystem

1. Preparing the Stage: Launching an AWS EC2 Instance
   To kickstart our CI/CD pipeline, we'll begin by provisioning an AWS EC2 instance specifically for Jenkins. This instance will house the Jenkins server, providing a secure and scalable environment for our automation tasks.

2. Installing Jenkins: The Heart of Your CI Pipeline
   With the EC2 instance up and running, we'll install Jenkins, the core component of our CI setup. Jenkins offers a vast array of plugins, enabling customization and integration with various tools and services.

   • Essential Prerequisites:

     • Java: Install the Java Development Kit (JDK) as a prerequisite for Jenkins.

     • Jenkins Installation: Utilize the provided instructions to install Jenkins from the official repository.

     • Enabling Services: Start and enable the Jenkins service to ensure it runs automatically on system startup.

3. Securing Access: AWS Security Group Configuration
   To access Jenkins, we need to configure the EC2 security group to allow inbound traffic on port 8080, which is typically used by Jenkins. This allows you to connect to Jenkins from your web browser and access the web interface.

4. Bridging GitHub and Jenkins: Webhook Integration
   The key to a seamless CI workflow lies in seamless communication between GitHub and Jenkins. GitHub webhooks provide a real-time notification system that triggers actions in Jenkins whenever a change occurs in your GitHub repository.

   • Setting Up Webhooks in GitHub: Navigate to your repository settings in GitHub, and configure a webhook pointing to your Jenkins server. This allows GitHub to send notifications to Jenkins whenever code is pushed or pull requests are made.

5. Creating a Jenkins Job: Automating Your Workflow
   To leverage the power of CI, we'll create a Jenkins job that automatically retrieves code from GitHub, builds the project, and runs tests.

   • Jenkins Job Configuration:

     • Source Code Management: Configure the Jenkins job to fetch code from your GitHub repository using Git.

     • Build Triggers: Enable GitHub hook triggers to automatically start a new build whenever a change is detected in your GitHub repository.

     • Build Steps: Define the steps for building your project, such as compiling code and running unit tests.

Part 2: Scanning and Security with SonarQube

Code quality is crucial for building robust and maintainable software. SonarQube, a popular open-source platform for continuous code inspection, steps in to analyze your codebase, identify potential issues, and provide insights into code quality.

Embracing Code Quality: SonarQube Integration

1. SonarQube Setup: A New EC2 Instance
   We'll launch a separate EC2 instance to host SonarQube, ensuring that our code analysis is performed efficiently without impacting other processes.

2. Installing SonarQube: Setting the Stage for Analysis

   • Prerequisites: Install Java 17, which is required for running SonarQube.

   • SonarQube Installation: Download and extract the SonarQube package, then start the SonarQube server.

3. SonarQube Configuration: Access and Security

   • AWS Security Group: Configure your EC2 security group to allow access to SonarQube on port 9000.

   • Initial Login: Access SonarQube through your web browser using the default username and password (admin).

   • Generating a Token: For security, create a unique token that will be used to connect SonarQube with Jenkins.

4. Jenkins and SonarQube Collaboration: Plugin Integration

   • SonarQube Scanner Plugin: Install the SonarQube Scanner plugin in Jenkins to enable code analysis.

   • SSH2 Easy Plugin: Install the SSH2 Easy plugin in Jenkins to facilitate communication between Jenkins and the SonarQube server.

5. Global Configuration: Connecting the Dots

   • Global Configuration: Configure the SonarQube Scanner in Jenkins, providing the SonarQube server URL and the token generated earlier.

6. Integrating SonarQube into Your Jenkins Job:

   • Adding a Build Step: Modify your Jenkins job to include a SonarQube build step. This will trigger code analysis using the SonarQube Scanner.

Part 3: Continuous Delivery with Docker and Jenkins

Continuous Delivery (CD) seamlessly connects the CI process with deployment, enabling continuous delivery of new software versions. Docker, a platform for building, shipping, and running applications in containers, plays a crucial role in facilitating CD.

Docker Integration: Building and Deploying with Ease

1. Docker Instance: A Dedicated Environment for Containerization
   Launch a third EC2 instance specifically for Docker, providing a dedicated environment for building and running Docker containers.

2. Installing Docker: The Foundation of Your CD Pipeline

   • Docker Installation: Install Docker on your Docker instance following the recommended procedures.

   • Docker Services: Ensure Docker is running and configured to start automatically on system boot.

3. SSH Key Generation: Seamless Connection to Docker

   • Generating SSH Keys: Generate an SSH key pair on your Jenkins instance to facilitate secure access to the Docker instance.

   • SSH Copy ID: Use the ssh-copy-id command to copy the public key to the Docker instance, enabling passwordless access.

4. Jenkins and Docker Configuration:

   • Server Center Groups: In Jenkins, create a server group for Docker and add the Docker instance's username and password.

   • Server List: Add the Docker server's IP address to the Jenkins Server List.

5. Code Transfer and Containerization:

   • File Transfer: Use the scp command to transfer your project files from the Jenkins instance to the Docker instance.

   • Building Docker Images: Execute Docker commands within Jenkins to build a Docker image for your application.

6. Running Docker Containers:

   • Docker Run Command: Utilize the docker run command to start a container based on the built image, configuring port mappings and a container name for easy access.

7. AWS Security Group Configuration:

   • Port Access: Open the required port on your AWS security group to access the running Docker container from your web browser.

Conclusion

By combining the power of Jenkins, GitHub, SonarQube, and Docker, we've built a robust and flexible CI/CD pipeline that can be adapted to a wide range of software development projects. This pipeline streamlines your development workflow, ensuring code quality, efficient deployment, and a continuous flow of software updates.

With this guide, you've gained a comprehensive understanding of how to implement a CI/CD pipeline that delivers a seamless development experience. Now, you're equipped to leverage automation and improve your software development practices, delivering high-quality software with increased speed and efficiency.