Skip to content

JENKINS.md

Latest commit

 

History

History
169 lines (130 loc) · 4.41 KB

JENKINS.md

File metadata and controls

169 lines (130 loc) · 4.41 KB

Jenkins CI/CD Pipeline Setup Guide

This guide provides step-by-step instructions for setting up a Jenkins CI/CD pipeline for the EasyShop application, including GitHub webhook configuration and shared library integration.

Table of Contents

Prerequisites

  • Ubuntu 22.04 LTS server
  • Jenkins installed
  • Docker installed
  • Git installed
  • GitHub account
  • Docker Hub account

Jenkins Installation

  1. Add Jenkins repository key:
curl -fsSL https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key | sudo tee \
    /usr/share/keyrings/jenkins-keyring.asc > /dev/null
  1. Add Jenkins repository:
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
  1. Update package list and install Jenkins:
sudo apt update
sudo apt install jenkins
  1. Start Jenkins service:
sudo systemctl start jenkins
sudo systemctl enable jenkins

Jenkins Configuration

1. Initial Setup

  1. Get the initial admin password:
sudo cat /var/lib/jenkins/secrets/initialAdminPassword
  1. Access Jenkins:
  • Open http://your-server-ip:8080
  • Enter the initial admin password
  • Install suggested plugins
  • Create admin user

2. Required Plugins

Install these plugins via "Manage Jenkins" > "Manage Plugins" > "Available":

  • Docker Pipeline
  • Email Extension Plugin
  • GitHub Integration Plugin
  • Pipeline Utility Steps

3. Credentials Setup

  1. Navigate to "Manage Jenkins" > "Manage Credentials"
  2. Add Docker Hub credentials:
    • Kind: Username with password
    • Scope: Global
    • ID: docker-hub-credentials
    • Username: Your Docker Hub username
    • Password: Your Docker Hub password

4. Email Notifications

  1. Go to "Manage Jenkins" > "Configure System"
  2. Configure E-mail Notification:
    • SMTP server: smtp.gmail.com
    • Use SMTP Authentication: Yes
    • User Name: Your email
    • Password: Your app password
    • Use SSL: Yes
    • SMTP Port: 465

GitHub Webhook Setup

1. Generate GitHub Token

  1. Go to GitHub.com > Settings > Developer settings > Personal access tokens
  2. Generate new token (classic)
  3. Select scopes:
    • repo (all)
    • admin:repo_hook
  4. Save the token

2. Configure GitHub in Jenkins

  1. Add GitHub token to Jenkins credentials:
    • Kind: Secret text
    • Scope: Global
    • ID: github-token
    • Description: GitHub Token

3. Setup Webhook

  1. In your GitHub repository:
    • Go to Settings > Webhooks
    • Add webhook
    • Payload URL: http://your-jenkins-url:8080/github-webhook/
    • Content type: application/json
    • Select: Just the push event

Pipeline Configuration

1. Create Pipeline

  1. Click "New Item"
  2. Enter name: "easyshop-pipeline"
  3. Select "Pipeline"
  4. Configure:
    • GitHub project URL
    • Build Triggers: GitHub hook trigger for GITScm polling
    • Pipeline script from SCM
    • Git repository URL
    • Branch: */main
    • Script Path: Jenkinsfile

2. Shared Library Integration

Our pipeline uses a shared library from: EasyShop Jenkins Shared Library

  1. Go to "Manage Jenkins" > "Configure System"
  2. Under "Global Pipeline Libraries":

3. Pipeline Stages

Our pipeline includes these stages:

  1. Checkout: Cleans workspace and checks out code
  2. Build Docker Images: Builds application containers
  3. Push to Docker Hub: Pushes images to registry
  4. Deploy to Production: Deploys the application
  5. Email Notification: Sends build status

Logs Location

Important log locations:

  • Jenkins logs: /var/log/jenkins/jenkins.log
  • Docker logs: docker logs container-name
  • Build logs: Available in Jenkins job console output

References