API Documentation

Packages:

• jenkins.io/v1

jenkins.io/v1

Package v1 is the v1 version of the API.

Resource Types:

• App
• BuildPack
• CommitStatus
• Environment
• EnvironmentRoleBinding
• Extension
• Fact
• GitService
• PipelineActivity
• PipelineStructure
• Plugin
• Release
• Scheduler
• SourceRepository
• SourceRepositoryGroup
• Team
• User
• Workflow

App

App is the metadata for an App

Field	Description
apiVersion string	jenkins.io/v1
kind string	App
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec AppSpec	schemaPreprocessor Kubernetes core/v1.Container schemaPreprocessorRole Kubernetes rbac/v1.Role pipelineExtension PipelineExtension

BuildPack

BuildPack represents a set of language specific build packs and associated quickstarts

Field	Description
apiVersion string	jenkins.io/v1
kind string	BuildPack
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BuildPackSpec	label string gitUrl string gitRef string quickstartLocations []QuickStartLocation

CommitStatus

CommitStatus represents the commit statuses for a particular pull request

Field	Description
apiVersion string	jenkins.io/v1
kind string	CommitStatus
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec CommitStatusSpec	items []CommitStatusDetails

Environment

Environment represents an environment like Dev, Test, Staging, Production where code lives

Field	Description
apiVersion string	jenkins.io/v1
kind string	Environment
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EnvironmentSpec	label string namespace string cluster string promotionStrategy PromotionStrategyType source EnvironmentRepository order int32 kind EnvironmentKindType pullRequestURL string teamSettings TeamSettings previewGitInfo PreviewGitSpec webHookEngine WebHookEngineType remoteCluster bool RemoteCluster flag indicates if the Environment is deployed in a separate cluster to the Development Environment
status EnvironmentStatus

EnvironmentRoleBinding

EnvironmentRoleBinding is like a vanilla RoleBinding but applies to a set of Namespaces based on an Environment filter so that roles can be bound to multiple namespaces easily.

For example to specify the binding of roles on all Preview environments or on all permanent environments.

Field	Description
apiVersion string	jenkins.io/v1
kind string	EnvironmentRoleBinding
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EnvironmentRoleBindingSpec	subjects []Kubernetes rbac/v1.Subject Subjects holds references to the objects the role applies to. roleRef Kubernetes rbac/v1.RoleRef RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. environments []EnvironmentFilter specifies which sets of environments this binding applies to
status EnvironmentRoleBindingStatus

Extension

Extension represents an extension available to this Jenkins X install

Field	Description
apiVersion string	jenkins.io/v1
kind string	Extension
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ExtensionSpec	name string description string version string script string when []ExtensionWhen given ExtensionGiven parameters []ExtensionParameter namespace string uuid string children []string

Fact

Fact represents observed facts. Apps will generate Facts about the system. A naming schema is required since each Fact has a name that’s unique for the whole system. Apps should prefix their generated Facts with the name of the App, like -. This makes that different Apps can’t possibly have conflicting Fact names.

For an app generating facts on a pipeline, which will be have several different executions, we recommend --.

Field	Description
apiVersion string	jenkins.io/v1
kind string	Fact
metadata Kubernetes meta/v1.ObjectMeta	(Optional) The Fact labels will be used to query the API for interesting Facts. The Apps responsible for creating Facts need to add the relevant labels. For example, creating Facts on a pipeline would create Facts with the following labels { subjectkind: PipelineActivity pipelineName: my-org-my-app-master-23 org: my-org repo: my-app branch: master buildNumber: 23 } Refer to the Kubernetes API documentation for the fields of the metadata field.
spec FactSpec	name string factType string measurements []Measurement statements []Statement (Optional) original Original (Optional) tags []string (Optional) subject ResourceReference
status FactStatus

GitService

GitService represents a git provider so we can map the host name to a kinda of git service

Field	Description
apiVersion string	jenkins.io/v1
kind string	GitService
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec GitServiceSpec	gitKind string url string name string

PipelineActivity

PipelineActivity represents pipeline activity for a particular run of a pipeline

Field	Description
apiVersion string	jenkins.io/v1
kind string	PipelineActivity
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineActivitySpec	pipeline string build string version string status ActivityStatusType startedTimestamp Kubernetes meta/v1.Time completedTimestamp Kubernetes meta/v1.Time steps []PipelineActivityStep buildUrl string buildLogsUrl string gitUrl string gitRepository string gitOwner string gitBranch string author string authorAvatarURL string authorURL string pullTitle string releaseNotesURL string lastCommitSHA string lastCommitMessage string lastCommitURL string workflow string Deprecated - Workflow functionality was removed and is obsolete Keeping these fields to ensure backwards compatibility Should be removed when we increment spec version workflowStatus ActivityStatusType workflowMessage string postExtensions []ExtensionExecution attachments []Attachment batchPipelineActivity BatchPipelineActivity context string baseSHA string
status PipelineActivityStatus

PipelineStructure

PipelineStructure contains references to the Pipeline and PipelineRun, and a list of PipelineStructureStages in the pipeline. This allows us to map between a running Pod to its TaskRun, to the TaskRun’s Task and PipelineRun, and finally from there to the stage and potential parent stages that the Pod is actually executing, for use with populating PipelineActivity and providing logs.

Field	Description
apiVersion string	jenkins.io/v1
kind string	PipelineStructure
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
pipelineRef string
pipelineRunRef string
stages []PipelineStructureStage

Plugin

Plugin represents a binary plugin installed into this Jenkins X team

