Schema

Packages:

operator-service.com/v1beta1

Package v1beta1 contains API Schema definitions for the operator-service.com v1beta1 API group

Resource Types:

    AgentAvailability (string alias)

    AgentAvailability defines when the agent is started and stopped

    AgentLaunchMethod (string alias)

    (Appears on: AgentProperties)

    AgentLaunchMethod indicates how agent is being started

    AgentProperties

    (Appears on: JenkinsKubernetesAgentSpec)

    AgentProperties defines the properties for Jenkins node agent

    FieldDescription
    description
    string

    Description of Jenkins Agent

    executors
    int

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

    remoteRootDirectory
    string

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

    usage
    AgentUsage

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

    launchMethod
    AgentLaunchMethod

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

    disableWorkDir
    bool

    DisableWorkDir allows disabling Remoting Work Directory for the agent.

    customWorkDirPath
    string

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

    internalDataDirectory
    string

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

    failIfWorkplaceIsMissing
    bool

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

    useWebSocket
    bool

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

    tunnelConnectionThrough
    string

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

    jvmOptions
    string

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

    availability
    string

    Availability controls when Jenkins starts and stops this agent.

    toolLocations
    []ToolLocation

    ToolLocations is list of tools location

    AgentReference

    (Appears on: JenkinsSeedJobSpec)

    AgentReference represents a Jenkins Kubernetes Agent Reference. It has enough information to retrieve agent in any namespace

    FieldDescription
    name
    string

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

    namespace
    string

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

    AgentUsage (string alias)

    (Appears on: AgentProperties)

    AgentUsage indicates how builds are being scheduled on this node

    AmazonS3Provider

    (Appears on: BackupStorageProviders)

    AmazonS3Provider is storage provider for Amazon Web Services cloud

    AuthenticationConfigType (string alias)

    (Appears on: JenkinsAuthenticationSpec)

    AuthenticationConfigType indicates which authentication provider is set

    AuthorizationConfigType (string alias)

    (Appears on: JenkinsAuthorizationSpec)

    AuthorizationConfigType indicates which authentication provider is set

    AuthorizationStrategy (string alias)

    (Appears on: JenkinsSpec)

    AuthorizationStrategy defines authorization strategy of the operator for the Jenkins API

    AzureFilesProvider

    (Appears on: BackupStorageProviders)

    AzureFilesProvider is Microsoft Azure storage provider

    FieldDescription
    connectionStringSecretKeySelector
    SecretKeySelector

    ConnectionStringSecretKeySelector is selector for Azure Storage Account connection string secret

    BackupData

    (Appears on: JenkinsBackupConfigSpec)

    BackupData configures which data will be included in backup

    FieldDescription
    jobs
    bool

    Jobs backup enable/disable toggle

    artifacts
    bool

    Artifacts backup enable/disable toggle

    buildHistory
    bool

    Artifacts backup enable/disable toggle

    BackupStorageProviders

    BackupStorageProviders contains the major cloud providers configuration

    FieldDescription
    persistentVolumeClaim
    PersistentVolumeClaimProvider

    PersistentVolumeClaim is default vanilla Kubernetes storage provider

    azureFiles
    AzureFilesProvider

    AzureFiles is Microsoft Azure storage provider

    amazonS3
    AmazonS3Provider

    AmazonS3 is storage provider for Amazon Web Services cloud

    gcpStorage
    GoogleCloudStorageProvider

    GoogleCloudStorage is storage provider used in Google Cloud Platform

    BackupTrigger

    (Appears on: JenkinsBackupConfigSpec)

    BackupTrigger defines the conditions when the backup is being created

    FieldDescription
    cronSchedule
    string

    CronSchedule is cron format schedule

    BuildSettings

    (Appears on: JenkinsSeedJobSpec)

    BuildSettings configures the job build options

    FieldDescription
    ignoreMissingFiles
    bool
    (Optional)

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

    additionalClasspath
    string
    (Optional)

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

    failOnMissingPlugin
    bool
    (Optional)

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

    unstableOnDeprecation
    bool
    (Optional)

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

    ConditionReason (string alias)

    ConditionReason is the reason for the condition’s last transition

    ConditionType (string alias)

    (Appears on: ResourceCondition)

    ConditionType is the type of the condition.

    CredentialType (string alias)

    (Appears on: Repository)

    CredentialType defines type of Jenkins credential used to seed job mechanism.

    GitHubOAuthAuthenticationConfig

    (Appears on: JenkinsAuthenticationSpec)

    FieldDescription
    webUri
    string
    apiUri
    string
    clientID
    string
    clientSecretKeySelector
    SecretKeySelector
    scopes
    []string
    mfaEnabled
    bool

    GoogleCloudStorageProvider

    (Appears on: BackupStorageProviders)

    GoogleCloudStorageProvider is storage provider for Amazon Web Services cloud

    Jenkins

    Jenkins is the Schema for the jenkins API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsSpec


    annotations
    map[string]string
    (Optional)

    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

    labels
    map[string]string
    (Optional)

    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
    Kubernetes core/v1.PodSpec
    (Optional)

    PodSpec allows to set Jenkins Kubernetes specific pod properties

    pvcSettings
    PVCOptions
    (Optional)

    HomePVC allows to set PersistentVolumeClaim properties for Jenkins home

    roles
    []Kubernetes rbac/v1.RoleRef
    (Optional)

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

    plugins
    []Plugin
    (Optional)

    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
    PVCOptions
    (Optional)

    PluginsCache allows to set plugins cache specific pvc properties

    services
    Services
    (Optional)

    Services allows to configure Jenkins services

    disableCSRFProtection
    bool

    DisableCSRFProtection allows you to toggle CSRF Protection on Jenkins

    authorizationStrategy
    AuthorizationStrategy
    status
    JenkinsStatus

    JenkinsAuthentication

    JenkinsAuthentication is the Schema for the JenkinsAuthentications API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsAuthenticationSpec


    type
    AuthenticationConfigType

    Type indicates which authentication provider is set

    github
    GitHubOAuthAuthenticationConfig
    (Optional)

    GitHub is configuration for GitHub OAuth provider

    saml
    SAMLConfig
    (Optional)

    SAML is configuration for enterprise authentication providers like OneLogin or Okta

    userPassword
    UserPasswordConfig

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

    status
    JenkinsAuthenticationStatus

    JenkinsAuthenticationSpec

    (Appears on: JenkinsAuthentication)

    JenkinsAuthenticationSpec defines the desired state of JenkinsAuthentication. It’s used only for authentication purposes, to check if user with provided credentials exists. For granular access properties, look at JenkinsAuthorization CRD

    FieldDescription
    type
    AuthenticationConfigType

    Type indicates which authentication provider is set

    github
    GitHubOAuthAuthenticationConfig
    (Optional)

    GitHub is configuration for GitHub OAuth provider

    saml
    SAMLConfig
    (Optional)

    SAML is configuration for enterprise authentication providers like OneLogin or Okta

    userPassword
    UserPasswordConfig

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

    JenkinsAuthenticationStatus

    (Appears on: JenkinsAuthentication)

    JenkinsAuthenticationStatus defines the observed state of JenkinsAuthentication

    FieldDescription
    conditions
    []ResourceCondition

    Conditions contains JenkinsAuthentication statuses

    JenkinsAuthorization

    JenkinsAuthorization is the Schema for the JenkinsAuthorization API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsAuthorizationSpec


    type
    AuthorizationConfigType

    Type indicates which authorization provider is set

    matrix
    MatrixConfig

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

    status
    JenkinsAuthorizationStatus

    JenkinsAuthorizationSpec

    (Appears on: JenkinsAuthorization)

    JenkinsAuthorizationSpec defines the desired state of JenkinsAuthorization. It configures the granular access for users.

    FieldDescription
    type
    AuthorizationConfigType

    Type indicates which authorization provider is set

    matrix
    MatrixConfig

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

    JenkinsAuthorizationStatus

    (Appears on: JenkinsAuthorization)

    JenkinsAuthorizationStatus defines the observed state of JenkinsAuthorization

    FieldDescription
    conditions
    []ResourceCondition

    Conditions contains JenkinsAuthorization statuses

    JenkinsBackupConfig

    JenkinsBackupConfig is the Schema for the jenkinsbackupconfigs API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsBackupConfigSpec


    retention
    int

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

    data
    BackupData

    Data configures which data will be included in backup

    trigger
    BackupTrigger

    Trigger defines the conditions when the backup is being created

    status
    JenkinsBackupConfigStatus

    JenkinsBackupConfigSpec

    (Appears on: JenkinsBackupConfig)

    JenkinsBackupConfigSpec defines the desired state of JenkinsBackupConfig. Using this CRD, the backup retention, data, trigger and providers can be set.

    FieldDescription
    retention
    int

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

    data
    BackupData

    Data configures which data will be included in backup

    trigger
    BackupTrigger

    Trigger defines the conditions when the backup is being created

    JenkinsBackupConfigStatus

    (Appears on: JenkinsBackupConfig)

    JenkinsBackupConfigStatus defines the observed state of JenkinsBackupConfig

    FieldDescription
    operatorVersion
    string
    (Optional)

    OperatorVersion is the operator version which manages this CR

    conditions
    []ResourceCondition

    Conditions contains JenkinsBackupConfig statuses

    JenkinsConfigurationAsCode

    JenkinsConfigurationAsCode is the Schema for the jenkinsconfigurationascodes API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsConfigurationAsCodeSpec


    data
    string

    Data is inline configuration as code script

    secretRef
    Kubernetes core/v1.SecretReference

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

    status
    JenkinsConfigurationAsCodeStatus

    JenkinsConfigurationAsCodeSpec

    (Appears on: JenkinsConfigurationAsCode)

    JenkinsConfigurationAsCodeSpec defines the desired state of JenkinsConfigurationAsCode. It allows to write CASC to modify the Jenkins.

    FieldDescription
    data
    string

    Data is inline configuration as code script

    secretRef
    Kubernetes core/v1.SecretReference

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

    JenkinsConfigurationAsCodeStatus

    (Appears on: JenkinsConfigurationAsCode)

    JenkinsConfigurationAsCodeStatus defines the observed state of JenkinsConfigurationAsCode

    FieldDescription
    conditions
    []ResourceCondition

    Conditions contains JenkinsConfigurationAsCode statuses

    hash
    string

    Hash contains hash computed when running this CASC code

    JenkinsGroovyScript

    JenkinsGroovyScript is the Schema for the jenkinsgroovyscripts API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsGroovyScriptSpec


    data
    string

    Data is inline Groovy script

    secretRef
    Kubernetes core/v1.SecretReference

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

    dependsOn
    JenkinsGroovyScriptRef

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

    status
    JenkinsGroovyScriptStatus

    JenkinsGroovyScriptRef

    (Appears on: JenkinsGroovyScriptSpec)

    JenkinsGroovyScriptRef defines dependency with another JenkinsGroovyScript

    FieldDescription
    name
    string

    Name of the script being referenced

    namespace
    string

    Namespace of referenced JenkinsGroovyScript

    JenkinsGroovyScriptSpec

    (Appears on: JenkinsGroovyScript)

    JenkinsGroovyScriptSpec defines the desired state of JenkinsGroovyScript. It allows to write Groovy Scripts to modify the Jenkins.

    FieldDescription
    data
    string

    Data is inline Groovy script

    secretRef
    Kubernetes core/v1.SecretReference

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

    dependsOn
    JenkinsGroovyScriptRef

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

    JenkinsGroovyScriptStatus

    (Appears on: JenkinsGroovyScript)

    JenkinsGroovyScriptStatus defines the observed state of JenkinsGroovyScript

    FieldDescription
    operatorVersion
    string
    (Optional)

    OperatorVersion is the operator version which manages this CR

    conditions
    []ResourceCondition

    Conditions contains JenkinsAuthentication statuses

    hash
    string

    Hash contains hash computed when running this script

    JenkinsKubernetesAgent

    JenkinsKubernetesAgent is the Schema for the JenkinsKubernetesAgents API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsKubernetesAgentSpec


    annotations
    map[string]string
    (Optional)

    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

    labels
    map[string]string
    (Optional)

    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
    AgentProperties

    Properties configures the Jenkins agent

    podSpec
    Kubernetes core/v1.PodSpec
    (Optional)

    PodSpec allows to set Jenkins Kubernetes Agent specific pod properties

    roles
    []Kubernetes rbac/v1.RoleRef
    (Optional)

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

    status
    JenkinsKubernetesAgentStatus

    JenkinsKubernetesAgentSpec

    (Appears on: JenkinsKubernetesAgent)

    JenkinsKubernetesAgentSpec defines the desired state of Jenkins Agent. It’s used as remote agent, running in separate pod, which connects to Jenkins master.

    FieldDescription
    annotations
    map[string]string
    (Optional)

    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

    labels
    map[string]string
    (Optional)

    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
    AgentProperties

    Properties configures the Jenkins agent

    podSpec
    Kubernetes core/v1.PodSpec
    (Optional)

    PodSpec allows to set Jenkins Kubernetes Agent specific pod properties

    roles
    []Kubernetes rbac/v1.RoleRef
    (Optional)

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

    JenkinsKubernetesAgentStatus

    (Appears on: JenkinsKubernetesAgent)

    JenkinsKubernetesAgentStatus defines the observed state of JenkinsKubernetesAgent

    FieldDescription
    provisionStartTime
    Kubernetes meta/v1.Time
    (Optional)

    ProvisionStartTime is a time when Jenkins agent pod has been created

    conditions
    []ResourceCondition

    Conditions contains JenkinsKubernetesAgent statuses

    JenkinsNotification

    JenkinsNotification is a service configuration used to send notifications about Jenkins configuration status. Docs: https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/notifications/

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsNotificationSpec


    level
    NotificationLevel
    verbose
    bool
    name
    string
    slack
    Slack
    teams
    MicrosoftTeams
    mailgun
    Mailgun
    smtp
    SMTP
    status
    JenkinsNotificationStatus

    JenkinsNotificationSpec

    (Appears on: JenkinsNotification)

    JenkinsNotificationSpec is a service configuration used to send notifications about Jenkins configuration status. Docs: https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/notifications/

    FieldDescription
    level
    NotificationLevel
    verbose
    bool
    name
    string
    slack
    Slack
    teams
    MicrosoftTeams
    mailgun
    Mailgun
    smtp
    SMTP

    JenkinsNotificationStatus

    (Appears on: JenkinsNotification)

    JenkinsNotificationStatus defines the observed state of JenkinsNotification

    FieldDescription
    operatorVersion
    string
    (Optional)

    OperatorVersion is the operator version which manages this CR

    conditions
    []ResourceCondition

    Conditions contains JenkinsNotification statuses

    JenkinsSeedJob

    JenkinsSeedJob is the Schema for the jenkinsseedjobs API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    JenkinsSeedJobSpec


    description
    string
    (Optional)

    Description is the description of the seed job

    repository
    Repository

    Repository is the place where seed job definitions are defined

    triggers
    Triggers
    (Optional)

    Triggers are used for Git servers web hooks

    agentRef
    AgentReference
    (Optional)

    AgentRef is reference to agent

    settings
    BuildSettings
    (Optional)

    Settings configures the Git specific properties

    status
    JenkinsSeedJobStatus

    JenkinsSeedJobSpec

    (Appears on: JenkinsSeedJob)

    JenkinsSeedJobSpec defines the desired state of JenkinsSeedJob. It allows to create Seed Jobs which are executed on Jenkins startup.

    FieldDescription
    description
    string
    (Optional)

    Description is the description of the seed job

    repository
    Repository

    Repository is the place where seed job definitions are defined

    triggers
    Triggers
    (Optional)

    Triggers are used for Git servers web hooks

    agentRef
    AgentReference
    (Optional)

    AgentRef is reference to agent

    settings
    BuildSettings
    (Optional)

    Settings configures the Git specific properties

    JenkinsSeedJobStatus

    (Appears on: JenkinsSeedJob)

    JenkinsSeedJobStatus defines the observed state of JenkinsSeedJob

    FieldDescription
    operatorVersion
    string
    (Optional)

    OperatorVersion is the operator version which manages this CR

    conditions
    []ResourceCondition

    Conditions contains JenkinsSeedJob statuses

    hash
    string

    Hash contains hash computed when running this script

    JenkinsSpec

    (Appears on: Jenkins)

    JenkinsSpec defines the desired state of Jenkins. It’s used for Jenkins master and Kubernetes pod configuration

    FieldDescription
    annotations
    map[string]string
    (Optional)

    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

    labels
    map[string]string
    (Optional)

    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
    Kubernetes core/v1.PodSpec
    (Optional)

    PodSpec allows to set Jenkins Kubernetes specific pod properties

    pvcSettings
    PVCOptions
    (Optional)

    HomePVC allows to set PersistentVolumeClaim properties for Jenkins home

    roles
    []Kubernetes rbac/v1.RoleRef
    (Optional)

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

    plugins
    []Plugin
    (Optional)

    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
    PVCOptions
    (Optional)

    PluginsCache allows to set plugins cache specific pvc properties

    services
    Services
    (Optional)

    Services allows to configure Jenkins services

    disableCSRFProtection
    bool

    DisableCSRFProtection allows you to toggle CSRF Protection on Jenkins

    authorizationStrategy
    AuthorizationStrategy

    JenkinsStatus

    (Appears on: Jenkins)

    JenkinsStatus defines the observed state of Jenkins

    FieldDescription
    operatorVersion
    string
    (Optional)

    OperatorVersion is the operator version which manages this CR

    provisionStartTime
    Kubernetes meta/v1.Time
    (Optional)

    ProvisionStartTime is a time when Jenkins master pod has been created

    baseGroovyScriptsAppliedTime
    Kubernetes meta/v1.Time
    (Optional)

    BaseGroovyScriptsAppliedTime is a time when base groovy scripts were applied

    conditions
    []ResourceCondition

    Conditions contains Jenkins statuses

    Mailgun

    (Appears on: JenkinsNotificationSpec)

    Mailgun is handler for Mailgun email service notification channel.

    FieldDescription
    domain
    string
    apiKeySecretKeySelector
    SecretKeySelector
    recipient
    string
    from
    string

    MatrixConfig

    (Appears on: JenkinsAuthorizationSpec)

    FieldDescription
    administrators
    []string

    Administrators is list of the users with administrative permissions

    MicrosoftTeams

    (Appears on: JenkinsNotificationSpec)

    MicrosoftTeams is handler for Microsoft MicrosoftTeams notification channel.

    FieldDescription
    webHookURLSecretKeySelector
    SecretKeySelector

    The web hook URL to MicrosoftTeams App

    NotificationLevel (string alias)

    (Appears on: JenkinsNotificationSpec)

    NotificationLevel defines the level of a Notification.

    PVCOptions

    (Appears on: JenkinsSpec)

    FieldDescription
    accessMode
    Kubernetes core/v1.PersistentVolumeAccessMode

    AccessMode specifies the way the plugins cache can be mounted

    resourceStorage
    string

    ResourceStorage is the plugins cache volume size

    storageClassName
    string

    StorageClassName is the name of the StorageClass required by the claim

    PersistentVolumeClaimProvider

    (Appears on: BackupStorageProviders)

    PersistentVolumeClaimProvider is default vanilla Kubernetes storage provider

    FieldDescription
    claimName
    string

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

    Plugin

    (Appears on: JenkinsSpec)

    FieldDescription
    name
    string

    Name is the name of Jenkins plugin

    version
    string

    Version is the version of Jenkins plugin

    downloadURL
    string

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

    Repository

    (Appears on: JenkinsSeedJobSpec)

    Repository is VCS repository settings

    FieldDescription
    branch
    string

    Branch is the repository branch where seed job definitions are stored

    url
    string

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

    targets
    string

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

    credentialID
    string

    CredentialID is the Kubernetes secret name which stores repository access credentials

    credentialType
    CredentialType
    (Optional)

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

    ResourceCondition

    (Appears on: JenkinsAuthenticationStatus, JenkinsAuthorizationStatus, JenkinsBackupConfigStatus, JenkinsConfigurationAsCodeStatus, JenkinsGroovyScriptStatus, JenkinsKubernetesAgentStatus, JenkinsNotificationStatus, JenkinsSeedJobStatus, JenkinsStatus)

    FieldDescription
    type
    ConditionType

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

    status
    Kubernetes core/v1.ConditionStatus

    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

    lastProbeTime
    Kubernetes meta/v1.Time
    (Optional)

    Last time we probed the condition.

    lastTransitionTime
    Kubernetes meta/v1.Time
    (Optional)

    Last time the condition transitioned from one status to another.

    reason
    string
    (Optional)

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

    message
    string
    (Optional)

    Human-readable message indicating details about last transition.

    SAMLConfig

    (Appears on: JenkinsAuthenticationSpec)

    SAMLConfig is configuration of enterprise auth protocol. Configuration docs: https://github.com/jenkinsci/saml-plugin/blob/master/doc/CONFIGURE.md

    FieldDescription
    idpMetadata
    string

    IdPMetadata is identity provider metadata file content.

    idpMetadataURL
    string

    IdPMetadataURL is identity provider metadata file source URL.

    refreshPeriod
    int

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

    displayNameAttribute
    string

    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
    string

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

    maximumAuthenticationLifetime
    int

    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
    string

    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
    string

    EmailAttribute is email attribute in SAML response

    usernameCaseConvention
    UsernameCaseConvention

    UsernameCaseConvention defines the convention for converting usernames

    dataBindingMethod
    SAMLDataBindingMethod

    DataBindingMethod defines redirection method binding

    logoutURL
    string

    LogoutURL is logout URL where user will be redirected once logout

    advanced
    SAMLConfigAdvanced

    Advanced contains additional mechanisms for SAML login

    encryption
    SAMLConfigAdvancedEncryption

    Encryption contains additional configuration for setting up encryption or signing

    SAMLConfigAdvanced

    (Appears on: SAMLConfig)

    SAMLConfigAdvanced contains additional mechanisms for SAML login

    FieldDescription
    forceAuthentication
    bool

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

    authenticationContext
    string

    AuthenticationContext requests that the SAML provider uses a specific authentication context

    spEntityID
    string

    SPEntityID overrides default Entity ID for the Service Provider

    maximumSessionLifetime
    int

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

    SAMLConfigAdvancedEncryption

    (Appears on: SAMLConfig)

    SAMLConfigAdvancedEncryption contains additional configuration for setting up encryption or signing

    FieldDescription
    keystorePath
    string

    KeystorePath is path to keystore file

    keyAlias
    string

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

    keystorePasswordSecretKeySelector
    SecretKeySelector

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

    privateKeyPasswordSecretKeySelector
    SecretKeySelector

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

    authRequestSignature
    bool

    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

    SAMLDataBindingMethod (string alias)

    (Appears on: SAMLConfig)

    SAMLDataBindingMethod indicates the redirection types for identity provider

    SMTP

    (Appears on: JenkinsNotificationSpec)

    SMTP is handler for sending emails via this protocol.

    FieldDescription
    usernameSecretKeySelector
    SecretKeySelector
    passwordSecretKeySelector
    SecretKeySelector
    port
    int
    server
    string
    tlsInsecureSkipVerify
    bool
    from
    string
    to
    string

    SecretKeySelector

    (Appears on: AzureFilesProvider, GitHubOAuthAuthenticationConfig, Mailgun, MicrosoftTeams, SAMLConfigAdvancedEncryption, SMTP, Slack, UserPasswordConfig)

    SecretKeySelector selects a key of a Secret.

    FieldDescription
    secret
    Kubernetes core/v1.LocalObjectReference

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

    key
    string

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

    Services

    (Appears on: JenkinsSpec)

    FieldDescription
    http
    Kubernetes core/v1.Service

    Http is Jenkins web UI service

    agent
    Kubernetes core/v1.Service

    Agent is Jenkins agent service

    Slack

    (Appears on: JenkinsNotificationSpec)

    Slack is handler for Slack notification channel.

    FieldDescription
    webHookURLSecretKeySelector
    SecretKeySelector

    The web hook URL to Slack App

    ToolLocation

    (Appears on: AgentProperties)

    ToolLocation defines the location of development tools

    FieldDescription
    home
    string

    Name of tool

    name
    string

    Home defines where the tool is located

    Trigger

    (Appears on: Triggers)

    Trigger defines in which conditions the Jenkins seed job will be executed

    FieldDescription
    push
    bool

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

    Triggers

    (Appears on: JenkinsSeedJobSpec)

    Triggers define circumstances that execute jobs

    FieldDescription
    bitbucket
    Trigger
    (Optional)

    BitbucketTrigger is used for Bitbucket web hooks

    github
    Trigger
    (Optional)

    GitHubTrigger is used for GitHub web hooks

    buildPeriodically
    string
    (Optional)

    BuildPeriodically is used for scheduled timer trigger

    pollSCM
    string
    (Optional)

    PollSCM is setting for polling changes in SCM

    UserPasswordConfig

    (Appears on: JenkinsAuthenticationSpec)

    UserPasswordConfig is basic and default authentication provider

    FieldDescription
    username
    string

    Username is name of the user

    passwordSecretKeySelector
    SecretKeySelector

    PasswordSecretKeySelector is selector for user’s password secret

    UsernameCaseConvention (string alias)

    (Appears on: SAMLConfig)

    UsernameCaseConvention defines the case convention for SAML usernames.


    Generated with gen-crd-api-reference-docs on git commit cdfeb0f.