API OVERVIEW

Welcome to the Jenkins X API. You can use the Jenkins X API to read and write Kubernetes resource objects via a Jenkins X API endpoint.

Resource Categories

This is a high-level overview of the basic types of resources provide by the Jenkins X API and their primary functions.

Apps resources describe extensions to Jenkins X.

Pipelines & Environments resources describe the work being done by Jenkins X.

User Management resources describe the user management done by Jenkins X.

---

Resource Objects

Resource objects typically have 3 components:

• Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains fields that maybe updated both by the end user and the system (e.g. annotations).
• ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an object.
• ResourceStatus: This is filled in by the server and reports the current state of the system. In most cases, users don't need to change this.

---

Resource Operations

Most resources provide the following Operations:

Create

Create operations will create the resource in the storage backend. After a resource is create the system will apply the desired state.

Update

Updates come in 2 forms: Replace and Patch:

• Replace: Replacing a resource object will update the resource by replacing the existing spec with the provided one. For read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. To update the status, one must invoke the specific status update operation.
  Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are restarted out of band.
  Note: Where possible using Patch is preferable over UPDATE as if new fields have been added to the resource object that is not known about by the running code these will be lost.

• Patch: Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be replaced or merged. Merging lists will not preserve ordering.
  Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace the field's current value, or merge the contents into the current value.

Read

Reads come in 3 forms: Get, List and Watch:

• Get: Get will retrieve a specific resource object by name.
• List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.
  List All Namespaces: Like List but retrieves resources across all namespaces.
• Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.

Delete

Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See notes on specific resource objects for details.

Additional Operations

Resources may define additional operations specific to that resource type.

• Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.
• Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.
• Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.

---

APPS

The Apps Framework allows you to extend and enhance the capabilities in Jenkins X.

---

App v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	App

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec AppSpec

AppSpec v1 jenkins_io

Field	Description
pipelineExtension PipelineExtension
schemaPreprocessor Container
schemaPreprocessorRole Role

AppList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items App array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

BuildPack v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	BuildPack

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec BuildPackSpec

BuildPackSpec v1 jenkins_io

Field	Description
gitRef string
gitUrl string
label string
quickstartLocations QuickStartLocation array

BuildPackList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items BuildPack array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Plugin v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Plugin

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec PluginSpec

PluginSpec v1 jenkins_io

Field	Description
binaries Binary array
description string
group string
name string
subCommand string
version string

PluginList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Plugin array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

PIPELINES

---

Environment v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Environment

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec EnvironmentSpec
status EnvironmentStatus

EnvironmentSpec v1 jenkins_io

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

EnvironmentStatus v1 jenkins_io

Field	Description
version string

EnvironmentList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Environment array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

PipelineActivity v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PipelineActivity

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec PipelineActivitySpec
status PipelineActivityStatus

PipelineActivitySpec v1 jenkins_io

Field	Description
attachments Attachment array
author string
baseSHA string
batchPipelineActivity BatchPipelineActivity
build string
buildLogsUrl string
buildUrl string
completedTimestamp Time
context string
gitBranch string
gitOwner string
gitRepository string
gitUrl string
lastCommitMessage string
lastCommitSHA string
lastCommitURL string
pipeline string
postExtensions ExtensionExecution array
pullTitle string
releaseNotesURL string
startedTimestamp Time
status string
steps PipelineActivityStep array
version string
workflow string
workflowMessage string
workflowStatus string

PipelineActivityStatus v1 jenkins_io

Field	Description
version string

PipelineActivityList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items PipelineActivity array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Release v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Release

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec ReleaseSpec
status ReleaseStatus

ReleaseSpec v1 jenkins_io

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

ReleaseStatus v1 jenkins_io

Field	Description
status string

ReleaseList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Release array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Scheduler v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Scheduler

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec SchedulerSpec

SchedulerSpec v1 jenkins_io

Field	Description
approve Approve
attachments Attachment array
configUpdater ConfigUpdater
externalPlugins ReplaceableSliceOfExternalPlugins
lgtm Lgtm
merger Merger
periodics Periodics
plugins ReplaceableSliceOfStrings	Plugins is a list of plugin names enabled for a repo
policy GlobalProtectionPolicy
postsubmits Postsubmits
presubmits Presubmits
schedulerAgent SchedulerAgent
trigger Trigger
welcome Welcome array

SchedulerList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Scheduler array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

SourceRepository v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	SourceRepository

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec SourceRepositorySpec

SourceRepositorySpec v1 jenkins_io

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

SourceRepositoryList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items SourceRepository array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

SourceRepositoryGroup v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	SourceRepositoryGroup

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta
spec SourceRepositoryGroupSpec

SourceRepositoryGroupSpec v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta
repositories ResourceReference array
scheduler ResourceReference

SourceRepositoryGroupList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items SourceRepositoryGroup array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Pipelines Extensions

CommitStatus v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CommitStatus

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec CommitStatusSpec

CommitStatusSpec v1 jenkins_io

Field	Description
items CommitStatusDetails array

CommitStatusList v1 jenkins_io

Field	Description
Items CommitStatus array
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Fact v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Fact

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	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 }
spec FactSpec
status FactStatus

FactSpec v1 jenkins_io

Field	Description
factType string
measurements Measurement array
name string
original Original
statements Statement array
subject ResourceReference
tags string array

FactStatus v1 jenkins_io

Field	Description
version string

FactList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Fact array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

USER MANAGEMENT

---

User v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	User

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec UserDetails
user UserDetails	Deprecated, use Spec

UserSpec v1 jenkins_io