Field	Description
apiVersion string	jenkins.io/v1
kind string	Plugin
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PluginSpec	subCommand string group string binaries []Binary description string name string version string

Release

Release represents a single version of an app that has been released

Field	Description
apiVersion string	jenkins.io/v1
kind string	Release
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ReleaseSpec	name string version string gitHttpUrl string gitCloneUrl string commits []CommitSummary issues []IssueSummary pullRequests []IssueSummary dependencyUpdates []DependencyUpdate releaseNotesURL string gitRepository string gitOwner string
status ReleaseStatus

Scheduler

Scheduler is configuration for a pipeline scheduler

Field	Description
apiVersion string	jenkins.io/v1
kind string	Scheduler
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SchedulerSpec	schedulerAgent SchedulerAgent policy GlobalProtectionPolicy presubmits Presubmits postsubmits Postsubmits trigger Trigger approve Approve lgtm Lgtm externalPlugins ReplaceableSliceOfExternalPlugins merger Merger plugins ReplaceableSliceOfStrings Plugins is a list of plugin names enabled for a repo configUpdater ConfigUpdater welcome []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Welcome periodics Periodics attachments []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Attachment

SourceRepository

SourceRepository is the metadata for an Application/Project/SourceRepository

Field	Description
apiVersion string	jenkins.io/v1
kind string	SourceRepository
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SourceRepositorySpec	description string provider string Provider stores the URL of the git provider such as https://github.com org string repo string providerName string ProviderName is a logical name for the provider without any URL scheme which can be used in a label selector providerKind string ProviderKind is the kind of provider (github / bitbucketcloud / bitbucketserver etc) url string URL is the web URL of the project page sshCloneURL string SSHCloneURL is the git URL to clone this repository using SSH httpCloneURL string HTTPCloneURL is the git URL to clone this repository using HTTP/HTTPS scheduler ResourceReference Scheduler a reference to a custom scheduler otherwise we default to the Team’s Scededuler

SourceRepositoryGroup

SourceRepositoryGroup is the metadata for an Application/Project/SourceRepository

Field	Description
apiVersion string	jenkins.io/v1
kind string	SourceRepositoryGroup
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SourceRepositoryGroupSpec	metadata Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field. repositories []ResourceReference scheduler ResourceReference

Team

Team represents a request to create an actual Team which is a group of users, a development environment and optional other environments

Field	Description
apiVersion string	jenkins.io/v1
kind string	Team
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TeamSpec	label string kind TeamKindType members []string
status TeamStatus

User

User represents a git user so we have a cache to find by email address

Field	Description
apiVersion string	jenkins.io/v1
kind string	User
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
user UserDetails	Deprecated, use Spec
spec UserDetails	login string name string email string creationTimestamp Kubernetes meta/v1.Time url string avatarUrl string serviceAccount string accountReference []AccountReference externalUser bool

Workflow

Workflow represents pipeline activity for a particular run of a pipeline

Field	Description
apiVersion string	jenkins.io/v1
kind string	Workflow
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
spec WorkflowSpec	pipeline string steps []WorkflowStep
status WorkflowStatus

AccountReference

(Appears on: UserDetails)

AccountReference is a reference to a user account in another system that is attached to this user

Field	Description
provider string
id string

ActivityStatusType (string alias)

(Appears on: CoreActivityStep, PipelineActivitySpec)

ActivityStatusType is the status of an activity; usually succeeded or failed/error on completion

ActivityStepKindType (string alias)

(Appears on: PipelineActivityStep)

ActivityStepKindType is a kind of step

AppSpec

(Appears on: App)

AppSpec provides details of the metadata for an App

Field	Description
schemaPreprocessor Kubernetes core/v1.Container
schemaPreprocessorRole Kubernetes rbac/v1.Role
pipelineExtension PipelineExtension

Approve

(Appears on: SchedulerSpec)

Approve specifies a configuration for a single approve.

The configuration for the approve plugin is defined as a list of these structures.

Field	Description
issueRequired bool	IssueRequired indicates if an associated issue is required for approval in the specified repos.
requireSelfApproval bool	RequireSelfApproval requires PR authors to explicitly approve their PRs. Otherwise the plugin assumes the author of the PR approves the changes in the PR.
lgtmActsAsApprove bool	LgtmActsAsApprove indicates that the lgtm command should be used to indicate approval
ignoreReviewState bool	IgnoreReviewState causes the approve plugin to ignore the GitHub review state. Otherwise: * an APPROVE github review is equivalent to leaving an “/approve” message. * A REQUEST_CHANGES github review is equivalent to leaving an /approve cancel” message.

Attachment

(Appears on: PipelineActivitySpec)

Field	Description
name string
urls []string

BatchPipelineActivity

(Appears on: PipelineActivitySpec)

BatchPipelineActivity contains information about a batch build, used by both the batch build and its comprising PRs for linking them together

Field	Description
batchBuildNumber string
batchBranchName string
pullRequestInfo []PullRequestInfo

Binary

(Appears on: PluginSpec)

Binary provies the details of a downloadable binary

Field	Description
goarch string
goos string
url string

BranchProtectionContextPolicy

(Appears on: ProtectionPolicy)

BranchProtectionContextPolicy configures required git provider contexts. Strict determines whether merging to the branch invalidates existing contexts.

Field	Description
contexts ReplaceableSliceOfStrings	Contexts appends required contexts that must be green to merge
strict bool	Strict overrides whether new commits in the base branch require updating the PR if set

Brancher

(Appears on: Postsubmit, Presubmit)

Brancher is for shared code between jobs that only run against certain branches. An empty brancher runs against all branches.

