Jenkins Health code-bundle

.gitignore

@@ -8,6 +8,8 @@ build
 *egg-info
 .kube
 *.out
+# Ignore SSH private key files
+*.pem
 
 # Ignore Terraform state files
 **/terraform.tfstate

codebundles/jenkins-health/.runwhen/generation-rules/jenkins-instance-health.yaml

@@ -0,0 +1,29 @@
+apiVersion: runwhen.com/v1
+kind: GenerationRules
+spec:
+  platform: aws
+  generationRules:
+    - resourceTypes:
+        - ec2_instance
+      matchRules:
+        - type: and
+          matches:
+            - type: pattern
+              pattern: "jenkins-server"
+              properties: [tag-values]
+              mode: substring
+            - type: pattern
+              pattern: "running"
+              properties: [state/Name]
+              mode: substring
+
+      slxs:
+        - baseName: jenkins-instance-health
+          levelOfDetail: detailed
+          qualifiers: ["resource"]
+          baseTemplateName: jenkins-instance-health
+          outputItems:
+            - type: slx
+            - type: sli
+            - type: runbook
+              templateName: jenkins-instance-health-taskset.yaml

codebundles/jenkins-health/.runwhen/templates/jenkins-instance-health-sli.yaml

@@ -0,0 +1,49 @@
+apiVersion: runwhen.com/v1
+kind: ServiceLevelIndicator
+metadata:
+  name: {{slx_name}}
+  labels:
+    {% include "common-labels.yaml" %}
+  annotations:
+    {% include "common-annotations.yaml" %}
+spec:
+  displayUnitsLong: OK
+  displayUnitsShort: ok
+  locations:
+      - {{default_location}}
+  description: The number of failed Jenkins builds.
+  codeBundle:
+    {% if repo_url %}
+    repoUrl: {{repo_url}}
+    {% else %}
+    repoUrl: https://github.com/runwhen-contrib/rw-cli-codecollection.git
+    {% endif %}
+    {% if ref %}
+    ref: {{ref}}
+    {% else %}
+    ref: main
+    {% endif %}
+    pathToRobot: codebundles/jenkins-health/sli.robot
+  intervalStrategy: intermezzo
+  intervalSeconds: 600
+  configProvided:
+    - name: JENKINS_URL
+      value: {{custom.jenkins_url}}
+  secretsProvided:
+    - name: JENKINS_USERNAME
+      workspaceKey: {{custom.jenkins_username}}
+    - name: JENKINS_TOKEN
+      workspaceKey: {{custom.jenkins_token}}
+  alerts:
+    warning:
+      operator: <
+      threshold: '1'
+      for: '20m'
+    ticket:
+      operator: <
+      threshold: '1'
+      for: '40m'
+    page:
+      operator: '=='
+      threshold: '0'
+      for: '' 

codebundles/jenkins-health/.runwhen/templates/jenkins-instance-health-slx.yaml

@@ -0,0 +1,20 @@
+apiVersion: runwhen.com/v1
+kind: ServiceLevelX
+metadata:
+  name: {{slx_name}}
+  labels:
+    {% include "common-labels.yaml" %}
+  annotations:
+    {% include "common-annotations.yaml" %}
+spec:
+  imageURL: https://storage.googleapis.com/runwhen-nonprod-shared-images/icons/Jenkins_logo.svg
+  alias: {{match_resource.resource.tags.Name}} Instance Health
+  # alias: Jenkins Health
+  asMeasuredBy: The number of failed Jenkins builds.
+  configProvided:
+  - name: SLX_PLACEHOLDER
+    value: SLX_PLACEHOLDER
+  owners:
+  - {{workspace.owner_email}}
+  statement: The number of failed Jenkins builds should be zero.
+  additionalContext:  []

codebundles/jenkins-health/.runwhen/templates/jenkins-instance-health-taskset.yaml