Field	Description
imageUrl string
linkUrl string
name string
username string

UserList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items User array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

Team v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Team

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec TeamSpec
status TeamStatus

TeamSpec v1 jenkins_io

Field	Description
kind string
label string
members string array

TeamStatus v1 jenkins_io

Field	Description
message string
provisionStatus string

TeamList v1 jenkins_io

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items Team array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ListMeta

DEFINITIONS

This section contains definitions for objects used in the Jenkins X APIs.

AWSElasticBlockStoreVolumeSource v1 core

Group	Version	Kind
core	v1	AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Field	Description
fsType string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partition integer	The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnly boolean	Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID string	Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

AccountReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	AccountReference

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

Field	Description
id string
provider string

Affinity v1 core

Group	Version	Kind
core	v1	Affinity

Affinity is a group of affinity scheduling rules.

Field	Description
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
podAffinity PodAffinity	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity PodAntiAffinity	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Approve v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Approve

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

Field	Description
ignoreReviewState boolean	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.
issueRequired boolean	IssueRequired indicates if an associated issue is required for approval in the specified repos.
lgtmActsAsApprove boolean	LgtmActsAsApprove indicates that the lgtm command should be used to indicate approval
requireSelfApproval boolean	RequireSelfApproval requires PR authors to explicitly approve their PRs. Otherwise the plugin assumes the author of the PR approves the changes in the PR.

Attachment v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Attachment

Field	Description
name string
urls string array

AzureDiskVolumeSource v1 core

Group	Version	Kind
core	v1	AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Field	Description
cachingMode string	Host Caching mode: None, Read Only, Read Write.
diskName string	The Name of the data disk in the blob storage
diskURI string	The URI the data disk in the blob storage
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kind string	Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnly boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

AzureFileVolumeSource v1 core

Group	Version	Kind
core	v1	AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Field	Description
readOnly boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName string	the name of secret that contains Azure Storage Account Name and Key
shareName string	Share Name

BatchPipelineActivity v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	BatchPipelineActivity

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

Field	Description
batchBranchName string
batchBuildNumber string
pullRequestInfo PullRequestInfo array

Binary v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Binary

Binary provies the details of a downloadable binary

Field	Description
goarch string
goos string
url string

BranchProtectionContextPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	BranchProtectionContextPolicy

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 boolean	Strict overrides whether new commits in the base branch require updating the PR if set

Brancher v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Brancher

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

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

Capabilities v1 core

Group	Version	Kind
core	v1	Capabilities

Adds and removes POSIX capabilities from running containers.

Field	Description
add string array	Added capabilities
drop string array	Removed capabilities

CephFSVolumeSource v1 core

Group	Version	Kind
core	v1	CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Field	Description
monitors string array	Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
path string	Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretFile string	Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretRef LocalObjectReference	Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user string	Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

ChartRef v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ChartRef

Field	Description
name string
repo string
repoName string

CinderVolumeSource v1 core

Group	Version	Kind
core	v1	CinderVolumeSource

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
readOnly boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
secretRef LocalObjectReference	Optional: points to a secret object containing parameters used to connect to OpenStack.
volumeID string	volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

CommitStatusCommitReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CommitStatusCommitReference

Field	Description
gitUrl string
pullRequest string
sha string

CommitStatusDetails v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CommitStatusDetails

Field	Description
Items CommitStatusItem array
checked boolean
commit CommitStatusCommitReference
context string
pipelineActivity ResourceReference

CommitStatusItem v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CommitStatusItem

Field	Description
description string
name string
pass boolean

CommitSummary v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CommitSummary

CommitSummary is the summary of a commit

Field	Description
author UserDetails
branch string
committer UserDetails
issueIds string array
message string
sha string
url string

ConfigMapEnvSource v1 core

Group	Version	Kind
core	v1	ConfigMapEnvSource

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Field	Description
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the ConfigMap must be defined

ConfigMapKeySelector v1 core

Group	Version	Kind
core	v1	ConfigMapKeySelector

Selects a key from a ConfigMap.

Field	Description
key string	The key to select.
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the ConfigMap or it's key must be defined

ConfigMapProjection v1 core

Group	Version	Kind
core	v1	ConfigMapProjection

Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

Field	Description
items KeyToPath array	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the ConfigMap or it's keys must be defined

ConfigMapSpec v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ConfigMapSpec

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

Field	Description
additional_namespaces string array	Namespaces in which the configMap needs to be deployed, in addition to the above namespace provided, or the default if it is not set.
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.
name string	Name of ConfigMap
namespace string	Namespace in which the configMap needs to be deployed. If no namespace is specified it will be deployed to the ProwJobNamespace.

ConfigMapVolumeSource v1 core

Group	Version	Kind
core	v1	ConfigMapVolumeSource

Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Field	Description
defaultMode integer	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items KeyToPath array	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the ConfigMap or it's keys must be defined

ConfigUpdater v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ConfigUpdater

ConfigUpdater holds configuration for the config updater plugin

Field	Description
ConfigMap ConfigMapSpec
configFile string
map object
pluginFile string

Container v1 core

Group	Version	Kind
core	v1	Container

A single application container that you want to run within a pod.

Field	Description
args string array	Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command string array	Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env EnvVar array patch strategy: merge patch merge key: name	List of environment variables to set in the container. Cannot be updated.
envFrom EnvFromSource array	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image string	Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicy string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle Lifecycle	Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe Probe	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports ContainerPort array patch strategy: merge patch merge key: containerPort	List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
readinessProbe Probe	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resources ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
securityContext SecurityContext	Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
stdin boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePath string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices VolumeDevice array patch strategy: merge patch merge key: devicePath	volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.
volumeMounts VolumeMount array patch strategy: merge patch merge key: mountPath	Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