Field	Description
skipBranches ReplaceableSliceOfStrings	Do not run against these branches. Default is no branches.
branches ReplaceableSliceOfStrings	Only run against these branches. Default is all branches.

BuildPackSpec

(Appears on: BuildPack)

BuildPackSpec is the specification of an BuildPack

Field	Description
label string
gitUrl string
gitRef string
quickstartLocations []QuickStartLocation

ChartRef

(Appears on: ExtensionRepositoryReference)

Field	Description
repo string
repoName string
name string

CommitStatusCommitReference

(Appears on: CommitStatusDetails)

Field	Description
gitUrl string
pullRequest string
sha string

CommitStatusDetails

(Appears on: CommitStatusSpec)

Field	Description
pipelineActivity ResourceReference
Items []CommitStatusItem
checked bool
commit CommitStatusCommitReference
context string

CommitStatusItem

(Appears on: CommitStatusDetails)

Field	Description
name string
description string
pass bool

CommitStatusSpec

(Appears on: CommitStatus)

CommitStatusSpec provides details of a particular commit status

Field	Description
items []CommitStatusDetails

CommitSummary

(Appears on: ReleaseSpec)

CommitSummary is the summary of a commit

Field	Description
message string
sha string
url string
author UserDetails
committer UserDetails
branch string
issueIds []string

ConfigMapSpec

(Appears on: ConfigUpdater)

ConfigMapSpec contains configuration options for the configMap being updated by the config-updater plugin.

Field	Description
name string	Name of ConfigMap
key string	Key is the key in the ConfigMap to update with the file contents. If no explicit key is given, the basename of the file will be used.
namespace string	Namespace in which the configMap needs to be deployed. If no namespace is specified it will be deployed to the ProwJobNamespace.
additional_namespaces []string	Namespaces in which the configMap needs to be deployed, in addition to the above namespace provided, or the default if it is not set.
- []string	Namespaces is the fully resolved list of Namespaces to deploy the ConfigMap in

ConfigUpdater

(Appears on: SchedulerSpec)

ConfigUpdater holds configuration for the config updater plugin

Field	Description
map map[string]github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.ConfigMapSpec
configFile string
pluginFile string
ConfigMap ConfigMapSpec	(Optional)

ContextPolicy

(Appears on: Merger, RepoContextPolicy)

ContextPolicy configures options about how to handle various contexts.

Field	Description
skipUnknownContexts bool	whether to consider unknown contexts optional (skip) or required.
requiredContexts ReplaceableSliceOfStrings
requiredIfPresentContexts ReplaceableSliceOfStrings
optionalContexts ReplaceableSliceOfStrings
fromBranchProtection bool	Infer required and optional jobs from Branch Protection configuration

CoreActivityStep

(Appears on: PreviewActivityStep, PromoteActivityStep, PromotePullRequestStep, PromoteUpdateStep, StageActivityStep)

CoreActivityStep is a base step included in Stages of a pipeline or other kinds of step

Field	Description
name string
description string
status ActivityStatusType
startedTimestamp Kubernetes meta/v1.Time
completedTimestamp Kubernetes meta/v1.Time

DependencyUpdate

(Appears on: ReleaseSpec)

DependencyUpdate describes an dependency update message from the commit log

Field	Description
DependencyUpdateDetails DependencyUpdateDetails	(Members of DependencyUpdateDetails are embedded into this type.)
paths []DependencyUpdatePath

DependencyUpdateDetails

(Appears on: DependencyUpdate)

DependencyUpdateDetails are the details of a dependency update

Field	Description
host string
owner string
repo string
component string
url string
fromVersion string
fromReleaseHTMLURL string
fromReleaseName string
toVersion string
toReleaseHTMLURL string
toReleaseName string

DependencyUpdatePath ([]github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.DependencyUpdateDetails alias)

(Appears on: DependencyUpdate)

DependencyUpdatePath is the path of a dependency update

DeployOptions

(Appears on: TeamSettings)

DeployOptions configures options for how to deploy applications by default such as using progressive delivery or using horizontal pod autoscaler

Field	Description
canary bool	Canary should we enable canary rollouts (progressive delivery) for apps by default
hpa bool	should we use the horizontal pod autoscaler on new apps by default?

EnvironmentFilter

(Appears on: EnvironmentRoleBindingSpec)

EnvironmentFilter specifies the environments to apply the role binding to

Field	Description
kind EnvironmentKindType
includes []string
excludes []string

EnvironmentKindType (string alias)

(Appears on: EnvironmentFilter, EnvironmentSpec)

EnvironmentKindType is the kind of an environment

EnvironmentRepository

(Appears on: EnvironmentSpec)

EnvironmentRepository is the repository for an environment using GitOps

Field	Description
kind EnvironmentRepositoryType
url string
ref string

EnvironmentRepositoryType (string alias)

(Appears on: EnvironmentRepository)

EnvironmentRepositoryType is the repository type

EnvironmentRoleBindingSpec

(Appears on: EnvironmentRoleBinding)

EnvironmentRoleBindingSpec is the specification of an EnvironmentRoleBinding

Field	Description
subjects []Kubernetes rbac/v1.Subject	Subjects holds references to the objects the role applies to.
roleRef Kubernetes rbac/v1.RoleRef	RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
environments []EnvironmentFilter	specifies which sets of environments this binding applies to

EnvironmentRoleBindingStatus

(Appears on: EnvironmentRoleBinding)

EnvironmentRoleBindingStatus is the status for an EnvironmentRoleBinding resource

Field	Description
version string

EnvironmentSpec

(Appears on: Environment)

EnvironmentSpec is the specification of an Environment

