Jenkins configuration as code (JCasC) - Mini Project: Build & Apply

Jenkins Configuration as Code (JCasC) Setup

📖 Scenario: You are setting up Jenkins for your team. Instead of clicking through the Jenkins UI, you want to use a text file to configure Jenkins automatically. This method is called Jenkins Configuration as Code (JCasC).This project will guide you to create a simple JCasC YAML file that defines the Jenkins system message and a security setting.

🎯 Goal: Build a Jenkins Configuration as Code (JCasC) YAML file that sets the Jenkins system message and disables the setup wizard.

📋 What You'll Learn

Create a YAML file named jenkins.yaml with Jenkins configuration

Add a system message configuration

Add a security setting to disable the setup wizard

Print the final YAML content to verify

💡 Why This Matters

🌍 Real World

Jenkins Configuration as Code (JCasC) lets teams manage Jenkins setup using text files. This makes Jenkins setup repeatable and easy to share.

💼 Career

Many DevOps roles require automating Jenkins setup. Knowing JCasC helps you configure Jenkins quickly and reliably without manual UI steps.

1

Create the initial Jenkins configuration YAML

Create a YAML file named jenkins.yaml with the root key jenkins and set the systemMessage to Welcome to Jenkins configured as code!.

Jenkins

# Create the initial YAML content with jenkins root and systemMessage
# Your code here

Hint

Use YAML syntax with indentation. The root key is jenkins. Under it, add systemMessage with the exact text.

2

Add the setup wizard disable configuration

Add a key disableSetupWizard under jenkins and set it to true to disable the Jenkins setup wizard.

Jenkins

jenkins:
  systemMessage: "Welcome to Jenkins configured as code!"
# Add disableSetupWizard: true below
# Your code here

Hint

Indent disableSetupWizard at the same level as systemMessage under jenkins.

3

Add security realm configuration

Under jenkins, add a securityRealm key with value "none" to disable security for this example.

Jenkins

jenkins:
  systemMessage: "Welcome to Jenkins configured as code!"
  disableSetupWizard: true
# Add securityRealm: "none" below
# Your code here

Hint

Make sure securityRealm is at the same indentation level as other keys under jenkins.

4

Print the final Jenkins configuration YAML

Print the content of the jenkins.yaml file to display the full Jenkins configuration.

Jenkins

jenkins:
  systemMessage: "Welcome to Jenkins configured as code!"
  disableSetupWizard: true
  securityRealm: "none"
# Print the YAML content below
# Your code here

Hint

Use a print statement to show the YAML content exactly as written.

Practice

1. What is the main purpose of Jenkins Configuration as Code (JCasC)?

easy

A. To monitor Jenkins server performance

B. To write Jenkins plugins in Java

C. To define Jenkins setup using a YAML file for easy automation

D. To create Jenkins jobs manually through the UI

Solution

1. Step 1: Understand JCasC concept

   JCasC allows Jenkins setup to be described in a YAML file instead of manual UI steps.

2. Step 2: Identify the main benefit

   This YAML file makes automation, sharing, and repeating Jenkins setup easy and safe.

3. Final Answer:

   To define Jenkins setup using a YAML file for easy automation -> Option C

4. Quick Check:

   JCasC = YAML setup automation [OK]

Hint: JCasC means Jenkins setup in YAML file [OK]

Common Mistakes:

• Confusing JCasC with plugin development
• Thinking JCasC is for manual UI job creation
• Assuming JCasC monitors performance

2. Which of the following is the correct syntax to define Jenkins system message in a JCasC YAML file?

easy

A. jenkins:
systemMessage: "Welcome to Jenkins!"

B. jenkins:
system_message: "Welcome to Jenkins!"

C. jenkins:
system-message: "Welcome to Jenkins!"

D. jenkins:
system message: "Welcome to Jenkins!"

Solution

1. Step 1: Check YAML key naming conventions

   JCasC uses camelCase keys matching Jenkins config names, so 'systemMessage' is correct.