ContainerPort v1 core

Group	Version	Kind
core	v1	ContainerPort

ContainerPort represents a network port in a single container.

Field	Description
containerPort integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP string	What host IP to bind the external port to.
hostPort integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
name string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

ContextPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ContextPolicy

ContextPolicy configures options about how to handle various contexts.

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

CoreActivityStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	CoreActivityStep

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

Field	Description
completedTimestamp Time
description string
name string
startedTimestamp Time
status string

DependencyUpdate v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	DependencyUpdate

DependencyUpdate describes an dependency update message from the commit log

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

DependencyUpdateDetails v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	DependencyUpdateDetails

DependencyUpdateDetails are the details of a dependency update

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

DownwardAPIProjection v1 core

Group	Version	Kind
core	v1	DownwardAPIProjection

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Field	Description
items DownwardAPIVolumeFile array	Items is a list of DownwardAPIVolume file

DownwardAPIVolumeFile v1 core

Group	Version	Kind
core	v1	DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Field	Description
fieldRef ObjectFieldSelector	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode integer	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef ResourceFieldSelector	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

DownwardAPIVolumeSource v1 core

Group	Version	Kind
core	v1	DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Field	Description
defaultMode integer	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items DownwardAPIVolumeFile array	Items is a list of downward API volume file

EmptyDirVolumeSource v1 core

Group	Version	Kind
core	v1	EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Field	Description
medium string	What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit Quantity	Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

EnvFromSource v1 core

Group	Version	Kind
core	v1	EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

Field	Description
configMapRef ConfigMapEnvSource	The ConfigMap to select from
prefix string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef SecretEnvSource	The Secret to select from

EnvVar v1 core

Group	Version	Kind
core	v1	EnvVar

EnvVar represents an environment variable present in a Container.

Field	Description
name string	Name of the environment variable. Must be a C_IDENTIFIER.
value string	Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom EnvVarSource	Source for the environment variable's value. Cannot be used if value is not empty.

EnvVarSource v1 core

Group	Version	Kind
core	v1	EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Field	Description
configMapKeyRef ConfigMapKeySelector	Selects a key of a ConfigMap.
fieldRef ObjectFieldSelector	Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
resourceFieldRef ResourceFieldSelector	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
secretKeyRef SecretKeySelector	Selects a key of a secret in the pod's namespace

EnvironmentFilter v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	EnvironmentFilter

EnvironmentFilter specifies the environments to apply the role binding to

Field	Description
excludes string array
includes string array
kind string

EnvironmentRepository v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	EnvironmentRepository

EnvironmentRepository is the repository for an environment using GitOps

Field	Description
kind string
ref string
url string

EnvironmentRoleBinding v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	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	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec EnvironmentRoleBindingSpec
status EnvironmentRoleBindingStatus

EnvironmentVariable v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	EnvironmentVariable

Field	Description
name string
value string

ExecAction v1 core

Group	Version	Kind
core	v1	ExecAction

ExecAction describes a "run in container" action.

Field	Description
command string array	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

Extension v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Extension

Extension represents an extension available to this Jenkins X install

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec ExtensionSpec

ExtensionConfig v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionConfig

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

Field	Description
name string
namespace string
parameters ExtensionParameterValue array

ExtensionDefinition v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionDefinition

ExtensionDefinition defines an Extension

Field	Description
children ExtensionDefinitionChildReference array
description string
given string
name string
namespace string
parameters ExtensionParameter array
scriptFile string
uuid string
when string array

ExtensionDefinitionChildReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionDefinitionChildReference

ExtensionDefinitionChildReference provides a reference to a child

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

ExtensionDefinitionReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionDefinitionReference

ExtensionRepositoryReference references a GitHub repo that contains extension definitions

Field	Description
remote string
tag string

ExtensionExecution v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionExecution

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
description string
environmentVariables EnvironmentVariable array
given string
name string
namespace string
script string
uuid string

ExtensionParameter v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionParameter

ExtensionParameter describes a parameter definition for an extension

Field	Description
defaultValue string
description string
environmentVariableName string
name string

ExtensionParameterValue v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionParameterValue

Field	Description
name string
value string

ExtensionRepositoryReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExtensionRepositoryReference

Field	Description
chart ChartRef
github string
url string

ExternalPlugin v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ExternalPlugin

ExternalPlugin holds configuration for registering an external plugin.

Field	Description
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.
name string	Name of the plugin.

FCVolumeSource v1 core

Group	Version	Kind
core	v1	FCVolumeSource

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lun integer	Optional: FC target lun number
readOnly boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs string array	Optional: FC target worldwide names (WWNs)
wwids string array	Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

FlexVolumeSource v1 core

Group	Version	Kind
core	v1	FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Field	Description
driver string	Driver is the name of the driver to use for this volume.
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options object	Optional: Extra command options if any.
readOnly boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef LocalObjectReference	Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

FlockerVolumeSource v1 core

Group	Version	Kind
core	v1	FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Field	Description
datasetName string	Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID string	UUID of the dataset. This is unique identifier of a Flocker dataset

GCEPersistentDiskVolumeSource v1 core

Group	Version	Kind
core	v1	GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Field	Description
fsType string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition integer	The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName string	Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

GitRepoVolumeSource v1 core

Group	Version	Kind
core	v1	GitRepoVolumeSource

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Field	Description
directory string	Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository string	Repository URL
revision string	Commit hash for the specified revision.