@@ -0,0 +1,31 @@
+apiVersion: runwhen.com/v1
+kind: Runbook
+metadata:
+  name: {{slx_name}}
+  labels:
+    {% include "common-labels.yaml" %}
+  annotations:
+    {% include "common-annotations.yaml" %}
+spec: 
+  location: {{default_location}}
+  codeBundle:
+    {% if repo_url %}
+    repoUrl: {{repo_url}}
+    {% else %}
+    repoUrl: https://github.com/runwhen-contrib/rw-cli-codecollection.git
+    {% endif %}
+    {% if ref %}
+    ref: {{ref}}
+    {% else %}
+    ref: main
+    {% endif %}
+    pathToRobot: codebundles/jenkins-health/runbook.robot
+  configProvided:
+    - name: JENKINS_URL
+      value: {{custom.jenkins_url}}
+  secretsProvided:
+    - name: JENKINS_USERNAME
+      workspaceKey: {{custom.jenkins_username}}
+    - name: JENKINS_TOKEN
+      workspaceKey: {{custom.jenkins_token}}
+

codebundles/jenkins-health/.test/README.md

@@ -0,0 +1,135 @@
+### How to test this codebundle? 
+
+## Prerequisites
+
+The following credentials and configuration are required:
+
+- Jenkins URL
+- Jenkins username 
+- Jenkins API token
+
+## Configuration
+
+**Infrastructure Deployment**
+
+Purpose: Cloud infrastructure provisioning and management using Terraform
+
+#### Credential Setup
+
+Navigate to the `.test/terraform` directory and configure two secret files for authentication:
+
+`cb.secret` - CloudCustodian and RunWhen Credentials
+
+Create this file with the following environment variables:
+
+	```sh
+	export RW_PAT=""
+	export RW_WORKSPACE=""
+	export RW_API_URL="papi.beta.runwhen.com"
+
+    export JENKINS_URL=""
+	export JENKINS_USERNAME=""
+	export JENKINS_TOKEN=""
+	```
+
+
+`tf.secret` - Terraform Deployment Credentials
+
+Create this file with the following environment variables:
+
+	```sh
+	export AWS_DEFAULT_REGION=""
+	export AWS_ACCESS_KEY_ID=""
+	export AWS_SECRET_ACCESS_KEY=""
+	export AWS_SESSION_TOKEN="" # Optional: Include if using temporary credentials
+	```
+
+####  Testing Workflow
+
+1. Build test infra:
+	```sh
+		task build-infra
+	```	
+
+2. Configure Jenkins and create pipelines:
+
+	- **Initial Setup**: Follow the Jenkins UI prompts to install suggested plugins.
+
+	- **Reproducing Scenarios**:
+
+	  - **Failed Pipeline Logs**:
+		 Create a `Freestyle project` and choose the `Execute shell` option under `Build Steps` with an arbitrary script that will fail, such as a syntax error.
+
+	  - **Long Running Pipelines**:
+		 Create a `Freestyle project` and choose the `Execute shell` option under `Build Steps`. Use the following script:
+		 ```sh
+		 #!/bin/bash
+
+		 # Print the start time
+		 echo "Script started at: $(date)"
+
+		 # Sleep for 30 minutes (1800 seconds)
+		 sleep 1800
+
+		 # Print the end time
+		 echo "Script ended at: $(date)"
+		 ```
+
+	  - **Queued Builds**:
+		 Create three `Freestyle projects` using the above long-running script. With the default Jenkins setup having two executors, triggering all three projects will result in one being queued for a long time.
+
+	  - **Failed Tests**:
+		 Create a `Pipeline` project and under the Definition section, paste the following Groovy script:
+		 ```groovy
+			pipeline {
+				agent any
+
+				tools {
+					// Install the Maven version configured as "M3" and add it to the path.
+					maven "M3"
+				}
+
+				stages {
+					stage('Build') {
+						steps {
+							// Get some code from a GitHub repository
+							git 'https://github.com/saurabh3460/simple-maven-project-with-tests.git'
+
+							// Run Maven on a Unix agent.
+							sh "mvn -Dmaven.test.failure.ignore=true clean package"
+
+							// To run Maven on a Windows agent, use
+							// bat "mvn -Dmaven.test.failure.ignore=true clean package"
+						}
+
+						post {
+							// If Maven was able to run the tests, even if some of the test
+							// failed, record the test results and archive the jar file.
+							success {
+								junit '**/target/surefire-reports/TEST-*.xml'
+								archiveArtifacts 'target/*.jar'
+							}
+						}
+					}
+				}
+			}
+		 ```
+
+
+3. Generate RunWhen Configurations
+	```sh
+		tasks
+	```
+
+4. Upload generated SLx to RunWhen Platform
+
+	```sh
+		task upload-slxs
+	```
+
+5. At last, after testing, clean up the test infrastructure.
+
+	```sh
+		task clean
+	```
+