Spring PetClinic Sample Application

Understanding the Spring Petclinic application with a few diagrams

Run Petclinic locally

Spring Petclinic is a Spring Boot application built using Maven or Gradle. You can build a jar file and run it from the command line (it should work just as well with Java 17 or newer):

git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic
./mvnw package
java -jar target/*.jar

You can then access the Petclinic at http://localhost:8080/.

Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this, it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this):

./mvnw spring-boot:run

NOTE: If you prefer to use Gradle, you can build the app using ./gradlew build and look for the jar file in build/libs.

Spring PetClinic Application Deployment Guide

Prerequisites

AWS Account with appropriate permissions
AWS CLI installed and configured
kubectl installed
Helm installed
Git installed

1. Repository Setup

# Clone the repository
git clone https://github.com/SubbuTechOps/spring-petclinic.git
cd spring-petclinic

# Verify the contents
ls -la

2. EKS Cluster Setup

EKS Cluster Setup Guide

This document provides access to the comprehensive guide for setting up an Amazon EKS (Elastic Kubernetes Service) cluster.

Guide Access

📚 EKS Cluster Setup Guide

📚 EKS Cluster Setup Steps

Contents Overview

This guide includes:

EKS cluster creation steps
Networking configuration
Security group setup
Node group management
Access control configuration
Best practices and recommendations

3. Jenkins Installation

Jenkins Server Installation Script

📚 Download Jenkins Installation Script

This shell script automates the installation and configuration of Jenkins server and required tools.

Script Usage

chmod +x install-jenkins.sh
sudo ./install-jenkins.sh

Components Installed:

Essential system utilities (wget, curl, unzip, etc.)
Jenkins server
Docker
kubectl
AWS CLI
Trivy scanner
Helm
Required permissions and configurations

Access Details:

URL: http://YOUR_SERVER_IP:8080
Default Port: 8080
Initial Admin Password: Found in script output or at /var/lib/jenkins/secrets/initialAdminPassword

4. AWS Credentials Configuration

Generate Access Keys

Log in to AWS Management Console
Navigate to IAM (Identity and Access Management)
Select your IAM user
Go to "Security credentials" tab
Click "Create access key"
Download and securely store the credentials file

Configure AWS CLI

# Configure AWS CLI with your credentials
aws configure

AWS Access Key ID [None]: <Your-Access-Key>
AWS Secret Access Key [None]: <Your-Secret-Key>
Default region name [None]: ap-south-1
Default output format [None]: table

# Verify AWS CLI configuration
aws sts get-caller-identity

Configure kubectl for EKS on Jenkins Server

# List available EKS clusters
aws eks list-clusters

# Update kubeconfig for your EKS cluster
aws eks update-kubeconfig --name <your-cluster-name> --region <your-cluster-region>

# Verify kubeconfig
cat ~/.kube/config

# Test kubectl configuration
kubectl get nodes
kubectl get ns

5. SonarQube Server Installation

SonarQube Server Installation Script

📚 Download SonarQube Installation Script

This shell script automates the installation and configuration of SonarQube server.

Script Usage

chmod +x install-sonarqube.sh
sudo ./install-sonarqube.sh

Components and Configurations:

SonarQube server (Latest LTS version)
Dedicated sonar user
Systemd service for automatic startup
System limits and requirements
Firewall rules

Default Access:

URL: http://YOUR_SERVER_IP:9000
Default credentials: admin/admin
Default port: 9000

Verification Commands:

# Check service status
sudo systemctl status sonarqube

# View logs
sudo tail -f /opt/sonarqube/logs/sonar.log

# Check if port is listening
sudo netstat -tlpn | grep 9000

Service Management:

# Stop SonarQube
sudo systemctl stop sonarqube

# Start SonarQube
sudo systemctl start sonarqube

# Restart SonarQube
sudo systemctl restart sonarqube

# Check logs
sudo journalctl -u sonarqube -f

Create PetClinic Project

Login to SonarQube (http://YOUR_SERVER_IP:9000)
Navigate to "Projects" → "Create Project"
Select "Manual" setup
Fill in project details:
- Project key: PetClinic
- Display name: PetClinic
- Main branch name: main

Generate Authentication Token

Go to User → My Account → Security
Generate a new token:
- Token name: jenkins-integration
- Expiration: Choose appropriate expiration (e.g., 30 days)
Copy and securely store the generated token

Configure Project Permissions

Go to Administration → Security → Users
Click on your user
Under "Permissions", ensure the following are enabled:
- Execute Analysis
- Create Projects
- Create Applications
- Create Portfolios

Configure Jenkins Integration

Add SonarQube Token to Jenkins

Navigate to Jenkins → Manage Jenkins → Credentials → System
Click on "Global credentials" → "Add Credentials"

Configure the credentials:

Kind: Secret text
Scope: Global
Secret: <Your-SonarQube-Token>
ID: sonar-credentials
Description: SonarQube Authentication Token

Configure SonarQube Server in Jenkins

Navigate to Jenkins Dashboard → Manage Jenkins → System
Scroll down to the "SonarQube servers" section
Configure the following settings:
- Check "Environment variables" if you want administrators to inject SonarQube configuration as environment variables
- Under "SonarQube installations":
  - Name: SonarQube
  - Server URL: http://3.92.82.78:9000 (replace with your SonarQube server IP)
  - Server authentication token:
    - Click "Add" → Select "Jenkins"
    - Kind: Secret text
    - Secret: Paste your SonarQube authentication token
    - ID: sonar-credentials
    - Description: "SonarQube Authentication Token"
    - Click "Add"
  - Select the created credential from the dropdown
- Click "Advanced" if you need to configure additional settings
- Click "Save" or "Apply" to preserve the configuration

Verify SonarQube Configuration

After saving the configuration, return to the Jenkins dashboard
Create a test pipeline job
Add the following environment variables in your Jenkinsfile:

environment {
    SONARQUBE_HOST_URL = 'http://<sonar-ip>:9000'
    SONARQUBE_PROJECT_KEY = 'PetClinic'
    SONARQUBE_TOKEN = credentials('sonar-credentials')
}

Troubleshooting

# Check SonarQube logs
sudo tail -f /opt/sonarqube/logs/sonar.log

# Verify SonarQube service status
sudo systemctl status sonarqube

# Check Jenkins logs for integration issues
sudo tail -f /var/log/jenkins/jenkins.log

# Test SonarQube connectivity from Jenkins
curl -v http://<sonar-ip>:9000

6. Tools and Plugins Configuration

Essential Jenkins Plugins

Pipeline and SCM
- Pipeline
- Git
- GitHub Integration
Build Tools
- Maven Integration
- JDK Tool
Docker & Kubernetes
- Docker
- Docker Pipeline
- Kubernetes
- Kubernetes CLI
SonarQube
- SonarQube Scanner
- Quality Gates
Credentials
- Credentials Binding
- Credentials

Installation Steps

Go to Jenkins Dashboard → Manage Jenkins → Plugins → Available plugins
Search and install the above plugins
Select "Install without restart"
Restart Jenkins after installation completes

Verification

After restart, verify in Manage Jenkins → Plugins → Installed plugins that all required plugins are active.

Configure Credentials

Navigate to Jenkins > Manage Jenkins > Manage Credentials
Add the following credentials:
- GitHub credentials
- Docker Hub credentials
- AWS credentials
- SonarQube Token
- Kubernetes configuration

7. Kubernetes Configuration

Create ConfigMap

# app-config.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
  namespace: petclinic-dev
data:
  MYSQL_DATABASE: petclinic
  MYSQL_URL: jdbc:mysql://mysql-service:3306/petclinic

Create Secrets

# db-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: db-secrets
  namespace: petclinic-dev
type: Opaque
data:
  MYSQL_USER: cGV0Y2xpbmlj          # Base64 encoded value for 'petclinic'
  MYSQL_PASSWORD: cGV0Y2xpbmlj      # Base64 encoded value for 'petclinic'
  MYSQL_ROOT_PASSWORD: cm9vdA==     # Base64 encoded value for 'root'

Create PersistentVolume(PV)

# mysql-pv.yaml
apiVersion: v1
kind: PersistentVolume
metadata:
  name: mysql-pv
spec:
  capacity:
    storage: 8Gi
  accessModes:
    - ReadWriteOnce
  persistentVolumeReclaimPolicy: Retain
  storageClassName: manual
  awsElasticBlockStore:
    volumeID: vol-00ad22c086bb5817f
    fsType: ext4

Note:

Guide: Setting Up EBS Volumes for Kubernetes PersistentVolumes

EBS Volume Setup Guide

8. Helm Charts

Directory Structure

petclinic-chart/
├── templates/
│   ├── deployment-app.yaml
│   ├── deployment-db.yaml
│   ├── pvc.yaml
│   ├── service-app.yaml
│   └── service-db.yaml
├── Chart.yaml
└── values.yaml

Check the following directory for all charts used in the project:

🗂️ Petclinic Chart Directory - Contains main chart configuration and values
📑 Templates Directory - Contains Kubernetes manifests and service definitions

Petclinic Chart Directory

Templates Directory

9. CI/CD Pipeline

🔄 Jenkins Pipeline - Contains CICD pipeline configuration and build steps:

Jenkins Pipeline File

10. Post-deployment Verification

📋 Deployment Resources: 📚 Project Demo Steps

🔍 Post-deployment Verification - Complete verification steps and checks after deployment

# Check deployment status
kubectl get deployments -n petclinic-dev

# Check pods
kubectl get pods -n petclinic-dev

# Check services
kubectl get svc -n petclinic-dev

# View logs
kubectl logs -f deployment/petclinic -n petclinic-dev

# Test the application
curl http://$(kubectl get svc petclinic -n petclinic-dev -o jsonpath='{.status.loadBalancer.ingress[0].hostname}'):8080

11. Troubleshooting Guide

Common Issues and Solutions

Jenkins Pipeline Failures
- Issue: Maven build fails
- Solution: Check Java version compatibility and Maven settings
Docker Issues
- Issue: Permission denied
- Solution: Ensure Jenkins user is in docker group
```
sudo usermod -aG docker jenkins
sudo service jenkins restart
```
Kubernetes Deployment Issues
- 🛠️ Kubernetes Troubleshooting Guide - Common issues and solutions for Kubernetes deployments
Database Connection Issues
- Issue: Application can't connect to MySQL
- Solution: Verify MySQL service and credentials
```
kubectl exec -it <mysql-pod> -- mysql -u root -p
```

Health Check Commands

# Check node status
kubectl get nodes

# Check pod health
kubectl get pods -n petclinic-dev -o wide

# Check logs
kubectl logs -f deployment/petclinic -n petclinic-dev

# Check service endpoints
kubectl get endpoints -n petclinic-dev

Remember to replace placeholder values such as your-region, your-docker-hub-username, and adjust resource limits based on your requirements.

For additional support or specific error resolution, consult the project's GitHub issues or create a new issue with detailed information about the problem encountered.

Name		Name	Last commit message	Last commit date
Latest commit History 1,098 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.mvn/wrapper		.mvn/wrapper
documentation		documentation
gradle/wrapper		gradle/wrapper
k8s		k8s
petclinic-chart		petclinic-chart
src		src
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitpod.yml		.gitpod.yml
Dockerfile		Dockerfile
Jenkinsfile		Jenkinsfile
LICENSE.txt		LICENSE.txt
Steps-Implement		Steps-Implement
build.gradle		build.gradle
docker-compose.yml		docker-compose.yml
gradlew		gradlew
gradlew.bat		gradlew.bat
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml
readme.md		readme.md
settings.gradle		settings.gradle

License

SubbuTechOps/spring-petclinic

Folders and files

Latest commit

History

Repository files navigation

Spring PetClinic Sample Application

Understanding the Spring Petclinic application with a few diagrams

Run Petclinic locally

Spring PetClinic Application Deployment Guide

Table of Contents

Prerequisites

1. Repository Setup

2. EKS Cluster Setup

EKS Cluster Setup Guide

Guide Access

Contents Overview

3. Jenkins Installation

Jenkins Server Installation Script

Script Usage

Components Installed:

Access Details:

4. AWS Credentials Configuration

Generate Access Keys

Configure AWS CLI

Configure kubectl for EKS on Jenkins Server

5. SonarQube Server Installation

SonarQube Server Installation Script

Script Usage

Components and Configurations:

Default Access:

Verification Commands:

Service Management:

Create PetClinic Project

Generate Authentication Token

Configure Project Permissions

Configure Jenkins Integration

Add SonarQube Token to Jenkins

Configure SonarQube Server in Jenkins

Verify SonarQube Configuration

Troubleshooting

6. Tools and Plugins Configuration

Essential Jenkins Plugins

Installation Steps

Verification

Configure Credentials

7. Kubernetes Configuration

Create ConfigMap

Create Secrets

Create PersistentVolume(PV)

Guide: Setting Up EBS Volumes for Kubernetes PersistentVolumes

8. Helm Charts

Directory Structure

Check the following directory for all charts used in the project:

9. CI/CD Pipeline

10. Post-deployment Verification

11. Troubleshooting Guide

Common Issues and Solutions

Health Check Commands

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 105

Uh oh!

Languages

Packages