Schema

Description of Jenkins Agent

Executors defines the maximum number of concurrent builds that Jenkins may perform on this node.

RemoteRootDirectory is directory dedicated to Jenkins for temporary files storage purposes.

Usage controls how Jenkins schedules builds on this node. Available usage options are defined by AgentUsage enum

LaunchMethod controls how Jenkins starts this agent. AgentLaunchMethod is enum that defines the available launch methods

DisableWorkDir allows disabling Remoting Work Directory for the agent.

CustomWorkDirPath is a custom Remoting work directory will be used instead of the Agent Root Directory

InternalDataDirectory defines a storage directory for the internal data By default it’s “remoting”

FailIfWorkspaceIsMissing if true, remoting will fail at startup if the target work directory is missing

UseWebSocket uses websocket to connect to the Jenkins Controller rather than the TCP port

TunnelConnectionThrough allows to route connection to another host Field allowed values: “HOST:PORT”, “:PORT” and “HOST:”

JVMOptions are additional startup arguments for Java Virtual Machine which runs agent

Availability controls when Jenkins starts and stops this agent.

ToolLocations is list of tools location

Name is unique within a namespace to reference a secret resource.

Namespace defines the space within which the secret name must be unique.

ConnectionStringSecretKeySelector is selector for Azure Storage Account connection string secret

Jobs backup enable/disable toggle

Artifacts backup enable/disable toggle

Artifacts backup enable/disable toggle

PersistentVolumeClaim is default vanilla Kubernetes storage provider

AzureFiles is Microsoft Azure storage provider

AmazonS3 is storage provider for Amazon Web Services cloud

GoogleCloudStorage is storage provider used in Google Cloud Platform

CronSchedule is cron format schedule

IgnoreMissingFiles is setting for Job DSL API plugin to ignore files that are missing

AdditionalClasspath is setting for Job DSL API plugin to set Additional Classpath

FailOnMissingPlugin is setting for Job DSL API plugin that fails job if required plugin is missing

UnstableOnDeprecation is setting for Job DSL API plugin that sets build status as unstable if build using deprecated features

Type indicates which authentication provider is set

GitHub is configuration for GitHub OAuth provider

SAML is configuration for enterprise authentication providers like OneLogin or Okta

UserPassword is basic authentication provider which configures basic username/password authentication

Conditions contains JenkinsAuthentication statuses

Type indicates which authorization provider is set

Matrix is matrix-based authorization configuration NOTE: It requires additional plugin

Conditions contains JenkinsAuthorization statuses

Retention defines how much backups are being stored at the same time

Data configures which data will be included in backup

Trigger defines the conditions when the backup is being created

OperatorVersion is the operator version which manages this CR

Conditions contains JenkinsBackupConfig statuses

Data is inline configuration as code script

SecretRef is secret reference which allows to inject the secrets into CASC code

Conditions contains JenkinsConfigurationAsCode statuses

Hash contains hash computed when running this CASC code

Name of the script being referenced

Namespace of referenced JenkinsGroovyScript

Data is inline Groovy script

SecretRef is secret reference which allows to inject the secrets into Groovy script code

DependsOn is JenkinsGroovyScript reference which determines the order of the Groovy scripts

OperatorVersion is the operator version which manages this CR

Conditions contains JenkinsAuthentication statuses

Hash contains hash computed when running this script

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

Properties configures the Jenkins agent

PodSpec allows to set Jenkins Kubernetes Agent specific pod properties

Roles defines list of extra RBAC roles for the Jenkins Kubernetes Agent pod service account

ProvisionStartTime is a time when Jenkins agent pod has been created

Conditions contains JenkinsKubernetesAgent statuses

OperatorVersion is the operator version which manages this CR

Conditions contains JenkinsNotification statuses

Description is the description of the seed job

Repository is the place where seed job definitions are defined

Triggers are used for Git servers web hooks

AgentRef is reference to agent

Settings configures the Git specific properties

OperatorVersion is the operator version which manages this CR

Conditions contains JenkinsSeedJob statuses

Hash contains hash computed when running this script

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

PodSpec allows to set Jenkins Kubernetes specific pod properties