Field	Description
label string
namespace string
cluster string
promotionStrategy PromotionStrategyType
source EnvironmentRepository
order int32
kind EnvironmentKindType
pullRequestURL string
teamSettings TeamSettings
previewGitInfo PreviewGitSpec
webHookEngine WebHookEngineType
remoteCluster bool	RemoteCluster flag indicates if the Environment is deployed in a separate cluster to the Development Environment

EnvironmentStatus

(Appears on: Environment)

EnvironmentStatus is the status for an Environment resource

Field	Description
version string

EnvironmentVariable

(Appears on: ExtensionExecution)

Field	Description
name string
value string

ExtensionConfig

ExtensionConfig is the configuration and enablement for an extension inside an app

Field	Description
name string
namespace string
parameters []ExtensionParameterValue

ExtensionDefinition

ExtensionDefinition defines an Extension

Field	Description
name string
namespace string
uuid string
description string
when []ExtensionWhen
given ExtensionGiven
children []ExtensionDefinitionChildReference
scriptFile string
parameters []ExtensionParameter

ExtensionDefinitionChildReference

(Appears on: ExtensionDefinition)

ExtensionDefinitionChildReference provides a reference to a child

Field	Description
uuid string
name string
namespace string
remote string
tag string

ExtensionDefinitionReference

ExtensionRepositoryReference references a GitHub repo that contains extension definitions

Field	Description
remote string
tag string

ExtensionExecution

(Appears on: PipelineActivitySpec)

ExtensionExecution is an executable instance of an extension which can be attached into a pipeline for later execution. It differs from an Extension as it cannot have children and parameters have been resolved to environment variables

Field	Description
name string
description string
script string
environmentVariables []EnvironmentVariable
given ExtensionGiven
namespace string
uuid string

ExtensionGiven (string alias)

(Appears on: ExtensionDefinition, ExtensionExecution, ExtensionSpec)