2. Step 2: Validate YAML syntax

   jenkins: systemMessage: "Welcome to Jenkins!" uses correct key and proper YAML indentation and quotes.

3. Final Answer:

   jenkins:\n systemMessage: "Welcome to Jenkins!" -> Option A

4. Quick Check:

   Correct key is systemMessage in YAML [OK]

Hint: Use camelCase keys exactly as Jenkins expects [OK]

Common Mistakes:

• Using underscores instead of camelCase
• Using spaces or dashes in keys
• Incorrect YAML indentation

3. Given this JCasC snippet, what will be the Jenkins admin username after applying it?

jenkins:
  securityRealm:
    local:
      allowsSignup: false
      users:
        - id: "admin"
          password: "admin123"

medium

A. root

B. user

C. guest

D. admin

Solution

1. Step 1: Read the users list in securityRealm

   The YAML defines one user with id 'admin' and password 'admin123'.

2. Step 2: Identify the admin username

   The user id 'admin' is the admin username set by this config.

3. Final Answer:

   admin -> Option D

4. Quick Check:

   User id in YAML = admin [OK]

Hint: Look for 'id' under users in securityRealm [OK]

Common Mistakes:

• Assuming default username instead of YAML value
• Confusing password with username
• Ignoring YAML indentation and structure

4. You applied this JCasC YAML but Jenkins failed to start:

jenkins:
  systemMessage "Hello Jenkins!"

What is the error in this configuration?

medium

A. Incorrect indentation of systemMessage

B. Missing colon ':' after systemMessage key

C. systemMessage should be under securityRealm

D. Quotes around Hello Jenkins! are not allowed

Solution

1. Step 1: Check YAML key-value syntax

   YAML requires a colon ':' after keys to separate them from values.

2. Step 2: Identify missing colon

   The line 'systemMessage "Hello Jenkins!"' misses the colon after systemMessage.

3. Final Answer:

   Missing colon ':' after systemMessage key -> Option B

4. Quick Check:

   YAML key:value needs colon [OK]

Hint: YAML keys must have colon ':' before values [OK]

Common Mistakes:

• Forgetting colon after key
• Misplacing keys under wrong parent
• Thinking quotes are forbidden

5. You want to automate Jenkins setup with JCasC to create two users: 'alice' and 'bob'. Which YAML snippet correctly defines both users with passwords?

hard

A. jenkins:
securityRealm:
local:
allowsSignup: false
users:
- id: "alice"
password: "alicePass"
- id: "bob"
password: "bobPass"

B. jenkins:
securityRealm:
local:
allowsSignup: false
users:
id: "alice"
password: "alicePass"
id: "bob"
password: "bobPass"

C. jenkins:
securityRealm:
local:
allowsSignup: false
users:
alice: "alicePass"
bob: "bobPass"

D. jenkins:
securityRealm:
local:
allowsSignup: false
users:
- alice: "alicePass"
- bob: "bobPass"

Solution

1. Step 1: Understand users list format

   Users must be a list of maps with 'id' and 'password' keys for each user.

2. Step 2: Check each option's structure

   jenkins: securityRealm: local: allowsSignup: false users: - id: "alice" password: "alicePass" - id: "bob" password: "bobPass" correctly uses a list with '- id' and 'password' pairs for alice and bob.

3. Final Answer:

   jenkins:\n securityRealm:\n local:\n allowsSignup: false\n users:\n - id: "alice"\n password: "alicePass"\n - id: "bob"\n password: "bobPass" -> Option A

4. Quick Check:

   Users list with id/password pairs = jenkins: securityRealm: local: allowsSignup: false users: - id: "alice" password: "alicePass" - id: "bob" password: "bobPass" [OK]

Hint: Users must be list items with id and password keys [OK]

Common Mistakes:

• Defining users as a map instead of list
• Repeating keys without list dash
• Using username as key instead of id