HomePVC allows to set PersistentVolumeClaim properties for Jenkins home

Roles defines list of extra RBAC roles for the Jenkins Controller pod service account

Plugins contains plugins required by user Can be overridden Defaults plugins: - name: kubernetes version: 1.25.2 - name: workflow-job version: “2.39” - name: workflow-aggregator version: “2.6” - name: git version: 4.2.2 - name: job-dsl version: “1.77” - name: configuration-as-code version: “1.38” - name: kubernetes-credentials-provider version: 0.13

PluginsCache allows to set plugins cache specific pvc properties

Services allows to configure Jenkins services

DisableCSRFProtection allows you to toggle CSRF Protection on Jenkins

OperatorVersion is the operator version which manages this CR

ProvisionStartTime is a time when Jenkins Controller pod has been created

BaseGroovyScriptsAppliedTime is a time when base groovy scripts were applied

Conditions contains Jenkins statuses

Administrators is list of the users with administrative permissions

The web hook URL to MicrosoftTeams App

AccessMode specifies the way the plugins cache can be mounted

ResourceStorage is the plugins cache volume size

StorageClassName is the name of the StorageClass required by the claim

ClaimName is name of PVC which will be used as backup storage

Name is the name of Jenkins plugin

Version is the version of Jenkins plugin

DownloadURL is the custom url from where plugin has to be downloaded

Branch is the repository branch where seed job definitions are stored

URL is the repository access URL. Can be SSH or HTTPS.

Targets is the path from repository root where seed job definitions are stored

CredentialID is the Kubernetes secret name which stores repository access credentials

CredentialType is the https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/ credential type

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

Last time we probed the condition.

Last time the condition transitioned from one status to another.

Unique, one-word, CamelCase reason for the condition’s last transition.

Human-readable message indicating details about last transition.

IdPMetadata is identity provider metadata file content.

IdPMetadataURL is identity provider metadata file source URL.

RefreshPeriod indicates period of minutes that we will wait until refresh the IdP Metadata. Set it to 0 to not update the metadata.

DisplayNameAttribute is name of the attribute that carries the display name By default it’s http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

GroupAttribute is name of the attribute that carries user groups By default it’s http://schemas.xmlsoap.org/claims/Group

MaximumAuthenticationLifetime is number of seconds since the user was authenticated in IdP while his authentication is considering as active By default it’s 86400

UsernameAttribute is name of the attribute that carries user name which will be used as the Jenkins ID If blank, the nameID provided by identity provider is used

EmailAttribute is email attribute in SAML response

UsernameCaseConvention defines the convention for converting usernames

DataBindingMethod defines redirection method binding

LogoutURL is logout URL where user will be redirected once logout

Advanced contains additional mechanisms for SAML login

Encryption contains additional configuration for setting up encryption or signing

ForceAuthentication once enabled, requests to force re-authentication even if user session is active.

AuthenticationContext requests that the SAML provider uses a specific authentication context

SPEntityID overrides default Entity ID for the Service Provider

MaximumSessionLifetime is number of seconds, which defines how long the session is valid

KeystorePath is path to keystore file

KeyAlias is alias used in the -alias argument of keytool command

KeystorePasswordSecretKeySelector is selector for keystore password secret provided in -storepass argument

PrivateKeyPasswordSecretKeySelector is selector for private key password secret provided in -keypass argument

AuthRequestSignature enables signature of the Auth Request. If you enable it, the encryption and signing key will be available in the SP metadata file and URL

The name of the secret in the pod’s namespace to select from.

The key of the secret to select from. Must be a valid secret key.

Http is Jenkins web UI service

Agent is Jenkins agent service

The web hook URL to Slack App

Name of tool

Home defines where the tool is located

Push indicates that Jenkins seed job is executed on every detected push to corresponding Git repository

BitbucketTrigger is used for Bitbucket web hooks

GitHubTrigger is used for GitHub web hooks

BuildPeriodically is used for scheduled timer trigger

PollSCM is setting for polling changes in SCM

Username is name of the user

PasswordSecretKeySelector is selector for user’s password secret