Jenkins declarative pipeline

🎭 Role

You are a Senior DevOps Engineer and CI/CD Architect specializing in Jenkins automation, container orchestration, and DevSecOps best practices. Your expertise lies in writing clean, modular, and scalable Jenkins Declarative Pipelines that adhere to industry standards for security, reliability, and observability.

🌐 Context

We are modernizing our CI/CD workflow for a Java-based enterprise application. The goal is to establish a robust, automated pipeline that accelerates delivery while maintaining high code quality and secure deployment standards. The pipeline must be defined as code (Jenkinsfile) and capable of running in a distributed Jenkins environment.

🛠️ Task Instruction

Design a production-ready Jenkins Declarative Pipeline for a Java application. The pipeline must execute the following stages:

1. Checkout: Pull source code from [GIT_REPOSITORY_URL] using credentials defined in [GIT_CREDENTIALS_ID].
2. Build: Compile the application and package the artifact using Maven.
3. Quality Assurance (Parallelized):
   • Unit Tests & Coverage: Run Maven tests and generate JaCoCo reports.
   • Static Code Analysis: Analyze code quality using SonarQube (requires configuration for [SONAR_SERVER_URL]).
4. Containerization: Build a Docker image from the Dockerfile and push it to [DOCKER_REGISTRY_URL] using credentials [REGISTRY_CREDENTIALS_ID].
5. Deployment: Deploy the application to a [KUBERNETES_NAMESPACE] in the target Kubernetes cluster using [KUBECONFIG_ID].
6. Verification: Execute smoke tests against the deployed environment to ensure service availability.

Technical Constraints & Guidelines

• Pipeline as Code: Use a Jenkinsfile structure with standard stages and steps.
• Credential Management: Use credentials() binding for all sensitive data; never hardcode secrets.
• Efficiency: Utilize parallel blocks for independent tasks (e.g., Testing and Analysis).
• Observability: Implement post actions to trigger email notifications on failure using [SMTP_SERVER_CONFIG]. Archive build artifacts and test reports.
• Best Practices: Use environment variables for configuration, include a clean agent block (e.g., kubernetes pod template), and incorporate options { timeout(...) } and ansiColor('xterm').
• Tone: Professional, technical, and precise. Avoid overly verbose explanations; prioritize code comments that explain "why" rather than "what."

📝 Output Format

1. High-Level Architecture: A brief summary of the pipeline design.
2. Jenkinsfile: The complete, syntactically correct code block.
3. Required Plugins: A list of essential Jenkins plugins needed for this pipeline to function (e.g., Pipeline, Docker Pipeline, SonarQube Scanner).
4. Configuration Requirements: A checklist of items to configure in the Jenkins Global Tool Configuration and Credentials Manager before execution.

Placeholders

• [GIT_REPOSITORY_URL]
• [GIT_CREDENTIALS_ID]
• [SONAR_SERVER_URL]
• [DOCKER_REGISTRY_URL]
• [REGISTRY_CREDENTIALS_ID]
• [KUBERNETES_NAMESPACE]
• [KUBECONFIG_ID]
• [SMTP_SERVER_CONFIG]