ExtensionGiven specifies the condition (if the extension is executing in a pipeline on which the extension should execute. By default Always.

ExtensionParameter

(Appears on: ExtensionDefinition, ExtensionSpec)

ExtensionParameter describes a parameter definition for an extension

Field	Description
name string
description string
environmentVariableName string
defaultValue string

ExtensionParameterValue

(Appears on: ExtensionConfig)

Field	Description
name string
value string

ExtensionRepositoryReference

Field	Description
url string
github string
chart ChartRef

ExtensionSpec

(Appears on: Extension)

ExtensionSpec provides details of an extension available for a team

Field	Description
name string
description string
version string
script string
when []ExtensionWhen
given ExtensionGiven
parameters []ExtensionParameter
namespace string
uuid string
children []string

ExtensionWhen (string alias)

(Appears on: ExtensionDefinition, ExtensionSpec)

ExtensionWhen specifies when in the lifecycle an extension should execute. By default Post.

ExternalPlugin

ExternalPlugin holds configuration for registering an external plugin.

Field	Description
name string	Name of the plugin.
endpoint string	Endpoint is the location of the external plugin. Defaults to the name of the plugin, ie. “http://{{name}}”.
events ReplaceableSliceOfStrings	ReplaceableSliceOfStrings are the events that need to be demuxed by the hook server to the external plugin. If no events are specified, everything is sent.

FactSpec

(Appears on: Fact)

FactSpec is the specification of a Fact

Field	Description
name string
factType string
measurements []Measurement
statements []Statement	(Optional)
original Original	(Optional)
tags []string	(Optional)
subject ResourceReference

FactStatus

(Appears on: Fact)

FactStatus is the status for an Fact resource

Field	Description
version string

GitServiceSpec

(Appears on: GitService)

GitServiceSpec is the specification of an GitService

Field	Description
gitKind string
url string
name string

GitStatus

(Appears on: PromoteUpdateStep)

GitStatus the status of a git commit in terms of CI/CD

Field	Description
url string
status string

GlobalProtectionPolicy

(Appears on: SchedulerSpec)

GlobalProtectionPolicy defines the default branch protection policy for the scheduler

Field	Description
ProtectionPolicy ProtectionPolicy	(Optional)
protectTested bool

ImportModeType (string alias)

(Appears on: TeamSettings)

ImportModeType is the type of import mode for new projects in a team

IssueLabel

(Appears on: IssueSummary)

Field	Description
name string
url string
color string

IssueSummary

(Appears on: ReleaseSpec)

IssueSummary is the summary of an issue

Field	Description
id string
url string
title string
body string
state string
message string
user UserDetails
assignees []UserDetails
closedBy UserDetails
creationTimestamp Kubernetes meta/v1.Time
labels []IssueLabel

JobBase

(Appears on: Periodic, Postsubmit, Presubmit)

JobBase contains attributes common to all job types

Field	Description
name string	The name of the job. Must match regex [A-Za-z0-9-._]+ e.g. pull-test-infra-bazel-build
labels ReplaceableMapOfStringString	ReplaceableMapOfStringString are added to jobs and pods created for this job.
maxConcurrency int	MaximumConcurrency of this job, 0 implies no limit.
agent string	Agent that will take care of running this job.
cluster string	Cluster is the alias of the cluster to run this job in. (Default: kube.DefaultClusterAlias)
namespace string	Namespace is the namespace in which pods schedule. empty: results in scheduler.DefaultNamespace
spec Kubernetes core/v1.PodSpec	Spec is the Kubernetes pod spec used if Agent is kubernetes.

Lgtm

(Appears on: SchedulerSpec)

Lgtm specifies a configuration for a single lgtm. The configuration for the lgtm plugin is defined as a list of these structures.

Field	Description
reviewActsAsLgtm bool	ReviewActsAsLgtm indicates that a Github review of “approve” or “request changes” acts as adding or removing the lgtm label
storeTreeHash bool	StoreTreeHash indicates if tree_hash should be stored inside a comment to detect squashed commits before removing lgtm labels
trustedTeamForStickyLgtm string	WARNING: This disables the security mechanism that prevents a malicious member (or compromised GitHub account) from merging arbitrary code. Use with caution. StickyLgtmTeam specifies the Github team whose members are trusted with sticky LGTM, which eliminates the need to re-lgtm minor fixes/updates.

Measurement

(Appears on: FactSpec)

Measurement is a percentage or a count, something measured that the system will capture within a fact

Field	Description
name string
measurementType string
measurementValue int
tags []string

Merger

(Appears on: SchedulerSpec)

Merger defines the options used to merge the PR

Field	Description
- time.Duration	SyncPeriod specifies how often Merger will sync jobs with Github. Defaults to 1m.
- time.Duration	StatusUpdatePeriod
targetUrl string	URL for status contexts.
prStatusBaseUrl string	PRStatusBaseURL is the base URL for the PR status page. This is used to link to a merge requirements overview in the status context.
blockerLabel string	BlockerLabel is an optional label that is used to identify merge blocking Git Provider issues. Leave this blank to disable this feature and save 1 API token per sync loop.
squashLabel string	SquashLabel is an optional label that is used to identify PRs that should always be squash merged. Leave this blank to disable this feature.
maxGoroutines int	MaxGoroutines is the maximum number of goroutines spawned inside the controller to handle org/repo:branch pools. Defaults to 20. Needs to be a positive number.
mergeMethod string	Override the default method of merge. Valid options are squash, rebase, and merge.
policy ContextPolicy	ContextOptions defines the default merge options. If not set it will infer the required and optional contexts from the jobs configured and use the Git Provider combined status; otherwise it may apply the branch protection setting or let user define their own options in case branch protection is not used.

Original

(Appears on: FactSpec)

Original contains the report

Field	Description
mimetype string
url string
tags []string

Periodic

Periodic defines a job to be run periodically

Field	Description
JobBase JobBase	(Optional)
interval string	Interval to wait between two runs of the job.
cron string	Cron representation of job trigger time
tags ReplaceableSliceOfStrings	Tags for config entries

Periodics

(Appears on: SchedulerSpec)

Periodics is a list of jobs to be run periodically

Field	Description
entries []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Periodic	Items are the post submit configurations
replace bool	Replace the existing entries

PipelineActivitySpec

(Appears on: PipelineActivity)

PipelineActivitySpec is the specification of the pipeline activity

Field	Description
pipeline string
build string
version string
status ActivityStatusType
startedTimestamp Kubernetes meta/v1.Time
completedTimestamp Kubernetes meta/v1.Time
steps []PipelineActivityStep
buildUrl string
buildLogsUrl string
gitUrl string
gitRepository string
gitOwner string
gitBranch string
author string
authorAvatarURL string
authorURL string
pullTitle string
releaseNotesURL string
lastCommitSHA string
lastCommitMessage string
lastCommitURL string
workflow string	Deprecated - Workflow functionality was removed and is obsolete Keeping these fields to ensure backwards compatibility Should be removed when we increment spec version
workflowStatus ActivityStatusType
workflowMessage string
postExtensions []ExtensionExecution
attachments []Attachment
batchPipelineActivity BatchPipelineActivity
context string
baseSHA string

PipelineActivityStatus

(Appears on: PipelineActivity)

PipelineActivityStatus is the status for an Environment resource

Field	Description
version string

PipelineActivityStep

(Appears on: PipelineActivitySpec)

PipelineActivityStep represents a step in a pipeline activity

Field	Description
kind ActivityStepKindType
stage StageActivityStep
promote PromoteActivityStep
preview PreviewActivityStep

PipelineExtension

(Appears on: AppSpec)

PipelineExtension defines the image and command of an app which wants to modify/extend the pipeline

Field	Description
name string	Name of the container specified as a DNS_LABEL.
image string	Docker image name.
command string	Entrypoint array. Not executed within a shell.
args []string	Arguments to the entrypoint.

PipelineStageAndChildren

(Appears on: PipelineStageAndChildren)

PipelineStageAndChildren represents a single stage and its children.

Field	Description
Stage PipelineStructureStage
Parallel []PipelineStageAndChildren
Stages []PipelineStageAndChildren

PipelineStructureStage

(Appears on: PipelineStructure, PipelineStageAndChildren)

PipelineStructureStage contains the stage’s name, one of either a reference to the Task corresponding to the stage if it has steps, a list of sequential stage names nested within this stage, or a list of parallel stage names nested within this stage, and information on this stage’s depth within the PipelineStructure as a whole, the name of its parent stage, if any, the name of the stage before it in execution order, if any, and the name of the stage after it in execution order, if any.

Field	Description
name string
taskRef string	(Optional) Must have one of TaskRef+TaskRunRef, Stages, or Parallel
taskRunRef string	(Optional) Populated during pod discovery, not at initial creation time.
stages []string	(Optional)
parallel []string	(Optional)
depth byte
parent string	(Optional)
previous string	(Optional)
next string	(Optional)

PluginSpec

(Appears on: Plugin)

PluginSpec provides details of a binary plugin available for a team

Field	Description
subCommand string
group string
binaries []Binary
description string
name string
version string

Postsubmit

Postsubmit runs on push events.

Field	Description
JobBase JobBase	(Optional)
RegexpChangeMatcher RegexpChangeMatcher	(Optional)
Brancher Brancher	(Optional)
context string	Context is the name of the GitHub status context for the job.
report bool	Report will comment and set status on GitHub.

Postsubmits

(Appears on: SchedulerSpec)

Postsubmits is a list of Postsubmit job configurations that can optionally completely replace the Postsubmit job configurations in the parent scheduler

Field	Description
entries []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Postsubmit	Items are the post submit configurations
replace bool	Replace the existing entries

Presubmit

Presubmit defines a job configuration for pull requests

Field	Description
JobBase JobBase	(Optional)
Brancher Brancher	(Optional)
RegexpChangeMatcher RegexpChangeMatcher	(Optional)
alwaysRun bool	AlwaysRun automatically for every PR, or only when a comment triggers it. By default true.
context string	Context is the name of the Git Provider status context for the job.
optional bool	Optional indicates that the job’s status context should not be required for merge. By default false.
report bool	Report enables reporting the job status on the git provider
trigger string	Trigger is the regular expression to trigger the job. e.g. @k8s-bot e2e test this RerunCommand must also be specified if this field is specified. (Default: (?m)^/test (?:.*? )?<job name>(?: .*?)?$)
rerunCommand string	The RerunCommand to give users. Must match Trigger. Trigger must also be specified if this field is specified. (Default: /test <job name>)
mergeMethod string	Override the default method of merge. Valid options are squash, rebase, and merge.
queries []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Query
policy ProtectionPolicies
context_options RepoContextPolicy	ContextOptions defines the merge options. If not set it will infer the required and optional contexts from the jobs configured and use the Git Provider combined status; otherwise it may apply the branch protection setting or let user define their own options in case branch protection is not used.

Presubmits

(Appears on: SchedulerSpec)

Presubmits is a list of Presubmit job configurations that can optionally completely replace the Presubmit job configurations in the parent scheduler

Field	Description
entries []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Presubmit	Items are the Presubmit configurtations
replace bool	Replace the existing entries

PreviewActivityStep

(Appears on: PipelineActivityStep)

PreviewActivityStep is the step of creating a preview environment as part of a Pull Request pipeline

Field	Description
CoreActivityStep CoreActivityStep	(Members of CoreActivityStep are embedded into this type.)
environment string
pullRequestURL string
applicationURL string

PreviewGitSpec

(Appears on: EnvironmentSpec)

PreviewGitSpec is the preview git branch/pull request details

Field	Description
name string
url string
user UserSpec
title string
description string
buildStatus string
buildStatusUrl string
appName string
applicationURL string

PromoteActivityStep

(Appears on: PipelineActivityStep)

PromoteActivityStep is the step of promoting a version of an application to an environment

Field	Description
CoreActivityStep CoreActivityStep	(Members of CoreActivityStep are embedded into this type.)
environment string
pullRequest PromotePullRequestStep
update PromoteUpdateStep
applicationURL string

PromotePullRequestStep

(Appears on: PromoteActivityStep)

PromotePullRequestStep is the step for promoting a version to an environment by raising a Pull Request on the git repository of the environment

Field	Description
CoreActivityStep CoreActivityStep	(Members of CoreActivityStep are embedded into this type.)
pullRequestURL string
mergeCommitSHA string

PromoteUpdateStep

(Appears on: PromoteActivityStep)

PromoteUpdateStep is the step for updating a promotion after the Pull Request merges to master

Field	Description
CoreActivityStep CoreActivityStep	(Members of CoreActivityStep are embedded into this type.)
statuses []GitStatus

PromoteWorkflowStep

(Appears on: WorkflowStep)

PromoteWorkflowStep is the step of promoting a version of an application to an environment

Field	Description
environment string

PromotionEngineType (string alias)

(Appears on: TeamSettings)

PromotionEngineType is the type of promotion implementation the team uses

PromotionStrategyType (string alias)

(Appears on: EnvironmentSpec)

PromotionStrategyType is the type of a promotion strategy

ProtectionPolicies

(Appears on: Presubmit)

ProtectionPolicies defines the branch protection policies

Field	Description
ProtectionPolicy ProtectionPolicy	(Optional)
Replace bool	(Optional)
entries map[string]*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.ProtectionPolicy

ProtectionPolicy

(Appears on: GlobalProtectionPolicy, ProtectionPolicies)

ProtectionPolicy for merging.

Field	Description
protect bool	Protect overrides whether branch protection is enabled if set.
requiredStatusChecks BranchProtectionContextPolicy	RequiredStatusChecks configures github contexts
enforceAdmins bool	Admins overrides whether protections apply to admins if set.
restrictions Restrictions	Restrictions limits who can merge
requiredPullRequestReviews ReviewPolicy	RequiredPullRequestReviews specifies approval/review criteria.

ProwConfigType (string alias)

(Appears on: TeamSettings)

ProwConfigType is the type of prow configuration

ProwEngineType (string alias)

(Appears on: TeamSettings)

ProwEngineType is the type of prow execution engine

PullRequestInfo

(Appears on: BatchPipelineActivity)

PullRequestInfo contains information about a PR included in a batch, like its PR number, the last build number, and SHA

Field	Description
pullRequestNumber string
lastBuildNumberForCommit string	LastBuildNumberForCommit is the number of the last successful build of this PR outside of a batch
lastBuildSHA string	LastBuildSHA is the commit SHA in the last successful build of this PR outside of a batch.

PullRequestMergeType (string alias)

PullRequestMergeType enumerates the types of merges the Git Provider API can perform https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button

Query

Query is turned into a Git Provider search query. See the docs for details: https://help.github.com/articles/searching-issues-and-pull-requests/

Field	Description
excludedBranches ReplaceableSliceOfStrings
includedBranches ReplaceableSliceOfStrings
labels ReplaceableSliceOfStrings
missingLabels ReplaceableSliceOfStrings
milestone string
reviewApprovedRequired bool

QuickStartLocation

(Appears on: BuildPackSpec, TeamSettings)

QuickStartLocation

Field	Description
gitUrl string
gitKind string
owner string
includes []string
excludes []string

RegexpChangeMatcher

(Appears on: Postsubmit, Presubmit)

RegexpChangeMatcher is for code shared between jobs that run only when certain files are changed.

Field	Description
runIfChanged string	RunIfChanged defines a regex used to select which subset of file changes should trigger this job. If any file in the changeset matches this regex, the job will be triggered

ReleaseSpec

(Appears on: Release)

ReleaseSpec is the specification of the Release

Field	Description
name string
version string
gitHttpUrl string
gitCloneUrl string
commits []CommitSummary
issues []IssueSummary
pullRequests []IssueSummary
dependencyUpdates []DependencyUpdate
releaseNotesURL string
gitRepository string
gitOwner string

ReleaseStatus

(Appears on: Release)

ReleaseStatus is the status of a release

Field	Description
status ReleaseStatusType

ReleaseStatusType (string alias)

(Appears on: ReleaseStatus)

ReleaseStatusType is the status of a release; usually deployed or failed at completion

ReplaceableMapOfStringContextPolicy

(Appears on: RepoContextPolicy)

ReplaceableMapOfStringContextPolicy is a map of context policies that can optionally completely replace any context policies defined in the parent scheduler

Field	Description
replace bool
Items map[string]*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.ContextPolicy

ReplaceableMapOfStringString

(Appears on: JobBase)

ReplaceableMapOfStringString is a map of strings that can optionally completely replace the map of strings in the parent scheduler

Field	Description
entries map[string]string
replace bool	Replace the existing entries

ReplaceableSliceOfExternalPlugins

(Appears on: SchedulerSpec)

ReplaceableSliceOfExternalPlugins is a list of external plugins that can optionally completely replace the plugins in any parent SchedulerSpec

Field	Description
Replace bool
entries []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.ExternalPlugin

ReplaceableSliceOfStrings

(Appears on: BranchProtectionContextPolicy, Brancher, ContextPolicy, ExternalPlugin, Periodic, Query, Restrictions, SchedulerSpec)

ReplaceableSliceOfStrings is a slice of strings that can optionally completely replace the slice of strings defined in the parent scheduler

Field	Description
entries []string	Items is the string values
replace bool	Replace the existing entries

RepoContextPolicy

(Appears on: Presubmit)

RepoContextPolicy overrides the policy for repo, and any branch overrides.

Field	Description
ContextPolicy ContextPolicy
branches ReplaceableMapOfStringContextPolicy

ResourceReference

(Appears on: CommitStatusDetails, FactSpec, SourceRepositoryGroupSpec, SourceRepositorySpec, TeamSettings)

Field	Description
apiVersion string	API version of the referent.
kind string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name string	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid k8s.io/apimachinery/pkg/types.UID	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Restrictions

(Appears on: ProtectionPolicy, ReviewPolicy)

Restrictions limits who can merge Users and Teams entries are appended to parent lists.

Field	Description
users ReplaceableSliceOfStrings
teams ReplaceableSliceOfStrings

ReviewPolicy

(Appears on: ProtectionPolicy)

ReviewPolicy specifies git provider approval/review criteria. Any nil values inherit the policy from the parent, otherwise bool/ints are overridden. Non-empty lists are appended to parent lists.

Field	Description
dismissalRestrictions Restrictions	Restrictions appends users/teams that are allowed to merge
dismissStaleReviews bool	DismissStale overrides whether new commits automatically dismiss old reviews if set
requireCodeOwnerReviews bool	RequireOwners overrides whether CODEOWNERS must approve PRs if set
requiredApprovingReviewCount int	Approvals overrides the number of approvals required if set (set to 0 to disable)

SchedulerAgent

(Appears on: SchedulerSpec)

SchedulerAgent defines the scheduler agent configuration

Field	Description
agent string	Agent defines the agent used to schedule jobs, by default Prow

SchedulerSpec

(Appears on: Scheduler)

SchedulerSpec defines the pipeline scheduler (e.g. Prow) configuration

Field	Description
schedulerAgent SchedulerAgent
policy GlobalProtectionPolicy
presubmits Presubmits
postsubmits Postsubmits
trigger Trigger
approve Approve
lgtm Lgtm
externalPlugins ReplaceableSliceOfExternalPlugins
merger Merger
plugins ReplaceableSliceOfStrings	Plugins is a list of plugin names enabled for a repo
configUpdater ConfigUpdater
welcome []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Welcome
periodics Periodics
attachments []*github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1.Attachment

SourceRepositoryGroupSpec

(Appears on: SourceRepositoryGroup)

SourceRepositoryGroupSpec is the metadata for an Application/Project/SourceRepository

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
repositories []ResourceReference
scheduler ResourceReference

SourceRepositorySpec

(Appears on: SourceRepository)

SourceRepositorySpec provides details of the metadata for an App

Field	Description
description string
provider string	Provider stores the URL of the git provider such as https://github.com
org string
repo string
providerName string	ProviderName is a logical name for the provider without any URL scheme which can be used in a label selector
providerKind string	ProviderKind is the kind of provider (github / bitbucketcloud / bitbucketserver etc)
url string	URL is the web URL of the project page
sshCloneURL string	SSHCloneURL is the git URL to clone this repository using SSH
httpCloneURL string	HTTPCloneURL is the git URL to clone this repository using HTTP/HTTPS
scheduler ResourceReference	Scheduler a reference to a custom scheduler otherwise we default to the Team’s Scededuler

StageActivityStep

(Appears on: PipelineActivityStep)

StageActivityStep represents a stage of zero to more sub steps in a jenkins pipeline

Field	Description
CoreActivityStep CoreActivityStep	(Members of CoreActivityStep are embedded into this type.)
steps []CoreActivityStep

Statement

(Appears on: FactSpec)

Statement represents a decision that was made, for example that a promotion was approved or denied

Field	Description
name string
statementType string
measurementValue bool
tags []string

StorageLocation

(Appears on: TeamSettings)

StorageLocation

Field	Description
classifier string
gitUrl string
gitBranch string
bucketUrl string

TeamKindType (string alias)

(Appears on: TeamSpec)

TeamKindType is the kind of an Team

TeamProvisionStatusType (string alias)

(Appears on: TeamStatus)

TeamProvisionStatusType is the kind of an Team

TeamSettings

(Appears on: EnvironmentSpec)

TeamSettings the default settings for a team

Field	Description
useGitOps bool
askOnCreate bool
branchPatterns string
forkBranchPatterns string
quickstartLocations []QuickStartLocation
buildPackUrl string
buildPackRef string
helmBinary string
postPreviewJobs []Kubernetes batch/v1.Job
promotionEngine PromotionEngineType
noTiller bool
helmTemplate bool
gitServer string
organisation string
envOrganisation string
pipelineUsername string
pipelineUserEmail string
dockerRegistryOrg string
gitPublic bool
kubeProvider string
appsRepository string
buildPackName string
storageLocations []StorageLocation
deployKind string	DeployKind what kind of deployment (“default” uses regular Kubernetes Services and Deployments, “knative” uses the Knative Service resource instead)
importMode ImportModeType	ImportMode indicates what kind of
prowEngine ProwEngineType	ProwEngine is the kind of prow engine used such as knative build or build pipeline
versionStreamUrl string	VersionStreamURL contains the git clone URL for the Version Stream which is the set of versions to use for charts, images, packages etc
versionStreamRef string	VersionStreamRef contains the git ref (tag or branch) in the VersionStreamURL repository to use as the version stream
appPrefixes []string	AppsPrefixes is the list of prefixes for appNames
defaultScheduler ResourceReference
prowConfig ProwConfigType	ProwConfig is the way we manage prow configurations
profile string	Profile is the profile in use (see jx profile)
bootRequirements string	BootRequirements is a marshaled string of the jx-requirements.yml used in the most recent run for this cluster
deployOptions DeployOptions	DeployOptions configures options for how to deploy applications by default such as using canary rollouts (progressive delivery) or using horizontal pod autoscaler

TeamSpec

(Appears on: Team)

TeamSpec is the specification of an Team

Field	Description
label string
kind TeamKindType
members []string

TeamStatus

(Appears on: Team)

TeamStatus is the status for an Team resource

Field	Description
provisionStatus TeamProvisionStatusType
message string

Trigger

(Appears on: SchedulerSpec)

Trigger specifies a configuration for a single trigger.

The configuration for the trigger plugin is defined as a list of these structures.

Field	Description
trustedOrg string	TrustedOrg is the org whose members’ PRs will be automatically built for PRs to the above repos. The default is the PR’s org.
joinOrgUrl string	JoinOrgURL is a link that redirects users to a location where they should be able to read more about joining the organization in order to become trusted members. Defaults to the Github link of TrustedOrg.
onlyOrgMembers bool	OnlyOrgMembers requires PRs and/or /ok-to-test comments to come from org members. By default, trigger also include repo collaborators.
ignoreOkToTest bool	IgnoreOkToTest makes trigger ignore /ok-to-test comments. This is a security mitigation to only allow testing from trusted users.

UserDetails

(Appears on: User, CommitSummary, IssueSummary)

UserDetails containers details of a user

Field	Description
login string
name string
email string
creationTimestamp Kubernetes meta/v1.Time
url string
avatarUrl string
serviceAccount string
accountReference []AccountReference
externalUser bool

UserSpec

(Appears on: PreviewGitSpec)

UserSpec is the user details

Field	Description
username string
name string
linkUrl string
imageUrl string

WebHookEngineType (string alias)

(Appears on: EnvironmentSpec)

WebHookEngineType is the type of webhook processing implementation the team uses

Welcome

Welcome welcome plugin config

Field	Description
message_template string

WorkflowPreconditions

(Appears on: WorkflowStep)

WorkflowPreconditions is the trigger to start a step

Field	Description
environments []string	the names of the environments which need to have promoted before this step can be triggered

WorkflowSpec

(Appears on: Workflow)

WorkflowSpec is the specification of the pipeline activity

Field	Description
pipeline string
steps []WorkflowStep

WorkflowStatus

(Appears on: Workflow)

WorkflowStatus is the status for an Environment resource

Field	Description
version string

WorkflowStatusType (string alias)

WorkflowStatusType is the status of an activity; usually succeeded or failed/error on completion

WorkflowStep

(Appears on: WorkflowSpec)

WorkflowStep represents a step in a pipeline activity

Field	Description
kind WorkflowStepKindType
name string
description string
trigger WorkflowPreconditions
promote PromoteWorkflowStep

WorkflowStepKindType (string alias)

(Appears on: WorkflowStep)

WorkflowStepKindType is a kind of step

---

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

Feedback

Was this page helpful?

Yes No

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.