GitService v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	GitService

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

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec GitServiceSpec

GitStatus v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	GitStatus

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

Field	Description
status string
url string

GlobalProtectionPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	GlobalProtectionPolicy

GlobalProtectionPolicy defines the default branch protection policy for the scheduler

Field	Description
ProtectionPolicy ProtectionPolicy
protectTested boolean

GlusterfsVolumeSource v1 core

Group	Version	Kind
core	v1	GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Field	Description
endpoints string	EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
path string	Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
readOnly boolean	ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

HTTPGetAction v1 core

Group	Version	Kind
core	v1	HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Field	Description
host string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders HTTPHeader array	Custom headers to set in the request. HTTP allows repeated headers.
path string	Path to access on the HTTP server.
port	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme string	Scheme to use for connecting to the host. Defaults to HTTP.

HTTPHeader v1 core

Group	Version	Kind
core	v1	HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Field	Description
name string	The header field name
value string	The header field value

Handler v1 core

Group	Version	Kind
core	v1	Handler

Handler defines a specific action that should be taken

Field	Description
exec ExecAction	One and only one of the following should be specified. Exec specifies the action to take.
httpGet HTTPGetAction	HTTPGet specifies the http request to perform.
tcpSocket TCPSocketAction	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

HostAlias v1 core

Group	Version	Kind
core	v1	HostAlias

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Field	Description
hostnames string array	Hostnames for the above IP address.
ip string	IP address of the host file entry.

HostPathVolumeSource v1 core

Group	Version	Kind
core	v1	HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Field	Description
path string	Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type string	Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

ISCSIVolumeSource v1 core

Group	Version	Kind
core	v1	ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Field	Description
chapAuthDiscovery boolean	whether support iSCSI Discovery CHAP authentication
chapAuthSession boolean	whether support iSCSI Session CHAP authentication
fsType string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName string	Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn string	Target iSCSI Qualified Name.
iscsiInterface string	iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun integer	iSCSI Target Lun number.
portals string array	iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef LocalObjectReference	CHAP Secret for iSCSI target and initiator authentication
targetPortal string	iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

Initializer v1 meta

Group	Version	Kind
meta	v1	Initializer

Initializer is information about an initializer that has not yet completed.

Field	Description
name string	name of the process that is responsible for initializing this object.

Initializers v1 meta

Group	Version	Kind
meta	v1	Initializers

Initializers tracks the progress of initialization.

Field	Description
pending Initializer array patch strategy: merge patch merge key: name	Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result Status	If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

IssueLabel v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	IssueLabel

Field	Description
color string
name string
url string

IssueSummary v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	IssueSummary

IssueSummary is the summary of an issue

Field	Description
assignees UserDetails array
body string
closedBy UserDetails
creationTimestamp Time
id string
labels IssueLabel array
message string
state string
title string
url string
user UserDetails

Job v1 batch

Group	Version	Kind
batch	v1	Job

Job represents the configuration of a single job.

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec JobSpec	Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status JobStatus	Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

JobBase v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	JobBase

JobBase contains attributes common to all job types

Field	Description
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)
labels ReplaceableMapOfStringString	ReplaceableMapOfStringString are added to jobs and pods created for this job.
maxConcurrency integer	MaximumConcurrency of this job, 0 implies no limit.
name string	The name of the job. Must match regex [A-Za-z0-9-._]+ e.g. pull-test-infra-bazel-build
namespace string	Namespace is the namespace in which pods schedule. empty: results in scheduler.DefaultNamespace
spec PodSpec	Spec is the Kubernetes pod spec used if Agent is kubernetes.

JobCondition v1 batch

Group	Version	Kind
batch	v1	JobCondition

JobCondition describes current state of a job.

Field	Description
lastProbeTime Time	Last time the condition was checked.
lastTransitionTime Time	Last time the condition transit from one status to another.
message string	Human readable message indicating details about last transition.
reason string	(brief) reason for the condition's last transition.
status string	Status of the condition, one of True, False, Unknown.
type string	Type of job condition, Complete or Failed.

KeyToPath v1 core

Group	Version	Kind
core	v1	KeyToPath

Maps a string key to a path within a volume.

Field	Description
key string	The key to project.
mode integer	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path string	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

LabelSelector v1 meta

Group	Version	Kind
meta	v1	LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Field	Description
matchExpressions LabelSelectorRequirement array	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

LabelSelectorRequirement v1 meta

Group	Version	Kind
meta	v1	LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Field	Description
key string patch strategy: merge patch merge key: key	key is the label key that the selector applies to.
operator string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values string array	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Lgtm v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Lgtm

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 boolean	ReviewActsAsLgtm indicates that a Github review of "approve" or "request changes" acts as adding or removing the lgtm label
storeTreeHash boolean	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.

Lifecycle v1 core

Group	Version	Kind
core	v1	Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Field	Description
postStart Handler	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
preStop Handler	PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

ListMeta v1 meta

Group	Version	Kind
meta	v1	ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Field	Description
continue string	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
resourceVersion string	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink string	selfLink is a URL representing this object. Populated by the system. Read-only.

LocalObjectReference v1 core

Group	Version	Kind
core	v1	LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Field	Description
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Measurement v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Measurement

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

Field	Description
measurementType string
measurementValue integer
name string
tags string array

Merger v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Merger

Merger defines the options used to merge the PR

Field	Description
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.
maxGoroutines integer	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.
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.
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.
targetUrl string	URL for status contexts.

NFSVolumeSource v1 core

Group	Version	Kind
core	v1	NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Field	Description
path string	Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly boolean	ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server string	Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

NodeAffinity v1 core

