Jenkins configuration as code (JCasC) - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Jenkins Configuration as Code (JCasC)?

JCasC is a Jenkins plugin that lets you define Jenkins settings and jobs using YAML files. This makes Jenkins setup repeatable and easy to share.

beginner

How do you apply a JCasC YAML file to Jenkins?

You place the YAML file in a location Jenkins can read, then configure Jenkins to load it at startup or via the JCasC plugin UI.

beginner

What is a key benefit of using JCasC?

It makes Jenkins configuration version-controlled and reproducible, so you can rebuild your Jenkins setup anytime exactly the same.

beginner

Which file format does JCasC use for configuration?

JCasC uses YAML format files to describe Jenkins configuration.

intermediate

Name one common Jenkins setting you can configure with JCasC.

You can configure security settings, plugins, credentials, nodes, and more using JCasC.

What does JCasC stand for in Jenkins?

A Jenkins Configuration as Code

B Java Configuration and Script Control

C Jenkins Continuous Automation Script

D Job Configuration and Script Control

JCasC stands for Jenkins Configuration as Code, a plugin to define Jenkins setup using code.

Which file format is used by Jenkins Configuration as Code?

A YAML

B XML

C JSON

D INI

JCasC uses YAML files to describe Jenkins configuration.

What is a main advantage of using JCasC?

A Manual configuration through UI only

B Only works on Windows

C Requires no plugins

D Version-controlled and repeatable Jenkins setup

JCasC allows Jenkins configuration to be version-controlled and easily repeated.

How do you apply a JCasC configuration to Jenkins?

A By editing Jenkins core files

B By uploading YAML file via JCasC plugin or placing it in a known location

C By running a shell script

D By restarting Jenkins without any files

You apply JCasC by providing the YAML config file through the plugin or Jenkins startup.

Which Jenkins components can be configured using JCasC?

A Only jobs

B Only plugins

C Security, plugins, credentials, nodes, and more

D Only user accounts

JCasC can configure many Jenkins components including security, plugins, credentials, and nodes.

Explain what Jenkins Configuration as Code (JCasC) is and why it is useful.

Think about how you can save and share Jenkins setup as code.

Describe the steps to apply a JCasC YAML configuration file to a Jenkins server.

Consider how Jenkins reads configuration files on startup or via plugin UI.

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