Group	Version	Kind
core	v1	NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Field	Description
preferredDuringSchedulingIgnoredDuringExecution PreferredSchedulingTerm array	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution NodeSelector	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

NodeSelector v1 core

Group	Version	Kind
core	v1	NodeSelector

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Field	Description
nodeSelectorTerms NodeSelectorTerm array	Required. A list of node selector terms. The terms are ORed.

NodeSelectorRequirement v1 core

Group	Version	Kind
core	v1	NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Field	Description
key string	The label key that the selector applies to.
operator string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values string array	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

NodeSelectorTerm v1 core

Group	Version	Kind
core	v1	NodeSelectorTerm

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Field	Description
matchExpressions NodeSelectorRequirement array	A list of node selector requirements by node's labels.
matchFields NodeSelectorRequirement array	A list of node selector requirements by node's fields.

ObjectFieldSelector v1 core

Group	Version	Kind
core	v1	ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Field	Description
apiVersion string	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath string	Path of the field to select in the specified API version.

ObjectMeta v1 meta

Group	Version	Kind
meta	v1	ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Field	Description
annotations object	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
clusterName string	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp Time	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
deletionGracePeriodSeconds integer	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp Time	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
finalizers string array patch strategy: merge	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
generateName string	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
generation integer	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
initializers Initializers	An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
labels object	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
name string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace string	Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
ownerReferences OwnerReference array patch strategy: merge patch merge key: uid	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion string	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink string	SelfLink is a URL representing this object. Populated by the system. Read-only.
uid string	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Original v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Original

Original contains the report

Field	Description
mimetype string
tags string array
url string

OwnerReference v1 meta

Group	Version	Kind
meta	v1	OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Field	Description
apiVersion string	API version of the referent.
blockOwnerDeletion boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller boolean	If true, this reference points to the managing controller.
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 string	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Periodic v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Periodic

Periodic defines a job to be run periodically

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

Periodics v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Periodics

Periodics is a list of jobs to be run periodically

Field	Description
entries Periodic array	Items are the post submit configurations
replace boolean	Replace the existing entries

PersistentVolumeClaimVolumeSource v1 core

Group	Version	Kind
core	v1	PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Field	Description
claimName string	ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly boolean	Will force the ReadOnly setting in VolumeMounts. Default false.

PhotonPersistentDiskVolumeSource v1 core

Group	Version	Kind
core	v1	PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
pdID string	ID that identifies Photon Controller persistent disk

PipelineActivityStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PipelineActivityStep

PipelineActivityStep represents a step in a pipeline activity

Field	Description
kind string
preview PreviewActivityStep
promote PromoteActivityStep
stage StageActivityStep

PipelineExtension v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PipelineExtension

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

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

PipelineStructure v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	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	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
pipelineRef string
pipelineRunRef string
stages PipelineStructureStage array

PipelineStructureStage v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PipelineStructureStage

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
depth integer
name string
next string
parallel string array
parent string
previous string
stages string array
taskRef string	Must have one of TaskRef+TaskRunRef, Stages, or Parallel
taskRunRef string	Populated during pod discovery, not at initial creation time.

PodAffinity v1 core

Group	Version	Kind
core	v1	PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

Field	Description
preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm array	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm array	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PodAffinityTerm v1 core

Group	Version	Kind
core	v1	PodAffinityTerm

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Field	Description
labelSelector LabelSelector	A label query over a set of resources, in this case pods.
namespaces string array	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
topologyKey string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

PodAntiAffinity v1 core

Group	Version	Kind
core	v1	PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Field	Description
preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm array	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm array	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PodDNSConfig v1 core

Group	Version	Kind
core	v1	PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Field	Description
nameservers string array	A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options PodDNSConfigOption array	A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
searches string array	A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

PodDNSConfigOption v1 core

Group	Version	Kind
core	v1	PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

Field	Description
name string	Required.
value string

PodReadinessGate v1 core

Group	Version	Kind
core	v1	PodReadinessGate

PodReadinessGate contains the reference to a pod condition

Field	Description
conditionType string	ConditionType refers to a condition in the pod's condition list with matching type.

PodSecurityContext v1 core

Group	Version	Kind
core	v1	PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Field	Description
fsGroup integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
runAsGroup integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
runAsNonRoot boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
seLinuxOptions SELinuxOptions	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
supplementalGroups integer array	A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
sysctls Sysctl array	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.

PodSpec v1 core

Group	Version	Kind
core	v1	PodSpec

PodSpec is a description of a pod.

Field	Description
activeDeadlineSeconds integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
affinity Affinity	If specified, the pod's scheduling constraints
automountServiceAccountToken boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers Container array patch strategy: merge patch merge key: name	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
dnsConfig PodDNSConfig	Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
dnsPolicy string	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
hostAliases HostAlias array patch strategy: merge patch merge key: ip	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
hostIPC boolean	Use the host's ipc namespace. Optional: Default to false.
hostNetwork boolean	Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID boolean	Use the host's pid namespace. Optional: Default to false.
hostname string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
imagePullSecrets LocalObjectReference array patch strategy: merge patch merge key: name	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
initContainers Container array patch strategy: merge patch merge key: name	List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
nodeName string	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
nodeSelector object	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
priority integer	The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
priorityClassName string	If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
readinessGates PodReadinessGate array	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md
restartPolicy string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
runtimeClassName string	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future.
schedulerName string	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
securityContext PodSecurityContext	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
serviceAccount string	DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespace boolean	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is beta-level and may be disabled with the PodShareProcessNamespace feature.
subdomain string	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
tolerations Toleration array	If specified, the pod's tolerations.
volumes Volume array patch strategy: merge,retainKeys patch merge key: name	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

PodTemplateSpec v1 core

Group	Version	Kind
core	v1	PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

Field	Description
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec PodSpec	Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

PolicyRule v1 rbac

Group	Version	Kind
rbac	v1	PolicyRule

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Field	Description
apiGroups string array	APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs string array	NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames string array	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources string array	Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs string array	Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

PortworxVolumeSource v1 core

Group	Version	Kind
core	v1	PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

Field	Description
fsType string	FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID string	VolumeID uniquely identifies a Portworx volume

Postsubmit v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Postsubmit

Postsubmit runs on push events.

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

Postsubmits v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Postsubmits

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

Field	Description
entries Postsubmit array	Items are the post submit configurations
replace boolean	Replace the existing entries

PreferredSchedulingTerm v1 core

Group	Version	Kind
core	v1	PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Field	Description
preference NodeSelectorTerm	A node selector term, associated with the corresponding weight.
weight integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

Presubmit v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Presubmit

Presubmit defines a job configuration for pull requests

Field	Description
Brancher Brancher
JobBase JobBase
RegexpChangeMatcher RegexpChangeMatcher
alwaysRun boolean	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.
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.
mergeMethod string	Override the default method of merge. Valid options are squash, rebase, and merge.
optional boolean	Optional indicates that the job's status context should not be required for merge. By default false.
policy ProtectionPolicies
queries Query array
report boolean	Report enables reporting the job status on the git provider
rerunCommand string	The RerunCommand to give users. Must match Trigger. Trigger must also be specified if this field is specified. (Default: `/test <job name>`)
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>(?: .*?)?$`)

Presubmits v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Presubmits

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

Field	Description
entries Presubmit array	Items are the Presubmit configurtations
replace boolean	Replace the existing entries

PreviewActivityStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PreviewActivityStep

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

Field	Description
applicationURL string
completedTimestamp Time
description string
environment string
name string
pullRequestURL string
startedTimestamp Time
status string

PreviewGitSpec v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PreviewGitSpec

PreviewGitSpec is the preview git branch/pull request details

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

Probe v1 core

Group	Version	Kind
core	v1	Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Field	Description
exec ExecAction	One and only one of the following should be specified. Exec specifies the action to take.
failureThreshold integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
httpGet HTTPGetAction	HTTPGet specifies the http request to perform.
initialDelaySeconds integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
tcpSocket TCPSocketAction	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
timeoutSeconds integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

ProjectedVolumeSource v1 core

Group	Version	Kind
core	v1	ProjectedVolumeSource

Represents a projected volume source

Field	Description
defaultMode integer	Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sources VolumeProjection array	list of volume projections

PromoteActivityStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PromoteActivityStep

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

Field	Description
applicationURL string
completedTimestamp Time
description string
environment string
name string
pullRequest PromotePullRequestStep
startedTimestamp Time
status string
update PromoteUpdateStep

PromotePullRequestStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PromotePullRequestStep

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
completedTimestamp Time
description string
mergeCommitSHA string
name string
pullRequestURL string
startedTimestamp Time
status string

PromoteUpdateStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PromoteUpdateStep

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

Field	Description
completedTimestamp Time
description string
name string
startedTimestamp Time
status string
statuses GitStatus array

PromoteWorkflowStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PromoteWorkflowStep

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

Field	Description
environment string

ProtectionPolicies v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ProtectionPolicies

ProtectionPolicies defines the branch protection policies

Field	Description
ProtectionPolicy ProtectionPolicy
Replace boolean
entries object

ProtectionPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ProtectionPolicy

ProtectionPolicy for merging.

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

PullRequestInfo v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	PullRequestInfo

PullRequestInfo contains information about a PR, like its PR and Build numbers

Field	Description
lastBuildNumberForCommit string
pullRequestNumber string

Quantity resource core

Group	Version	Kind
core	resource	Quantity

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and Int64() accessors. The serialization format is: <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

Field	Description

Query v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	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
milestone string
missingLabels ReplaceableSliceOfStrings
reviewApprovedRequired boolean

QuickStartLocation v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	QuickStartLocation

QuickStartLocation

Field	Description
excludes string array
gitKind string
gitUrl string
includes string array
owner string

QuobyteVolumeSource v1 core

Group	Version	Kind
core	v1	QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Field	Description
group string	Group to map volume access to Default is no group
readOnly boolean	ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry string	Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
user string	User to map volume access to Defaults to serivceaccount user
volume string	Volume is a string that references an already created Quobyte volume by name.

RBDVolumeSource v1 core

Group	Version	Kind
core	v1	RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Field	Description
fsType string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image string	The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
keyring string	Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors string array	A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool string	The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
readOnly boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
secretRef LocalObjectReference	SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user string	The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

RegexpChangeMatcher v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	RegexpChangeMatcher

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

ReplaceableMapOfStringContextPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ReplaceableMapOfStringContextPolicy

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

Field	Description
Items object
replace boolean

ReplaceableMapOfStringString v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ReplaceableMapOfStringString

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

Field	Description
entries object
replace boolean	Replace the existing entries

ReplaceableSliceOfExternalPlugins v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ReplaceableSliceOfExternalPlugins

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

Field	Description
Replace boolean
entries ExternalPlugin array

ReplaceableSliceOfStrings v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ReplaceableSliceOfStrings

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

Field	Description
entries string array	Items is the string values
replace boolean	Replace the existing entries

RepoContextPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	RepoContextPolicy

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

Field	Description
ContextPolicy ContextPolicy
branches ReplaceableMapOfStringContextPolicy

ResourceFieldSelector v1 core

Group	Version	Kind
core	v1	ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Field	Description
containerName string	Container name: required for volumes, optional for env vars
divisor Quantity	Specifies the output format of the exposed resources, defaults to "1"
resource string	Required: resource to select

ResourceReference v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ResourceReference

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 string	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

ResourceRequirements v1 core

Group	Version	Kind
core	v1	ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Field	Description
limits object	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests object	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

Restrictions v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Restrictions

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

Field	Description
teams ReplaceableSliceOfStrings
users ReplaceableSliceOfStrings

ReviewPolicy v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	ReviewPolicy

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
dismissStaleReviews boolean	DismissStale overrides whether new commits automatically dismiss old reviews if set
dismissalRestrictions Restrictions	Restrictions appends users/teams that are allowed to merge
requireCodeOwnerReviews boolean	RequireOwners overrides whether CODEOWNERS must approve PRs if set
requiredApprovingReviewCount integer	Approvals overrides the number of approvals required if set (set to 0 to disable)

Role v1 rbac

Group	Version	Kind
rbac	v1	Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata.
rules PolicyRule array	Rules holds all the PolicyRules for this Role

RoleRef v1 rbac

Group	Version	Kind
rbac	v1	RoleRef

RoleRef contains information that points to the role being used

Field	Description
apiGroup string	APIGroup is the group for the resource being referenced
kind string	Kind is the type of resource being referenced
name string	Name is the name of resource being referenced

SELinuxOptions v1 core

Group	Version	Kind
core	v1	SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Field	Description
level string	Level is SELinux level label that applies to the container.
role string	Role is a SELinux role label that applies to the container.
type string	Type is a SELinux type label that applies to the container.
user string	User is a SELinux user label that applies to the container.

ScaleIOVolumeSource v1 core

Group	Version	Kind
core	v1	ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
gateway string	The host address of the ScaleIO API Gateway.
protectionDomain string	The name of the ScaleIO Protection Domain for the configured storage.
readOnly boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef LocalObjectReference	SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled boolean	Flag to enable/disable SSL communication with Gateway, default false
storageMode string	Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool string	The ScaleIO Storage Pool associated with the protection domain.
system string	The name of the storage system as configured in ScaleIO.
volumeName string	The name of a volume already created in the ScaleIO system that is associated with this volume source.

SchedulerAgent v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	SchedulerAgent

SchedulerAgent defines the scheduler agent configuration

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

SecretEnvSource v1 core

Group	Version	Kind
core	v1	SecretEnvSource

SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Field	Description
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the Secret must be defined

SecretKeySelector v1 core

Group	Version	Kind
core	v1	SecretKeySelector

SecretKeySelector selects a key of a Secret.

Field	Description
key string	The key of the secret to select from. Must be a valid secret key.
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the Secret or it's key must be defined

SecretProjection v1 core

Group	Version	Kind
core	v1	SecretProjection

Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

Field	Description
items KeyToPath array	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean	Specify whether the Secret or its key must be defined

SecretVolumeSource v1 core

Group	Version	Kind
core	v1	SecretVolumeSource

Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Field	Description
defaultMode integer	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items KeyToPath array	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optional boolean	Specify whether the Secret or it's keys must be defined
secretName string	Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

SecurityContext v1 core

Group	Version	Kind
core	v1	SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Field	Description
allowPrivilegeEscalation boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
capabilities Capabilities	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
privileged boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
procMount string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
readOnlyRootFilesystem boolean	Whether this container has a read-only root filesystem. Default is false.
runAsGroup integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
seLinuxOptions SELinuxOptions	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

ServiceAccountTokenProjection v1 core

Group	Version	Kind
core	v1	ServiceAccountTokenProjection

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Field	Description
audience string	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds integer	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path string	Path is the path relative to the mount point of the file to project the token into.

StageActivityStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	StageActivityStep

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

Field	Description
completedTimestamp Time
description string
name string
startedTimestamp Time
status string
steps CoreActivityStep array

Statement v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Statement

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

Field	Description
measurementValue boolean
name string
statementType string
tags string array

Status v1 meta

Group	Version	Kind
meta	v1	Status

Status is a return value for calls that don't return other objects.

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
code integer	Suggested HTTP return code for this status, 0 if not set.
details StatusDetails	Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
message string	A human-readable description of the status of this operation.
metadata ListMeta	Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
reason string	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status string	Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

StatusCause v1 meta

Group	Version	Kind
meta	v1	StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Field	Description
field string	The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message string	A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason string	A machine-readable description of the cause of the error. If this value is empty there is no information available.

StatusDetails v1 meta

Group	Version	Kind
meta	v1	StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Field	Description
causes StatusCause array	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group string	The group attribute of the resource associated with the status StatusReason.
kind string	The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name string	The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds integer	If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid string	UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

StorageLocation v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	StorageLocation

StorageLocation

Field	Description
bucketUrl string
classifier string
gitBranch string
gitUrl string

StorageOSVolumeSource v1 core

Group	Version	Kind
core	v1	StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef LocalObjectReference	SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName string	VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace string	VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

Subject v1 rbac

Group	Version	Kind
rbac	v1	Subject

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

Field	Description
apiGroup string	APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind string	Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name string	Name of the object being referenced.
namespace string	Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

Sysctl v1 core

Group	Version	Kind
core	v1	Sysctl

Sysctl defines a kernel parameter to be set

Field	Description
name string	Name of a property to set
value string	Value of a property to set

TCPSocketAction v1 core

Group	Version	Kind
core	v1	TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Field	Description
host string	Optional: Host name to connect to, defaults to the pod IP.
port	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

TeamSettings v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	TeamSettings

TeamSettings the default settings for a team

Field	Description
appPrefixes string array	AppsPrefixes is the list of prefixes for appNames
appsRepository string
askOnCreate boolean
bootRequirements string	BootRequirements is a marshaled string of the jx-requirements.yml used in the most recent run for this cluster
branchPatterns string
buildPackName string
buildPackRef string
buildPackUrl string
defaultScheduler ResourceReference
deployKind string
dockerRegistryOrg string
envOrganisation string
forkBranchPatterns string
gitPublic boolean
gitServer string
helmBinary string
helmTemplate boolean
importMode string	ImportMode indicates what kind of
kubeProvider string
noTiller boolean
organisation string
pipelineUserEmail string
pipelineUsername string
postPreviewJobs Job array
profile string	Profile is the profile in use (see jx profile)
promotionEngine string
prowConfig string	ProwConfig is the way we manage prow configurations
prowEngine string	ProwEngine is the kind of prow engine used such as knative build or build pipeline
quickstartLocations QuickStartLocation array
storageLocations StorageLocation array
useGitOps boolean
versionStreamRef string	VersionStreamRef contains the git ref (tag or branch) in the VersionStreamURL repository to use as the version stream
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

Time v1 meta

Group	Version	Kind
meta	v1	Time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Field	Description

Toleration v1 core

Group	Version	Kind
core	v1	Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Field	Description
effect string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

Trigger v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Trigger

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

Field	Description
ignoreOkToTest boolean	IgnoreOkToTest makes trigger ignore /ok-to-test comments. This is a security mitigation to only allow testing from trusted users.
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 boolean	OnlyOrgMembers requires PRs and/or /ok-to-test comments to come from org members. By default, trigger also include repo collaborators.
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.

UserDetails v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	UserDetails

UserDetails containers details of a user

Field	Description
accountReference AccountReference array
avatarUrl string
creationTimestamp Time
email string
externalUser boolean
login string
name string
serviceAccount string
url string

Volume v1 core

Group	Version	Kind
core	v1	Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Field	Description
awsElasticBlockStore AWSElasticBlockStoreVolumeSource	AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk AzureDiskVolumeSource	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile AzureFileVolumeSource	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfs CephFSVolumeSource	CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder CinderVolumeSource	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
configMap ConfigMapVolumeSource	ConfigMap represents a configMap that should populate this volume
downwardAPI DownwardAPIVolumeSource	DownwardAPI represents downward API about the pod that should populate this volume
emptyDir EmptyDirVolumeSource	EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
fc FCVolumeSource	FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume FlexVolumeSource	FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
flocker FlockerVolumeSource	Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
gcePersistentDisk GCEPersistentDiskVolumeSource	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
gitRepo GitRepoVolumeSource	GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
glusterfs GlusterfsVolumeSource	Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath HostPathVolumeSource	HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi ISCSIVolumeSource	ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md
name string	Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
nfs NFSVolumeSource	NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistentVolumeClaim PersistentVolumeClaimVolumeSource	PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
photonPersistentDisk PhotonPersistentDiskVolumeSource	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume PortworxVolumeSource	PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
projected ProjectedVolumeSource	Items for all in one resources secrets, configmaps, and downward API
quobyte QuobyteVolumeSource	Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd RBDVolumeSource	RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
scaleIO ScaleIOVolumeSource	ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
secret SecretVolumeSource	Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageos StorageOSVolumeSource	StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
vsphereVolume VsphereVirtualDiskVolumeSource	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

VolumeDevice v1 core

Group	Version	Kind
core	v1	VolumeDevice

volumeDevice describes a mapping of a raw block device within a container.

Field	Description
devicePath string	devicePath is the path inside of the container that the device will be mapped to.
name string	name must match the name of a persistentVolumeClaim in the pod

VolumeMount v1 core

Group	Version	Kind
core	v1	VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Field	Description
mountPath string	Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
name string	This must match the Name of a Volume.
readOnly boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
subPath string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

VolumeProjection v1 core

Group	Version	Kind
core	v1	VolumeProjection

Projection that may be projected along with other supported volume types

Field	Description
configMap ConfigMapProjection	information about the configMap data to project
downwardAPI DownwardAPIProjection	information about the downwardAPI data to project
secret SecretProjection	information about the secret data to project
serviceAccountToken ServiceAccountTokenProjection	information about the serviceAccountToken data to project

VsphereVirtualDiskVolumeSource v1 core

Group	Version	Kind
core	v1	VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Field	Description
fsType string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyID string	Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName string	Storage Policy Based Management (SPBM) profile name.
volumePath string	Path that identifies vSphere volume vmdk

WeightedPodAffinityTerm v1 core

Group	Version	Kind
core	v1	WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Field	Description
podAffinityTerm PodAffinityTerm	Required. A pod affinity term, associated with the corresponding weight.
weight integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

Welcome v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Welcome

Welcome welcome plugin config

Field	Description
message_template string

Workflow v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	Workflow

Workflow represents pipeline activity for a particular run of a pipeline

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec WorkflowSpec
status WorkflowStatus

WorkflowPreconditions v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	WorkflowPreconditions

WorkflowPreconditions is the trigger to start a step

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

WorkflowStep v1 jenkins_io

Group	Version	Kind
jenkins_io	v1	WorkflowStep

WorkflowStep represents a step in a pipeline activity

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

OLD API VERSIONS

This section contains older versions of resources shown above.