Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

Common object reference

Affinity [core/v1]

Description

Affinity is a group of affinity scheduling rules.

Type

object

Specification

Property Type Description

.nodeAffinity

NodeAffinity core/v1

Describes node affinity scheduling rules for the pod.

.podAffinity

PodAffinity core/v1

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

.podAntiAffinity

PodAntiAffinity core/v1

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

AggregationRule [rbac.authorization.k8s.io/v1]

Description

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Type

object

Specification

Property Type Description

.clusterRoleSelectors

array (LabelSelector meta/v1)

ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole’s permissions will be added

AlertmanagerList [monitoring.coreos.com/v1]

Description

AlertmanagerList is a list of Alertmanager

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Alertmanager monitoring.coreos.com/v1)

List of alertmanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

APIServerList [config.openshift.io/v1]

Description

APIServerList is a list of APIServer

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (APIServer config.openshift.io/v1)

List of apiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

APIServiceList [apiregistration.k8s.io/v1]

Description

APIServiceList is a list of APIService objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (APIService apiregistration.k8s.io/v1)

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

AppliedClusterResourceQuotaList [quota.openshift.io/v1]

Description

AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (AppliedClusterResourceQuota quota.openshift.io/v1)

Items is a list of AppliedClusterResourceQuota

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

AttachedVolume [core/v1]

Description

AttachedVolume describes a volume attached to a node

Type

object

Required

  • name

  • devicePath

Specification

Property Type Description

.devicePath

string

DevicePath represents the device path where the volume should be available

.name

string

Name of the attached volume

AuthenticationList [config.openshift.io/v1]

Description

AuthenticationList is a list of Authentication

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Authentication config.openshift.io/v1)

List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AuthenticationList [operator.openshift.io/v1]

Description

AuthenticationList is a list of Authentication

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Authentication operator.openshift.io/v1)

List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AWSElasticBlockStoreVolumeSource [core/v1]

Description

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.

Type

object

Required

  • volumeID

Specification

Property Type 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

AzureDiskVolumeSource [core/v1]

Description

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

Type

object

Required

  • diskName

  • diskURI

Specification

Property Type 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.

AzureFilePersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • secretName

  • shareName

Specification

Property Type 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

.secretNamespace

string

the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod

.shareName

string

Share Name

AzureFileVolumeSource [core/v1]

Description

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

Type

object

Required

  • secretName

  • shareName

Specification

Property Type 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

BareMetalHostList [metal3.io/v1alpha1]

Description

BareMetalHostList is a list of BareMetalHost

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (BareMetalHost metal3.io/v1alpha1)

List of baremetalhosts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

BrokerTemplateInstanceList [template.openshift.io/v1]

Description

BrokerTemplateInstanceList is a list of BrokerTemplateInstance objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (BrokerTemplateInstance template.openshift.io/v1)

items is a list of BrokerTemplateInstances

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

BuildConfigList [build.openshift.io/v1]

Description

BuildConfigList is a collection of BuildConfigs.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (BuildConfig build.openshift.io/v1)

items is a list of build configs

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

BuildList [build.openshift.io/v1]

Description

BuildList is a collection of Builds.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Build build.openshift.io/v1)

items is a list of builds

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

BuildList [config.openshift.io/v1]

Description

BuildList is a list of Build

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Build config.openshift.io/v1)

List of builds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

BuildLog [build.openshift.io/v1]

Description

BuildLog is the (unused) resource associated with the build log redirector

Type

object

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

BuildRequest [build.openshift.io/v1]

Description

BuildRequest is the resource used to pass parameters to build generator

Type

object

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.binary

BinaryBuildSource build.openshift.io/v1

binary indicates a request to build from a binary provided to the builder

.dockerStrategyOptions

DockerStrategyOptions build.openshift.io/v1

DockerStrategyOptions contains additional docker-strategy specific options for the build

.env

array (EnvVar core/v1)

env contains additional environment variables you want to pass into a builder container.

.from

ObjectReference core/v1

from is the reference to the ImageStreamTag that triggered the build.

.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/sig-architecture/api-conventions.md#types-kinds

.lastVersion

integer

lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn’t match, a build will not be generated.

.metadata

ObjectMeta meta/v1

.revision

SourceRevision build.openshift.io/v1

revision is the information from the source for a specific repo snapshot.

.sourceStrategyOptions

SourceStrategyOptions build.openshift.io/v1

SourceStrategyOptions contains additional source-strategy specific options for the build

.triggeredBy

array (BuildTriggerCause build.openshift.io/v1)

triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.

.triggeredByImage

ObjectReference core/v1

triggeredByImage is the Image that triggered this build.

Capabilities [core/v1]

Description

Adds and removes POSIX capabilities from running containers.

Type

object

Specification

Property Type Description

.add

array (string)

Added capabilities

.drop

array (string)

Removed capabilities

CatalogSourceList [operators.coreos.com/v1alpha1]

Description

CatalogSourceList is a list of CatalogSource

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CatalogSource operators.coreos.com/v1alpha1)

List of catalogsources. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

CephFSPersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • monitors

Specification

Property Type Description

.monitors

array (string)

Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

.secretRef

SecretReference core/v1

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

.user

string

Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

CephFSVolumeSource [core/v1]

Description

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

Type

object

Required

  • monitors

Specification

Property Type Description

.monitors

array (string)

Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

.secretRef

LocalObjectReference core/v1

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

.user

string

Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

CertificateSigningRequestList [certificates.k8s.io/v1]

Description

CertificateSigningRequestList is a collection of CertificateSigningRequest objects

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CertificateSigningRequest certificates.k8s.io/v1)

items is a collection of CertificateSigningRequest objects

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

CinderPersistentVolumeSource [core/v1]

Description

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.

Type

object

Required

  • volumeID

Specification

Property Type 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://examples.k8s.io/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://examples.k8s.io/mysql-cinder-pd/README.md

.secretRef

SecretReference core/v1

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://examples.k8s.io/mysql-cinder-pd/README.md

CinderVolumeSource [core/v1]

Description

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.

Type

object

Required

  • volumeID

Specification

Property Type 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://examples.k8s.io/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://examples.k8s.io/mysql-cinder-pd/README.md

.secretRef

LocalObjectReference core/v1

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://examples.k8s.io/mysql-cinder-pd/README.md

ClientIPConfig [core/v1]

Description

ClientIPConfig represents the configurations of Client IP based session affinity.

Type

object

Specification

Property Type Description

.timeoutSeconds

integer

timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && ⇐86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

CloudCredentialList [operator.openshift.io/v1]

Description

CloudCredentialList is a list of CloudCredential

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CloudCredential operator.openshift.io/v1)

List of cloudcredentials. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterAutoscalerList [autoscaling.openshift.io/v1]

Description

ClusterAutoscalerList is a list of ClusterAutoscaler

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterAutoscaler autoscaling.openshift.io/v1)

List of clusterautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterCSIDriverList [operator.openshift.io/v1]

Description

ClusterCSIDriverList is a list of ClusterCSIDriver

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterCSIDriver operator.openshift.io/v1)

List of clustercsidrivers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterNetworkList [network.openshift.io/v1]

Description

ClusterNetworkList is a list of ClusterNetwork

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterNetwork network.openshift.io/v1)

List of clusternetworks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterOperatorList [config.openshift.io/v1]

Description

ClusterOperatorList is a list of ClusterOperator

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterOperator config.openshift.io/v1)

List of clusteroperators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterResourceQuotaList [quota.openshift.io/v1]

Description

ClusterResourceQuotaList is a list of ClusterResourceQuota

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterResourceQuota quota.openshift.io/v1)

List of clusterresourcequotas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterRoleBindingList [authorization.openshift.io/v1]

Description

ClusterRoleBindingList is a collection of ClusterRoleBindings

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterRoleBinding authorization.openshift.io/v1)

Items is a list of ClusterRoleBindings

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ClusterRoleBindingList [rbac.authorization.k8s.io/v1]

Description

ClusterRoleBindingList is a collection of ClusterRoleBindings

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterRoleBinding rbac.authorization.k8s.io/v1)

Items is a list of ClusterRoleBindings

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard object’s metadata.

ClusterRoleList [authorization.openshift.io/v1]

Description

ClusterRoleList is a collection of ClusterRoles

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterRole authorization.openshift.io/v1)

Items is a list of ClusterRoles

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ClusterRoleList [rbac.authorization.k8s.io/v1]

Description

ClusterRoleList is a collection of ClusterRoles

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterRole rbac.authorization.k8s.io/v1)

Items is a list of ClusterRoles

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard object’s metadata.

ClusterServiceVersionList [operators.coreos.com/v1alpha1]

Description

ClusterServiceVersionList is a list of ClusterServiceVersion

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterServiceVersion operators.coreos.com/v1alpha1)

List of clusterserviceversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ClusterVersionList [config.openshift.io/v1]

Description

ClusterVersionList is a list of ClusterVersion

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ClusterVersion config.openshift.io/v1)

List of clusterversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ComponentCondition [core/v1]

Description

Information about the condition of a component.

Type

object

Required

  • type

  • status

Specification

Property Type Description

.error

string

Condition error code for a component. For example, a health check error code.

.message

string

Message about the condition for a component. For example, information about a health check.

.status

string

Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

.type

string

Type of condition for a component. Valid value: "Healthy"

ComponentStatusList [core/v1]

Description

Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ComponentStatus core/v1)

List of ComponentStatus objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConfigList [imageregistry.operator.openshift.io/v1]

Description

ConfigList is a list of Config

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Config imageregistry.operator.openshift.io/v1)

List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConfigList [operator.openshift.io/v1]

Description

ConfigList is a list of Config

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Config operator.openshift.io/v1)

List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConfigList [samples.operator.openshift.io/v1]

Description

ConfigList is a list of Config

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Config samples.operator.openshift.io/v1)

List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConfigMapEnvSource [core/v1]

Description

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.

Type

object

Specification

Property Type 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 [core/v1]

Description

Selects a key from a ConfigMap.

Type

object

Required

  • key

Specification

Property Type 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 its key must be defined

ConfigMapList [core/v1]

Description

ConfigMapList is a resource containing a list of ConfigMap objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConfigMap core/v1)

Items is the list of ConfigMaps.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

ConfigMapNodeConfigSource [core/v1]

Description

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

Type

object

Required

  • namespace

  • name

  • kubeletConfigKey

Specification

Property Type Description

.kubeletConfigKey

string

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

.name

string

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

.namespace

string

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

.resourceVersion

string

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.uid

string

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

ConfigMapProjection [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.items

array (KeyToPath core/v1)

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 its keys must be defined

ConfigMapVolumeSource [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.defaultMode

integer

Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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

array (KeyToPath core/v1)

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 its keys must be defined

ConsoleCLIDownloadList [console.openshift.io/v1]

Description

ConsoleCLIDownloadList is a list of ConsoleCLIDownload

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConsoleCLIDownload console.openshift.io/v1)

List of consoleclidownloads. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Description

ConsoleExternalLogLinkList is a list of ConsoleExternalLogLink

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConsoleExternalLogLink console.openshift.io/v1)

List of consoleexternalloglinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Description

ConsoleLinkList is a list of ConsoleLink

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConsoleLink console.openshift.io/v1)

List of consolelinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConsoleList [config.openshift.io/v1]

Description

ConsoleList is a list of Console

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Console config.openshift.io/v1)

List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConsoleList [operator.openshift.io/v1]

Description

ConsoleList is a list of Console

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Console operator.openshift.io/v1)

List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConsoleNotificationList [console.openshift.io/v1]

Description

ConsoleNotificationList is a list of ConsoleNotification

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConsoleNotification console.openshift.io/v1)

List of consolenotifications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ConsoleYAMLSampleList [console.openshift.io/v1]

Description

ConsoleYAMLSampleList is a list of ConsoleYAMLSample

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ConsoleYAMLSample console.openshift.io/v1)

List of consoleyamlsamples. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Container [core/v1]

Description

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

Type

object

Required

  • name

Specification

Property Type Description

.args

array (string)

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

array (string)

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

array (EnvVar core/v1)

List of environment variables to set in the container. Cannot be updated.

.envFrom

array (EnvFromSource core/v1)

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 core/v1

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

.livenessProbe

Probe core/v1

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

array (ContainerPort core/v1)

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 core/v1

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 core/v1

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

.securityContext

SecurityContext core/v1

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/

.startupProbe

Probe core/v1

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

.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

array (VolumeDevice core/v1)

volumeDevices is the list of block devices to be used by the container.

.volumeMounts

array (VolumeMount core/v1)

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.

ContainerImage [core/v1]

Description

Describe a container image

Type

object

Required

  • names

Specification

Property Type Description

.names

array (string)

Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

.sizeBytes

integer

The size of the image in bytes.

ContainerPort [core/v1]

Description

ContainerPort represents a network port in a single container.

Type

object

Required

  • containerPort

Specification

Property Type 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".

ContainerRuntimeConfigList [machineconfiguration.openshift.io/v1]

Description

ContainerRuntimeConfigList is a list of ContainerRuntimeConfig

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ContainerRuntimeConfig machineconfiguration.openshift.io/v1)

List of containerruntimeconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ContainerState [core/v1]

Description

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

Type

object

Specification

Property Type Description

.running

ContainerStateRunning core/v1

Details about a running container

.terminated

ContainerStateTerminated core/v1

Details about a terminated container

.waiting

ContainerStateWaiting core/v1

Details about a waiting container

ContainerStateRunning [core/v1]

Description

ContainerStateRunning is a running state of a container.

Type

object

Specification

Property Type Description

.startedAt

Time meta/v1

Time at which the container was last (re-)started

ContainerStateTerminated [core/v1]

Description

ContainerStateTerminated is a terminated state of a container.

Type

object

Required

  • exitCode

Specification

Property Type Description

.containerID

string

Container’s ID in the format 'docker://<container_id>'

.exitCode

integer

Exit status from the last termination of the container

.finishedAt

Time meta/v1

Time at which the container last terminated

.message

string

Message regarding the last termination of the container

.reason

string

(brief) reason from the last termination of the container

.signal

integer

Signal from the last termination of the container

.startedAt

Time meta/v1

Time at which previous execution of the container started

ContainerStateWaiting [core/v1]

Description

ContainerStateWaiting is a waiting state of a container.

Type

object

Specification

Property Type Description

.message

string

Message regarding why the container is not yet running.

.reason

string

(brief) reason the container is not yet running.

ControllerConfigList [machineconfiguration.openshift.io/v1]

Description

ControllerConfigList is a list of ControllerConfig

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ControllerConfig machineconfiguration.openshift.io/v1)

List of controllerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ControllerRevisionList [apps/v1]

Description

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ControllerRevision apps/v1)

Items is the list of ControllerRevisions

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

CredentialsRequestList [cloudcredential.openshift.io/v1]

Description

CredentialsRequestList is a list of CredentialsRequest

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CredentialsRequest cloudcredential.openshift.io/v1)

List of credentialsrequests. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

CronJobList [batch/v1beta1]

Description

CronJobList is a collection of cron jobs.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CronJob batch/v1beta1)

items is the list of CronJobs.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

CSIDriverList [storage.k8s.io/v1]

Description

CSIDriverList is a collection of CSIDriver objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CSIDriver storage.k8s.io/v1)

items is the list of CSIDriver

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

CSINodeList [storage.k8s.io/v1]

Description

CSINodeList is a collection of CSINode objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CSINode storage.k8s.io/v1)

items is the list of CSINode

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

CSIPersistentVolumeSource [core/v1]

Description

Represents storage that is managed by an external CSI volume driver (Beta feature)

Type

object

Required

  • driver

  • volumeHandle

Specification

Property Type Description

.controllerExpandSecretRef

SecretReference core/v1

ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

.controllerPublishSecretRef

SecretReference core/v1

ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

.driver

string

Driver is the name of the driver to use for this volume. Required.

.fsType

string

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".

.nodePublishSecretRef

SecretReference core/v1

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

.nodeStageSecretRef

SecretReference core/v1

NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

.readOnly

boolean

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).

.volumeAttributes

object (string)

Attributes of the volume to publish.

.volumeHandle

string

VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

CSISnapshotControllerList [operator.openshift.io/v1]

Description

CSISnapshotControllerList is a list of CSISnapshotController

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CSISnapshotController operator.openshift.io/v1)

List of csisnapshotcontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

CSIVolumeSource [core/v1]

Description

Represents a source location of a volume to mount, managed by an external CSI driver

Type

object

Required

  • driver

Specification

Property Type Description

.driver

string

Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

.fsType

string

Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

.nodePublishSecretRef

LocalObjectReference core/v1

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

.readOnly

boolean

Specifies a read-only configuration for the volume. Defaults to false (read/write).

.volumeAttributes

object (string)

VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

CustomResourceDefinitionList [apiextensions.k8s.io/v1]

Description

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (CustomResourceDefinition apiextensions.k8s.io/v1)

items list individual CustomResourceDefinition objects

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

DaemonEndpoint [core/v1]

Description

DaemonEndpoint contains information about a single Daemon endpoint.

Type

object

Required

  • Port

Specification

Property Type Description

.Port

integer

Port number of the given endpoint.

DaemonSetList [apps/v1]

Description

DaemonSetList is a collection of daemon sets.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (DaemonSet apps/v1)

A list of daemon sets.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

DeleteOptions [meta/v1]

Description

DeleteOptions may be provided when deleting an API object.

Type

object

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.dryRun

array (string)

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

.gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

.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/sig-architecture/api-conventions.md#types-kinds

.orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

.preconditions

Preconditions meta/v1

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

.propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

DeploymentConfigList [apps.openshift.io/v1]

Description

DeploymentConfigList is a collection of deployment configs.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (DeploymentConfig apps.openshift.io/v1)

Items is a list of deployment configs

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

DeploymentConfigRollback [apps.openshift.io/v1]

Description

DeploymentConfigRollback provides the input to rollback generation.

Type

object

Required

  • name

  • spec

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

.name

string

Name of the deployment config that will be rolled back.

.spec

DeploymentConfigRollbackSpec apps.openshift.io/v1

Spec defines the options to rollback generation.

.updatedAnnotations

object (string)

UpdatedAnnotations is a set of new annotations that will be added in the deployment config.

DeploymentList [apps/v1]

Description

DeploymentList is a list of Deployments.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Deployment apps/v1)

Items is the list of Deployments.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata.

DeploymentLog [apps.openshift.io/v1]

Description

DeploymentLog represents the logs for a deployment

Type

object

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

DeploymentRequest [apps.openshift.io/v1]

Description

DeploymentRequest is a request to a deployment config for a new deployment.

Type

object

Required

  • name

  • latest

  • force

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.excludeTriggers

array (string)

ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified.

.force

boolean

Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error.

.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/sig-architecture/api-conventions.md#types-kinds

.latest

boolean

Latest will update the deployment config with the latest state from all triggers.

.name

string

Name of the deployment config for requesting a new deployment.

DNSList [config.openshift.io/v1]

Description

DNSList is a list of DNS

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (DNS config.openshift.io/v1)

List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

DNSList [operator.openshift.io/v1]

Description

DNSList is a list of DNS

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (DNS operator.openshift.io/v1)

List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

DNSRecordList [ingress.operator.openshift.io/v1]

Description

DNSRecordList is a list of DNSRecord

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (DNSRecord ingress.operator.openshift.io/v1)

List of dnsrecords. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

DownwardAPIProjection [core/v1]

Description

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

Type

object

Specification

Property Type Description

.items

array (DownwardAPIVolumeFile core/v1)

Items is a list of DownwardAPIVolume file

DownwardAPIVolumeFile [core/v1]

Description

DownwardAPIVolumeFile represents information to create the file containing the pod field

Type

object

Required

  • path

Specification

Property Type Description

.fieldRef

ObjectFieldSelector core/v1

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

.mode

integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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 core/v1

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

DownwardAPIVolumeSource [core/v1]

Description

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

Type

object

Specification

Property Type Description

.defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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

array (DownwardAPIVolumeFile core/v1)

Items is a list of downward API volume file

EgressNetworkPolicyList [network.openshift.io/v1]

Description

EgressNetworkPolicyList is a list of EgressNetworkPolicy

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (EgressNetworkPolicy network.openshift.io/v1)

List of egressnetworkpolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

EmptyDirVolumeSource [core/v1]

Description

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

Type

object

Specification

Property Type 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 api/resource

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

EndpointAddress [core/v1]

Description

EndpointAddress is a tuple that describes single IP address.

Type

object

Required

  • ip

Specification

Property Type Description

.hostname

string

The Hostname of this endpoint

.ip

string

The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.

.nodeName

string

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

.targetRef

ObjectReference core/v1

Reference to object providing the endpoint.

EndpointPort [core/v1]

Description

EndpointPort is a tuple that describes a single port.

Type

object

Required

  • port

Specification

Property Type Description

.appProtocol

string

The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.

.name

string

The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.

.port

integer

The port number of the endpoint.

.protocol

string

The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

EndpointSliceList [discovery.k8s.io/v1beta1]

Description

EndpointSliceList represents a list of endpoint slices

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (EndpointSlice discovery.k8s.io/v1beta1)

List of endpoint slices

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata.

EndpointsList [core/v1]

Description

EndpointsList is a list of endpoints.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Endpoints core/v1)

List of endpoints.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

EndpointSubset [core/v1]

Description

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Type

object

Specification

Property Type Description

.addresses

array (EndpointAddress core/v1)

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

.notReadyAddresses

array (EndpointAddress core/v1)

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

.ports

array (EndpointPort core/v1)

Port numbers available on the related IP addresses.

EnvFromSource [core/v1]

Description

EnvFromSource represents the source of a set of ConfigMaps

Type

object

Specification

Property Type Description

.configMapRef

ConfigMapEnvSource core/v1

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 core/v1

The Secret to select from

EnvVar [core/v1]

Description

EnvVar represents an environment variable present in a Container.

Type

object

Required

  • name

Specification

Property Type 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 core/v1

Source for the environment variable’s value. Cannot be used if value is not empty.

EnvVarSource [core/v1]

Description

EnvVarSource represents a source for the value of an EnvVar.

Type

object

Specification

Property Type Description

.configMapKeyRef

ConfigMapKeySelector core/v1

Selects a key of a ConfigMap.

.fieldRef

ObjectFieldSelector core/v1

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

.resourceFieldRef

ResourceFieldSelector core/v1

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 core/v1

Selects a key of a secret in the pod’s namespace

EphemeralContainer [core/v1]

Description

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod’s ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

Type

object

Required

  • name

Specification

Property Type Description

.args

array (string)

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

array (string)

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

array (EnvVar core/v1)

List of environment variables to set in the container. Cannot be updated.

.envFrom

array (EnvFromSource core/v1)

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

.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 core/v1

Lifecycle is not allowed for ephemeral containers.

.livenessProbe

Probe core/v1

Probes are not allowed for ephemeral containers.

.name

string

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

.ports

array (ContainerPort core/v1)

Ports are not allowed for ephemeral containers.

.readinessProbe

Probe core/v1

Probes are not allowed for ephemeral containers.

.resources

ResourceRequirements core/v1

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

.securityContext

SecurityContext core/v1

SecurityContext is not allowed for ephemeral containers.

.startupProbe

Probe core/v1

Probes are not allowed for ephemeral containers.

.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

.targetContainerName

string

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.

.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

array (VolumeDevice core/v1)

volumeDevices is the list of block devices to be used by the container.

.volumeMounts

array (VolumeMount core/v1)

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.

EphemeralVolumeSource [core/v1]

Description

Represents an ephemeral volume that is handled by a normal storage driver.

Type

object

Specification

Property Type Description

.readOnly

boolean

Specifies a read-only configuration for the volume. Defaults to false (read/write).

.volumeClaimTemplate

PersistentVolumeClaimTemplate core/v1

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

EtcdList [operator.openshift.io/v1]

Description

EtcdList is a list of Etcd

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Etcd operator.openshift.io/v1)

List of etcds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

EventList [core/v1]

Description

EventList is a list of events.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Event core/v1)

List of events

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

EventList [events.k8s.io/v1]

Description

EventList is a list of Event objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Event events.k8s.io/v1)

items is a list of schema objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

EventSeries [core/v1]

Description

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Type

object

Specification

Property Type Description

.count

integer

Number of occurrences in this series up to the last heartbeat time

.lastObservedTime

MicroTime meta/v1

Time of the last occurrence observed

EventSource [core/v1]

Description

EventSource contains information for an event.

Type

object

Specification

Property Type Description

.component

string

Component from which the event is generated.

.host

string

Node name on which the event is generated.

Eviction [policy/v1beta1]

Description

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …​/pods/<pod name>/evictions.

Type

object

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.deleteOptions

DeleteOptions meta/v1

DeleteOptions may be provided

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

ObjectMeta describes the pod that is being evicted.

ExecAction [core/v1]

Description

ExecAction describes a "run in container" action.

Type

object

Specification

Property Type Description

.command

array (string)

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.

FCVolumeSource [core/v1]

Description

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.

Type

object

Specification

Property Type 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

array (string)

Optional: FC target worldwide names (WWNs)

.wwids

array (string)

Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

FeatureGateList [config.openshift.io/v1]

Description

FeatureGateList is a list of FeatureGate

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (FeatureGate config.openshift.io/v1)

List of featuregates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

FieldsV1 [meta/v1]

Description

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item’s key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

The exact format is defined in sigs.k8s.io/structured-merge-diff

Type

object

FlexPersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • driver

Specification

Property Type 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 (string)

Optional: Extra command options if any.

.readOnly

boolean

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

.secretRef

SecretReference core/v1

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.

FlexVolumeSource [core/v1]

Description

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

Type

object

Required

  • driver

Specification

Property Type 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 (string)

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 core/v1

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 [core/v1]

Description

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.

Type

object

Specification

Property Type 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

FlowSchemaList [flowcontrol.apiserver.k8s.io/v1alpha1]

Description

FlowSchemaList is a list of FlowSchema objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (FlowSchema flowcontrol.apiserver.k8s.io/v1alpha1)

items is a list of FlowSchemas.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

metadata is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

GCEPersistentDiskVolumeSource [core/v1]

Description

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.

Type

object

Required

  • pdName

Specification

Property Type 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 [core/v1]

Description

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.

Type

object

Required

  • repository

Specification

Property Type 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.

GlusterfsPersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • endpoints

  • path

Specification

Property Type Description

.endpoints

string

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

.endpointsNamespace

string

EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

.path

string

Path is the Glusterfs volume path. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

GlusterfsVolumeSource [core/v1]

Description

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

Type

object

Required

  • endpoints

  • path

Specification

Property Type Description

.endpoints

string

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

.path

string

Path is the Glusterfs volume path. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

GroupList [user.openshift.io/v1]

Description

GroupList is a collection of Groups

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Group user.openshift.io/v1)

Items is the list of groups

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

GroupVersionKind [meta/v1]

Description

GroupVersionKind unambiguously identifies a kind. It doesn’t anonymously include GroupVersion to avoid automatic coersion. It doesn’t use a GroupVersion to avoid custom marshalling

Type

object

Required

  • group

  • version

  • kind

Specification

Property Type Description

.group

string

.kind

string

.version

string

Handler [core/v1]

Description

Handler defines a specific action that should be taken

Type

object

Specification

Property Type Description

.exec

ExecAction core/v1

One and only one of the following should be specified. Exec specifies the action to take.

.httpGet

HTTPGetAction core/v1

HTTPGet specifies the http request to perform.

.tcpSocket

TCPSocketAction core/v1

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

HelmChartRepositoryList [helm.openshift.io/v1beta1]

Description

HelmChartRepositoryList is a list of HelmChartRepository

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (HelmChartRepository helm.openshift.io/v1beta1)

List of helmchartrepositories. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

HorizontalPodAutoscalerList [autoscaling/v1]

Description

list of horizontal pod autoscaler objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (HorizontalPodAutoscaler autoscaling/v1)

list of horizontal pod autoscaler objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata.

HostAlias [core/v1]

Description

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

Type

object

Specification

Property Type Description

.hostnames

array (string)

Hostnames for the above IP address.

.ip

string

IP address of the host file entry.

HostPathVolumeSource [core/v1]

Description

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

Type

object

Required

  • path

Specification

Property Type 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

HostSubnetList [network.openshift.io/v1]

Description

HostSubnetList is a list of HostSubnet

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (HostSubnet network.openshift.io/v1)

List of hostsubnets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

HTTPGetAction [core/v1]

Description

HTTPGetAction describes an action based on HTTP Get requests.

Type

object

Required

  • port

Specification

Property Type Description

.host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

.httpHeaders

array (HTTPHeader core/v1)

Custom headers to set in the request. HTTP allows repeated headers.

.path

string

Path to access on the HTTP server.

.port

IntOrString util/intstr

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 [core/v1]

Description

HTTPHeader describes a custom header to be used in HTTP probes

Type

object

Required

  • name

  • value

Specification

Property Type Description

.name

string

The header field name

.value

string

The header field value

IdentityList [user.openshift.io/v1]

Description

IdentityList is a collection of Identities

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Identity user.openshift.io/v1)

Items is the list of identities

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ImageContentSourcePolicyList [operator.openshift.io/v1alpha1]

Description

ImageContentSourcePolicyList is a list of ImageContentSourcePolicy

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ImageContentSourcePolicy operator.openshift.io/v1alpha1)

List of imagecontentsourcepolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ImageList [config.openshift.io/v1]

Description

ImageList is a list of Image

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Image config.openshift.io/v1)

List of images. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ImageList [image.openshift.io/v1]

Description

ImageList is a list of Image objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Image image.openshift.io/v1)

Items is a list of images

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ImagePrunerList [imageregistry.operator.openshift.io/v1]

Description

ImagePrunerList is a list of ImagePruner

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ImagePruner imageregistry.operator.openshift.io/v1)

List of imagepruners. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ImageStreamLayers [image.openshift.io/v1]

Description

ImageStreamLayers describes information about the layers referenced by images in this image stream.

Type

object

Required

  • blobs

  • images

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.blobs

object (ImageLayerData image.openshift.io/v1)

blobs is a map of blob name to metadata about the blob.

.images

object (ImageBlobReferences image.openshift.io/v1)

images is a map between an image name and the names of the blobs and config that comprise the image.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

ImageStreamList [image.openshift.io/v1]

Description

ImageStreamList is a list of ImageStream objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ImageStream image.openshift.io/v1)

Items is a list of imageStreams

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ImageStreamTagList [image.openshift.io/v1]

Description

ImageStreamTagList is a list of ImageStreamTag objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ImageStreamTag image.openshift.io/v1)

Items is the list of image stream tags

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ImageTagList [image.openshift.io/v1]

Description

ImageTagList is a list of ImageTag objects. When listing image tags, the image field is not populated. Tags are returned in alphabetical order by image stream and then tag.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ImageTag image.openshift.io/v1)

Items is the list of image stream tags

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

InfrastructureList [config.openshift.io/v1]

Description

InfrastructureList is a list of Infrastructure

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Infrastructure config.openshift.io/v1)

List of infrastructures. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

IngressClassList [networking.k8s.io/v1]

Description

IngressClassList is a collection of IngressClasses.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (IngressClass networking.k8s.io/v1)

Items is the list of IngressClasses.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata.

IngressControllerList [operator.openshift.io/v1]

Description

IngressControllerList is a list of IngressController

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (IngressController operator.openshift.io/v1)

List of ingresscontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

IngressList [config.openshift.io/v1]

Description

IngressList is a list of Ingress

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Ingress config.openshift.io/v1)

List of ingresses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

IngressList [networking.k8s.io/v1]

Description

IngressList is a collection of Ingress.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Ingress networking.k8s.io/v1)

Items is the list of Ingress.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

InstallPlanList [operators.coreos.com/v1alpha1]

Description

InstallPlanList is a list of InstallPlan

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (InstallPlan operators.coreos.com/v1alpha1)

List of installplans. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

IntOrString [util/intstr]

Description

IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.

Type

string

IPPoolList [whereabouts.cni.cncf.io/v1alpha1]

Description

IPPoolList is a list of IPPool

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (IPPool whereabouts.cni.cncf.io/v1alpha1)

List of ippools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ISCSIPersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • targetPortal

  • iqn

  • lun

Specification

Property Type 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

array (string)

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

SecretReference core/v1

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).

ISCSIVolumeSource [core/v1]

Description

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

Type

object

Required

  • targetPortal

  • iqn

  • lun

Specification

Property Type 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

array (string)

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 core/v1

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).

JobList [batch/v1]

Description

JobList is a collection of jobs.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Job batch/v1)

items is the list of Jobs.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

KeyToPath [core/v1]

Description

Maps a string key to a path within a volume.

Type

object

Required

  • key

  • path

Specification

Property Type Description

.key

string

The key to project.

.mode

integer

Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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 '..'.

KubeAPIServerList [operator.openshift.io/v1]

Description

KubeAPIServerList is a list of KubeAPIServer

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (KubeAPIServer operator.openshift.io/v1)

List of kubeapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

KubeControllerManagerList [operator.openshift.io/v1]

Description

KubeControllerManagerList is a list of KubeControllerManager

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (KubeControllerManager operator.openshift.io/v1)

List of kubecontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

KubeletConfigList [machineconfiguration.openshift.io/v1]

Description

KubeletConfigList is a list of KubeletConfig

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (KubeletConfig machineconfiguration.openshift.io/v1)

List of kubeletconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

KubeSchedulerList [operator.openshift.io/v1]

Description

KubeSchedulerList is a list of KubeScheduler

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (KubeScheduler operator.openshift.io/v1)

List of kubeschedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

KubeStorageVersionMigratorList [operator.openshift.io/v1]

Description

KubeStorageVersionMigratorList is a list of KubeStorageVersionMigrator

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (KubeStorageVersionMigrator operator.openshift.io/v1)

List of kubestorageversionmigrators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

LabelSelector [meta/v1]

Description

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.

Type

object

Specification

Property Type Description

.matchExpressions

array (LabelSelectorRequirement meta/v1)

matchExpressions is a list of label selector requirements. The requirements are ANDed.

.matchLabels

object (string)

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 [meta/v1]

Description

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

Type

object

Required

  • key

  • operator

Specification

Property Type Description

.key

string

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

array (string)

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.

LeaseList [coordination.k8s.io/v1]

Description

LeaseList is a list of Lease objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Lease coordination.k8s.io/v1)

Items is a list of schema objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Lifecycle [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.postStart

Handler core/v1

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 core/v1

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

LimitRangeItem [core/v1]

Description

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Type

object

Required

  • type

Specification

Property Type Description

.default

object (Quantity api/resource)

Default resource requirement limit value by resource name if resource limit is omitted.

.defaultRequest

object (Quantity api/resource)

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

.max

object (Quantity api/resource)

Max usage constraints on this kind by resource name.

.maxLimitRequestRatio

object (Quantity api/resource)

MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.

.min

object (Quantity api/resource)

Min usage constraints on this kind by resource name.

.type

string

Type of resource that this limit applies to.

LimitRangeList [core/v1]

Description

LimitRangeList is a list of LimitRange items.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (LimitRange core/v1)

Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ListMeta [meta/v1]

Description

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

Type

object

Specification

Property Type 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.

.remainingItemCount

integer

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

.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/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.selfLink

string

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

LoadBalancerIngress [core/v1]

Description

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Type

object

Specification

Property Type Description

.hostname

string

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

.ip

string

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

LoadBalancerStatus [core/v1]

Description

LoadBalancerStatus represents the status of a load-balancer.

Type

object

Specification

Property Type Description

.ingress

array (LoadBalancerIngress core/v1)

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

LocalObjectReference [core/v1]

Description

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

Type

object

Specification

Property Type Description

.name

string

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

LocalVolumeSource [core/v1]

Description

Local represents directly-attached storage with node affinity (Beta feature)

Type

object

Required

  • path

Specification

Property Type Description

.fsType

string

Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.

.path

string

The full path to the volume on the node. It can be either a directory or block device (disk, partition, …​).

MachineAutoscalerList [autoscaling.openshift.io/v1beta1]

Description

MachineAutoscalerList is a list of MachineAutoscaler

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MachineAutoscaler autoscaling.openshift.io/v1beta1)

List of machineautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

MachineConfigList [machineconfiguration.openshift.io/v1]

Description

MachineConfigList is a list of MachineConfig

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MachineConfig machineconfiguration.openshift.io/v1)

List of machineconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

MachineConfigPoolList [machineconfiguration.openshift.io/v1]

Description

MachineConfigPoolList is a list of MachineConfigPool

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MachineConfigPool machineconfiguration.openshift.io/v1)

List of machineconfigpools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

MachineHealthCheckList [machine.openshift.io/v1beta1]

Description

MachineHealthCheckList is a list of MachineHealthCheck

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MachineHealthCheck machine.openshift.io/v1beta1)

List of machinehealthchecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

MachineList [machine.openshift.io/v1beta1]

Description

MachineList is a list of Machine

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Machine machine.openshift.io/v1beta1)

List of machines. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

MachineSetList [machine.openshift.io/v1beta1]

Description

MachineSetList is a list of MachineSet

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MachineSet machine.openshift.io/v1beta1)

List of machinesets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ManagedFieldsEntry [meta/v1]

Description

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type

object

Specification

Property Type Description

.apiVersion

string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

.fieldsType

string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

.fieldsV1

FieldsV1 meta/v1

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

.manager

string

Manager is an identifier of the workflow managing these fields.

.operation

string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

.time

Time meta/v1

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

MicroTime [meta/v1]

Description

MicroTime is version of Time with microsecond level precision.

Type

string

MutatingWebhookConfigurationList [admissionregistration.k8s.io/v1]

Description

MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (MutatingWebhookConfiguration admissionregistration.k8s.io/v1)

List of MutatingWebhookConfiguration.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NamespaceCondition [core/v1]

Description

NamespaceCondition contains details about state of namespace.

Type

object

Required

  • type

  • status

Specification

Property Type Description

.lastTransitionTime

Time meta/v1

.message

string

.reason

string

.status

string

Status of the condition, one of True, False, Unknown.

.type

string

Type of namespace controller condition.

NamespaceList [core/v1]

Description

NamespaceList is a list of Namespaces.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Namespace core/v1)

Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NetNamespaceList [network.openshift.io/v1]

Description

NetNamespaceList is a list of NetNamespace

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (NetNamespace network.openshift.io/v1)

List of netnamespaces. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NetworkAttachmentDefinitionList [k8s.cni.cncf.io/v1]

Description

NetworkAttachmentDefinitionList is a list of NetworkAttachmentDefinition

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (NetworkAttachmentDefinition k8s.cni.cncf.io/v1)

List of network-attachment-definitions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NetworkList [config.openshift.io/v1]

Description

NetworkList is a list of Network

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Network config.openshift.io/v1)

List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NetworkList [operator.openshift.io/v1]

Description

NetworkList is a list of Network

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Network operator.openshift.io/v1)

List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NetworkPolicyList [networking.k8s.io/v1]

Description

NetworkPolicyList is a list of NetworkPolicy objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (NetworkPolicy networking.k8s.io/v1)

Items is a list of schema objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

NFSVolumeSource [core/v1]

Description

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

Type

object

Required

  • server

  • path

Specification

Property Type 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

NodeAddress [core/v1]

Description

NodeAddress contains information for the node’s address.

Type

object

Required

  • type

  • address

Specification

Property Type Description

.address

string

The node address.

.type

string

Node address type, one of Hostname, ExternalIP or InternalIP.

NodeAffinity [core/v1]

Description

Node affinity is a group of node affinity scheduling rules.

Type

object

Specification

Property Type Description

.preferredDuringSchedulingIgnoredDuringExecution

array (PreferredSchedulingTerm core/v1)

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 core/v1

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.

NodeCondition [core/v1]

Description

NodeCondition contains condition information for a node.

Type

object

Required

  • type

  • status

Specification

Property Type Description

.lastHeartbeatTime

Time meta/v1

Last time we got an update on a given condition.

.lastTransitionTime

Time meta/v1

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 node condition.

NodeConfigSource [core/v1]

Description

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

Type

object

Specification

Property Type Description

.configMap

ConfigMapNodeConfigSource core/v1

ConfigMap is a reference to a Node’s ConfigMap

NodeDaemonEndpoints [core/v1]

Description

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Type

object

Specification

Property Type Description

.kubeletEndpoint

DaemonEndpoint core/v1

Endpoint on which Kubelet is listening.

NodeList [core/v1]

Description

NodeList is the whole list of all Nodes which have been registered with master.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Node core/v1)

List of nodes

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

NodeSelector [core/v1]

Description

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.

Type

object

Required

  • nodeSelectorTerms

Specification

Property Type Description

.nodeSelectorTerms

array (NodeSelectorTerm core/v1)

Required. A list of node selector terms. The terms are ORed.

NodeSelectorRequirement [core/v1]

Description

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

Type

object

Required

  • key

  • operator

Specification

Property Type 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

array (string)

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 [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.matchExpressions

array (NodeSelectorRequirement core/v1)

A list of node selector requirements by node’s labels.

.matchFields

array (NodeSelectorRequirement core/v1)

A list of node selector requirements by node’s fields.

NodeSystemInfo [core/v1]

Description

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Type

object

Required

  • machineID

  • systemUUID

  • bootID

  • kernelVersion

  • osImage

  • containerRuntimeVersion

  • kubeletVersion

  • kubeProxyVersion

  • operatingSystem

  • architecture

Specification

Property Type Description

.architecture

string

The Architecture reported by the node

.bootID

string

Boot ID reported by the node.

.containerRuntimeVersion

string

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

.kernelVersion

string

Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

.kubeProxyVersion

string

KubeProxy Version reported by the node.

.kubeletVersion

string

Kubelet Version reported by the node.

.machineID

string

MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html

.operatingSystem

string

The Operating System reported by the node

.osImage

string

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

.systemUUID

string

SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

OAuthAccessTokenList [oauth.openshift.io/v1]

Description

OAuthAccessTokenList is a collection of OAuth access tokens

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OAuthAccessToken oauth.openshift.io/v1)

Items is the list of OAuth access tokens

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

OAuthAuthorizeTokenList [oauth.openshift.io/v1]

Description

OAuthAuthorizeTokenList is a collection of OAuth authorization tokens

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OAuthAuthorizeToken oauth.openshift.io/v1)

Items is the list of OAuth authorization tokens

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

OAuthClientAuthorizationList [oauth.openshift.io/v1]

Description

OAuthClientAuthorizationList is a collection of OAuth client authorizations

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OAuthClientAuthorization oauth.openshift.io/v1)

Items is the list of OAuth client authorizations

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

OAuthClientList [oauth.openshift.io/v1]

Description

OAuthClientList is a collection of OAuth clients

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OAuthClient oauth.openshift.io/v1)

Items is the list of OAuth clients

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

OAuthList [config.openshift.io/v1]

Description

OAuthList is a list of OAuth

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OAuth config.openshift.io/v1)

List of oauths. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ObjectFieldSelector [core/v1]

Description

ObjectFieldSelector selects an APIVersioned field of an object.

Type

object

Required

  • fieldPath

Specification

Property Type 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 [meta/v1]

Description

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

Type

object

Specification

Property Type Description

.annotations

object (string)

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 meta/v1

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/sig-architecture/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 meta/v1

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/sig-architecture/api-conventions.md#metadata

.finalizers

array (string)

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. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

.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/sig-architecture/api-conventions.md#idempotency

.generation

integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

.labels

object (string)

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

.managedFields

array (ManagedFieldsEntry meta/v1)

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

.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 which 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

array (OwnerReference meta/v1)

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/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.selfLink

string

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

.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

ObjectMeta_v2 [meta/v1]

Description

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

Type

object

Specification

Property Type Description

.annotations

object (string)

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 meta/v1

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/sig-architecture/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 meta/v1

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/sig-architecture/api-conventions.md#metadata

.finalizers

array (string)

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. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

.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/sig-architecture/api-conventions.md#idempotency

.generation

integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

.labels

object (string)

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

.managedFields

array (ManagedFieldsEntry meta/v1)

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

.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

array (OwnerReference meta/v1)

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/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.selfLink

string

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

.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

ObjectReference [core/v1]

Description

ObjectReference contains enough information to let you inspect or modify the referred object.

Type

object

Specification

Property Type Description

.apiVersion

string

API version of the referent.

.fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

.kind

string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.name

string

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

.namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

.resourceVersion

string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.uid

string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

OpenShiftAPIServerList [operator.openshift.io/v1]

Description

OpenShiftAPIServerList is a list of OpenShiftAPIServer

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OpenShiftAPIServer operator.openshift.io/v1)

List of openshiftapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OpenShiftControllerManagerList [operator.openshift.io/v1]

Description

OpenShiftControllerManagerList is a list of OpenShiftControllerManager

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OpenShiftControllerManager operator.openshift.io/v1)

List of openshiftcontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OperatorGroupList [operators.coreos.com/v1]

Description

OperatorGroupList is a list of OperatorGroup

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OperatorGroup operators.coreos.com/v1)

List of operatorgroups. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OperatorHubList [config.openshift.io/v1]

Description

OperatorHubList is a list of OperatorHub

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OperatorHub config.openshift.io/v1)

List of operatorhubs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OperatorPKIList [network.operator.openshift.io/v1]

Description

OperatorPKIList is a list of OperatorPKI

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (OperatorPKI network.operator.openshift.io/v1)

List of operatorpkis. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OwnerReference [meta/v1]

Description

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type

object

Required

  • apiVersion

  • kind

  • name

  • uid

Specification

Property Type 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/sig-architecture/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

PackageManifestList [packages.operators.coreos.com/v1]

Description

PackageManifestList is a list of PackageManifest objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PackageManifest packages.operators.coreos.com/v1)

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Patch [meta/v1]

Description

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Type

object

PersistentVolumeClaim [core/v1]

Description

PersistentVolumeClaim is a user’s request for and claim to a persistent volume

Type

object

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

object

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

.status

object

PersistentVolumeClaimStatus is the current status of a persistent volume claim.
.spec
Description

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Type

object

Property Type Description

accessModes

array (string)

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

TypedLocalObjectReference core/v1

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

resources

ResourceRequirements core/v1

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

LabelSelector meta/v1

A label query over volumes to consider for binding.

storageClassName

string

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

VolumeName is the binding reference to the PersistentVolume backing this claim.
.status
Description

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Type

object

Property Type Description

accessModes

array (string)

AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

capacity

object (Quantity api/resource)

Represents the actual resources of the underlying volume.

conditions

array (PersistentVolumeClaimCondition core/v1)

Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

phase

string

Phase represents the current phase of PersistentVolumeClaim.

PersistentVolumeClaimCondition [core/v1]

Description

PersistentVolumeClaimCondition contails details about state of pvc

Type

object

Required

  • type

  • status

Specification

Property Type Description

.lastProbeTime

Time meta/v1

Last time we probed the condition.

.lastTransitionTime

Time meta/v1

Last time the condition transitioned from one status to another.

.message

string

Human-readable message indicating details about last transition.

.reason

string

Unique, this should be a short, machine understandable string that gives the reason for condition’s last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.

.status

string

.type

string

PersistentVolumeClaimList [core/v1]

Description

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PersistentVolumeClaim core/v1)

A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PersistentVolumeClaimSpec [core/v1]

Description

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Type

object

Specification

Property Type Description

.accessModes

array (string)

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

.dataSource

TypedLocalObjectReference core/v1

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

.resources

ResourceRequirements core/v1

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

.selector

LabelSelector meta/v1

A label query over volumes to consider for binding.

.storageClassName

string

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

.volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

.volumeName

string

VolumeName is the binding reference to the PersistentVolume backing this claim.

PersistentVolumeClaimTemplate [core/v1]

Description

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Type

object

Required

  • spec

Specification

Property Type Description

.metadata

ObjectMeta meta/v1

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

.spec

PersistentVolumeClaimSpec core/v1

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

PersistentVolumeClaimVolumeSource [core/v1]

Description

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).

Type

object

Required

  • claimName

Specification

Property Type 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.

PersistentVolumeList [core/v1]

Description

PersistentVolumeList is a list of PersistentVolume items.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PersistentVolume core/v1)

List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PersistentVolumeSpec [core/v1]

Description

PersistentVolumeSpec is the specification of a persistent volume.

Type

object

Specification

Property Type Description

.accessModes

array (string)

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

.awsElasticBlockStore

AWSElasticBlockStoreVolumeSource core/v1

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 core/v1

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

.azureFile

AzureFilePersistentVolumeSource core/v1

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

.capacity

object (Quantity api/resource)

A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

.cephfs

CephFSPersistentVolumeSource core/v1

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

.cinder

CinderPersistentVolumeSource core/v1

Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

.claimRef

ObjectReference core/v1

ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

.csi

CSIPersistentVolumeSource core/v1

CSI represents storage that is handled by an external CSI driver (Beta feature).

.fc

FCVolumeSource core/v1

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

.flexVolume

FlexPersistentVolumeSource core/v1

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

.flocker

FlockerVolumeSource core/v1

Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running

.gcePersistentDisk

GCEPersistentDiskVolumeSource core/v1

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

.glusterfs

GlusterfsPersistentVolumeSource core/v1

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md

.hostPath

HostPathVolumeSource core/v1

HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

.iscsi

ISCSIPersistentVolumeSource core/v1

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin.

.local

LocalVolumeSource core/v1

Local represents directly-attached storage with node affinity

.mountOptions

array (string)

A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

.nfs

NFSVolumeSource core/v1

NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

.nodeAffinity

VolumeNodeAffinity core/v1

NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

.persistentVolumeReclaimPolicy

string

What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

.photonPersistentDisk

PhotonPersistentDiskVolumeSource core/v1

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

.portworxVolume

PortworxVolumeSource core/v1

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

.quobyte

QuobyteVolumeSource core/v1

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

.rbd

RBDPersistentVolumeSource core/v1

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

.scaleIO

ScaleIOPersistentVolumeSource core/v1

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

.storageClassName

string

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

.storageos

StorageOSPersistentVolumeSource core/v1

StorageOS represents a StorageOS volume that is attached to the kubelet’s host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md

.volumeMode

string

volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.

.vsphereVolume

VsphereVirtualDiskVolumeSource core/v1

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

PhotonPersistentDiskVolumeSource [core/v1]

Description

Represents a Photon Controller persistent disk resource.

Type

object

Required

  • pdID

Specification

Property Type 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

PodAffinity [core/v1]

Description

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

Type

object

Specification

Property Type Description

.preferredDuringSchedulingIgnoredDuringExecution

array (WeightedPodAffinityTerm core/v1)

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

array (PodAffinityTerm core/v1)

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 [core/v1]

Description

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

Type

object

Required

  • topologyKey

Specification

Property Type Description

.labelSelector

LabelSelector meta/v1

A label query over a set of resources, in this case pods.

.namespaces

array (string)

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 [core/v1]

Description

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

Type

object

Specification

Property Type Description

.preferredDuringSchedulingIgnoredDuringExecution

array (WeightedPodAffinityTerm core/v1)

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

array (PodAffinityTerm core/v1)

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.

PodCondition [core/v1]

Description

PodCondition contains details for the current condition of this pod.

Type

object

Required

  • type

  • status

Specification

Property Type Description

.lastProbeTime

Time meta/v1

Last time we probed the condition.

.lastTransitionTime

Time meta/v1

Last time the condition transitioned from one status to another.

.message

string

Human-readable message indicating details about last transition.

.reason

string

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

.status

string

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

.type

string

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

PodDisruptionBudgetList [policy/v1beta1]

Description

PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PodDisruptionBudget policy/v1beta1)

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

PodDNSConfig [core/v1]

Description

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

Type

object

Specification

Property Type Description

.nameservers

array (string)

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

array (PodDNSConfigOption core/v1)

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

array (string)

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 [core/v1]

Description

PodDNSConfigOption defines DNS resolver options of a pod.

Type

object

Specification

Property Type Description

.name

string

Required.

.value

string

PodIP [core/v1]

Description

IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.

Type

object

Specification

Property Type Description

.ip

string

ip is an IP address (IPv4 or IPv6) assigned to the pod

PodList [core/v1]

Description

PodList is a list of Pods.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Pod core/v1)

List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PodMonitorList [monitoring.coreos.com/v1]

Description

PodMonitorList is a list of PodMonitor

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PodMonitor monitoring.coreos.com/v1)

List of podmonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PodReadinessGate [core/v1]

Description

PodReadinessGate contains the reference to a pod condition

Type

object

Required

  • conditionType

Specification

Property Type Description

.conditionType

string

ConditionType refers to a condition in the pod’s condition list with matching type.

PodSecurityContext [core/v1]

Description

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.

Type

object

Specification

Property Type 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.

.fsGroupChangePolicy

string

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified defaults to "Always".

.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 core/v1

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.

.seccompProfile

SeccompProfile core/v1

The seccomp options to use by the containers in this pod.

.supplementalGroups

array (integer)

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

array (Sysctl core/v1)

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.

.windowsOptions

WindowsSecurityContextOptions core/v1

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

PodSpec [core/v1]

Description

PodSpec is a description of a pod.

Type

object

Required

  • containers

Specification

Property Type 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 core/v1

If specified, the pod’s scheduling constraints

.automountServiceAccountToken

boolean

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

.containers

array (Container core/v1)

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 core/v1

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'.

.enableServiceLinks

boolean

EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.

.ephemeralContainers

array (EphemeralContainer core/v1)

List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.

.hostAliases

array (HostAlias core/v1)

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

array (LocalObjectReference core/v1)

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

array (Container core/v1)

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, Liveness probes, or Startup 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 (string)

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/

.overhead

object (Quantity api/resource)

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.

.preemptionPolicy

string

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

.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

array (PodReadinessGate core/v1)

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://git.k8s.io/enhancements/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://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.

.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 core/v1

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/

.setHostnameAsFQDN

boolean

If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

.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.

.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

array (Toleration core/v1)

If specified, the pod’s tolerations.

.topologySpreadConstraints

array (TopologySpreadConstraint core/v1)

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.

.volumes

array (Volume core/v1)

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

PodTemplateList [core/v1]

Description

PodTemplateList is a list of PodTemplates.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PodTemplate core/v1)

List of pod templates

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PodTemplateSpec [core/v1]

Description

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

Type

object

Specification

Property Type Description

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

PodSpec core/v1

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

PortworxVolumeSource [core/v1]

Description

PortworxVolumeSource represents a Portworx volume resource.

Type

object

Required

  • volumeID

Specification

Property Type 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

PreferredSchedulingTerm [core/v1]

Description

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).

Type

object

Required

  • weight

  • preference

Specification

Property Type Description

.preference

NodeSelectorTerm core/v1

A node selector term, associated with the corresponding weight.

.weight

integer

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

PriorityClassList [scheduling.k8s.io/v1]

Description

PriorityClassList is a collection of priority classes.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PriorityClass scheduling.k8s.io/v1)

items is the list of PriorityClasses

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

PriorityLevelConfigurationList [flowcontrol.apiserver.k8s.io/v1alpha1]

Description

PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1)

items is a list of request-priorities.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Probe [core/v1]

Description

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

Type

object

Specification

Property Type Description

.exec

ExecAction core/v1

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 core/v1

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 and startup. Minimum value is 1.

.tcpSocket

TCPSocketAction core/v1

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

ProbeList [monitoring.coreos.com/v1]

Description

ProbeList is a list of Probe

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Probe monitoring.coreos.com/v1)

List of probes. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ProfileList [tuned.openshift.io/v1]

Description

ProfileList is a list of Profile

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Profile tuned.openshift.io/v1)

List of profiles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ProjectedVolumeSource [core/v1]

Description

Represents a projected volume source

Type

object

Required

  • sources

Specification

Property Type Description

.defaultMode

integer

Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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

array (VolumeProjection core/v1)

list of volume projections

ProjectList [config.openshift.io/v1]

Description

ProjectList is a list of Project

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Project config.openshift.io/v1)

List of projects. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ProjectList [project.openshift.io/v1]

Description

ProjectList is a list of Project objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Project project.openshift.io/v1)

Items is the list of projects

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

PrometheusList [monitoring.coreos.com/v1]

Description

PrometheusList is a list of Prometheus

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Prometheus monitoring.coreos.com/v1)

List of prometheuses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

PrometheusRuleList [monitoring.coreos.com/v1]

Description

PrometheusRuleList is a list of PrometheusRule

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (PrometheusRule monitoring.coreos.com/v1)

List of prometheusrules. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ProvisioningList [metal3.io/v1alpha1]

Description

ProvisioningList is a list of Provisioning

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Provisioning metal3.io/v1alpha1)

List of provisionings. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ProxyList [config.openshift.io/v1]

Description

ProxyList is a list of Proxy

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Proxy config.openshift.io/v1)

List of proxies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Quantity [api/resource]

Description

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() 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.

Type

string

QuobyteVolumeSource [core/v1]

Description

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

Type

object

Required

  • registry

  • volume

Specification

Property Type 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

.tenant

string

Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

.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.

RangeAllocationList [security.openshift.io/v1]

Description

RangeAllocationList is a list of RangeAllocations objects

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (RangeAllocation security.openshift.io/v1)

List of RangeAllocations.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

RawExtension [pkg/runtime]

Description

RawExtension is used to hold extensions in external versions.

To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.

	runtime.TypeMeta `json:",inline"`
	MyPlugin runtime.Object `json:"myPlugin"`
} type PluginA struct {
	AOption string `json:"aOption"`
}
	runtime.TypeMeta `json:",inline"`
	MyPlugin runtime.RawExtension `json:"myPlugin"`
} type PluginA struct {
	AOption string `json:"aOption"`
}
	"kind":"MyAPIObject",
	"apiVersion":"v1",
	"myPlugin": {
		"kind":"PluginA",
		"aOption":"foo",
	},
}

So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package’s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)

Type

object

RBDPersistentVolumeSource [core/v1]

Description

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

Type

object

Required

  • monitors

  • image

Specification

Property Type 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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.monitors

array (string)

A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.pool

string

The rados pool name. Default is rbd. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.secretRef

SecretReference core/v1

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.user

string

The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

RBDVolumeSource [core/v1]

Description

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

Type

object

Required

  • monitors

  • image

Specification

Property Type 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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.monitors

array (string)

A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.pool

string

The rados pool name. Default is rbd. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.secretRef

LocalObjectReference core/v1

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

.user

string

The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

ReplicaSetList [apps/v1]

Description

ReplicaSetList is a collection of ReplicaSets.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ReplicaSet apps/v1)

List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ReplicationControllerCondition [core/v1]

Description

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Type

object

Required

  • type

  • status

Specification

Property Type Description

.lastTransitionTime

Time meta/v1

The last time the condition transitioned from one status to another.

.message

string

A human readable message indicating details about the transition.

.reason

string

The reason for the condition’s last transition.

.status

string

Status of the condition, one of True, False, Unknown.

.type

string

Type of replication controller condition.

ReplicationControllerList [core/v1]

Description

ReplicationControllerList is a collection of replication controllers.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ReplicationController core/v1)

List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ResourceFieldSelector [core/v1]

Description

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

Type

object

Required

  • resource

Specification

Property Type Description

.containerName

string

Container name: required for volumes, optional for env vars

.divisor

Quantity api/resource

Specifies the output format of the exposed resources, defaults to "1"

.resource

string

Required: resource to select

ResourceQuotaList [core/v1]

Description

ResourceQuotaList is a list of ResourceQuota items.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ResourceQuota core/v1)

Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ResourceQuotaSpec [core/v1]

Description

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Type

object

Specification

Property Type Description

.hard

object (Quantity api/resource)

hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

.scopeSelector

ScopeSelector core/v1

scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.

.scopes

array (string)

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

ResourceQuotaStatus [core/v1]

Description

ResourceQuotaStatus defines the enforced hard limits and observed use.

Type

object

Specification

Property Type Description

.hard

object (Quantity api/resource)

Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

.used

object (Quantity api/resource)

Used is the current observed total usage of the resource in the namespace.

ResourceRequirements [core/v1]

Description

ResourceRequirements describes the compute resource requirements.

Type

object

Specification

Property Type Description

.limits

object (Quantity api/resource)

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

.requests

object (Quantity api/resource)

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/

RoleBindingList [authorization.openshift.io/v1]

Description

RoleBindingList is a collection of RoleBindings

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (RoleBinding authorization.openshift.io/v1)

Items is a list of RoleBindings

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

RoleBindingList [rbac.authorization.k8s.io/v1]

Description

RoleBindingList is a collection of RoleBindings

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (RoleBinding rbac.authorization.k8s.io/v1)

Items is a list of RoleBindings

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard object’s metadata.

RoleBindingRestrictionList [authorization.openshift.io/v1]

Description

RoleBindingRestrictionList is a list of RoleBindingRestriction

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (RoleBindingRestriction authorization.openshift.io/v1)

List of rolebindingrestrictions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

RoleList [authorization.openshift.io/v1]

Description

RoleList is a collection of Roles

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Role authorization.openshift.io/v1)

Items is a list of Roles

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

RoleList [rbac.authorization.k8s.io/v1]

Description

RoleList is a collection of Roles

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Role rbac.authorization.k8s.io/v1)

Items is a list of Roles

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard object’s metadata.

RouteList [route.openshift.io/v1]

Description

RouteList is a collection of Routes.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Route route.openshift.io/v1)

items is a list of routes

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

RuntimeClassList [node.k8s.io/v1beta1]

Description

RuntimeClassList is a list of RuntimeClass objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (RuntimeClass node.k8s.io/v1beta1)

Items is a list of schema objects.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Scale [autoscaling/v1]

Description

Scale represents a scaling request for a resource.

Type

object

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

.spec

ScaleSpec autoscaling/v1

defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.

.status

ScaleStatus autoscaling/v1

current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.

Scale [extensions/v1beta1]

Description

represents a scaling request for a resource.

Type

object

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

.spec

ScaleSpec extensions/v1beta1

defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.

.status

ScaleStatus extensions/v1beta1

current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.

ScaleIOPersistentVolumeSource [core/v1]

Description

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Type

object

Required

  • gateway

  • system

  • secretRef

Specification

Property Type 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

SecretReference core/v1

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.

ScaleIOVolumeSource [core/v1]

Description

ScaleIOVolumeSource represents a persistent ScaleIO volume

Type

object

Required

  • gateway

  • system

  • secretRef

Specification

Property Type 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 core/v1

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.

SchedulerList [config.openshift.io/v1]

Description

SchedulerList is a list of Scheduler

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Scheduler config.openshift.io/v1)

List of schedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ScopedResourceSelectorRequirement [core/v1]

Description

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

Type

object

Required

  • scopeName

  • operator

Specification

Property Type Description

.operator

string

Represents a scope’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.

.scopeName

string

The name of the scope that the selector applies to.

.values

array (string)

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.

ScopeSelector [core/v1]

Description

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

Type

object

Specification

Property Type Description

.matchExpressions

array (ScopedResourceSelectorRequirement core/v1)

A list of scope selector requirements by scope of the resources.

SeccompProfile [core/v1]

Description

SeccompProfile defines a pod/container’s seccomp profile settings. Only one profile source may be set.

Type

object

Required

  • type

Specification

Property Type Description

.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is "Localhost".

.type

string

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

SecretEnvSource [core/v1]

Description

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.

Type

object

Specification

Property Type 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 [core/v1]

Description

SecretKeySelector selects a key of a Secret.

Type

object

Required

  • key

Specification

Property Type 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 its key must be defined

SecretList [core/v1]

Description

SecretList is a list of Secret.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Secret core/v1)

Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

SecretProjection [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.items

array (KeyToPath core/v1)

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

SecretReference [core/v1]

Description

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Type

object

Specification

Property Type Description

.name

string

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

.namespace

string

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

SecretVolumeSource [core/v1]

Description

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.

Type

object

Specification

Property Type Description

.defaultMode

integer

Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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

array (KeyToPath core/v1)

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 its 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 [core/v1]

Description

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.

Type

object

Specification

Property Type 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 core/v1

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 core/v1

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.

.seccompProfile

SeccompProfile core/v1

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

.windowsOptions

WindowsSecurityContextOptions core/v1

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

SecurityContextConstraintsList [security.openshift.io/v1]

Description

SecurityContextConstraintsList is a list of SecurityContextConstraints

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (SecurityContextConstraints security.openshift.io/v1)

List of securitycontextconstraints. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

SELinuxOptions [core/v1]

Description

SELinuxOptions are the labels to be applied to the container

Type

object

Specification

Property Type 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.

ServiceAccountList [core/v1]

Description

ServiceAccountList is a list of ServiceAccount objects

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ServiceAccount core/v1)

List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ServiceAccountTokenProjection [core/v1]

Description

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).

Type

object

Required

  • path

Specification

Property Type 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.

ServiceCAList [operator.openshift.io/v1]

Description

ServiceCAList is a list of ServiceCA

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ServiceCA operator.openshift.io/v1)

List of servicecas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ServiceList [core/v1]

Description

ServiceList holds a list of services.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Service core/v1)

List of services

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ServiceMonitorList [monitoring.coreos.com/v1]

Description

ServiceMonitorList is a list of ServiceMonitor

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ServiceMonitor monitoring.coreos.com/v1)

List of servicemonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ServicePort [core/v1]

Description

ServicePort contains information on service’s port.

Type

object

Required

  • port

Specification

Property Type Description

.appProtocol

string

The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.

.name

string

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.

.nodePort

integer

The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

.port

integer

The port that will be exposed by this service.

.protocol

string

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

.targetPort

IntOrString util/intstr

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service

SessionAffinityConfig [core/v1]

Description

SessionAffinityConfig represents the configurations of session affinity.

Type

object

Specification

Property Type Description

.clientIP

ClientIPConfig core/v1

clientIP contains the configurations of Client IP based session affinity.

StatefulSetList [apps/v1]

Description

StatefulSetList is a collection of StatefulSets.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (StatefulSet apps/v1)

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Status [meta/v1]

Description

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

Type

object

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.code

integer

Suggested HTTP return code for this status, 0 if not set.

.details

StatusDetails meta/v1

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/sig-architecture/api-conventions.md#types-kinds

.message

string

A human-readable description of the status of this operation.

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status

StatusCause [meta/v1]

Description

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

Type

object

Specification

Property Type 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 [meta/v1]

Description

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.

Type

object

Specification

Property Type Description

.causes

array (StatusCause meta/v1)

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/sig-architecture/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

StorageClassList [storage.k8s.io/v1]

Description

StorageClassList is a collection of storage classes.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (StorageClass storage.k8s.io/v1)

Items is the list of StorageClasses

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

StorageList [operator.openshift.io/v1]

Description

StorageList is a list of Storage

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Storage operator.openshift.io/v1)

List of storages. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

StorageOSPersistentVolumeSource [core/v1]

Description

Represents a StorageOS persistent volume resource.

Type

object

Specification

Property Type 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

ObjectReference core/v1

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.

StorageOSVolumeSource [core/v1]

Description

Represents a StorageOS persistent volume resource.

Type

object

Specification

Property Type 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 core/v1

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.

StorageStateList [migration.k8s.io/v1alpha1]

Description

StorageStateList is a list of StorageState

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (StorageState migration.k8s.io/v1alpha1)

List of storagestates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

StorageVersionMigrationList [migration.k8s.io/v1alpha1]

Description

StorageVersionMigrationList is a list of StorageVersionMigration

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (StorageVersionMigration migration.k8s.io/v1alpha1)

List of storageversionmigrations. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

SubscriptionList [operators.coreos.com/v1alpha1]

Description

SubscriptionList is a list of Subscription

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Subscription operators.coreos.com/v1alpha1)

List of subscriptions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Sysctl [core/v1]

Description

Sysctl defines a kernel parameter to be set

Type

object

Required

  • name

  • value

Specification

Property Type Description

.name

string

Name of a property to set

.value

string

Value of a property to set

Taint [core/v1]

Description

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Type

object

Required

  • key

  • effect

Specification

Property Type Description

.effect

string

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.key

string

Required. The taint key to be applied to a node.

.timeAdded

Time meta/v1

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.value

string

The taint value corresponding to the taint key.

TCPSocketAction [core/v1]

Description

TCPSocketAction describes an action based on opening a socket

Type

object

Required

  • port

Specification

Property Type Description

.host

string

Optional: Host name to connect to, defaults to the pod IP.

.port

IntOrString util/intstr

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.

TemplateInstanceList [template.openshift.io/v1]

Description

TemplateInstanceList is a list of TemplateInstance objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (TemplateInstance template.openshift.io/v1)

items is a list of Templateinstances

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ThanosRulerList [monitoring.coreos.com/v1]

Description

ThanosRulerList is a list of ThanosRuler

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ThanosRuler monitoring.coreos.com/v1)

List of thanosrulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Time [meta/v1]

Description

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.

Type

string

TokenRequest [authentication.k8s.io/v1]

Description

TokenRequest requests a token for a given service account.

Type

object

Required

  • spec

Specification

Property Type 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

.spec

TokenRequestSpec authentication.k8s.io/v1

.status

TokenRequestStatus authentication.k8s.io/v1

Toleration [core/v1]

Description

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

Type

object

Specification

Property Type 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.

TopologySelectorLabelRequirement [core/v1]

Description

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

Type

object

Required

  • key

  • values

Specification

Property Type Description

.key

string

The label key that the selector applies to.

.values

array (string)

An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

TopologySelectorTerm [core/v1]

Description

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

Type

object

Specification

Property Type Description

.matchLabelExpressions

array (TopologySelectorLabelRequirement core/v1)

A list of topology selector requirements by labels.

TopologySpreadConstraint [core/v1]

Description

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Type

object

Required

  • maxSkew

  • topologyKey

  • whenUnsatisfiable

Specification

Property Type Description

.labelSelector

LabelSelector meta/v1

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

.maxSkew

integer

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It’s a required field. Default value is 1 and 0 is not allowed.

.topologyKey

string

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It’s a required field.

.whenUnsatisfiable

string

WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.

TunedList [tuned.openshift.io/v1]

Description

TunedList is a list of Tuned

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (Tuned tuned.openshift.io/v1)

List of tuneds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

TypedLocalObjectReference [core/v1]

Description

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

Type

object

Required

  • kind

  • name

Specification

Property Type Description

.apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

.kind

string

Kind is the type of resource being referenced

.name

string

Name is the name of resource being referenced

UserList [user.openshift.io/v1]

Description

UserList is a collection of Users

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (User user.openshift.io/v1)

Items is the list of users

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

ValidatingWebhookConfigurationList [admissionregistration.k8s.io/v1]

Description

ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (ValidatingWebhookConfiguration admissionregistration.k8s.io/v1)

List of ValidatingWebhookConfiguration.

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Volume [core/v1]

Description

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

Type

object

Required

  • name

Specification

Property Type Description

.awsElasticBlockStore

AWSElasticBlockStoreVolumeSource core/v1

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 core/v1

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

.azureFile

AzureFileVolumeSource core/v1

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

.cephfs

CephFSVolumeSource core/v1

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

.cinder

CinderVolumeSource core/v1

Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

.configMap

ConfigMapVolumeSource core/v1

ConfigMap represents a configMap that should populate this volume

.csi

CSIVolumeSource core/v1

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

.downwardAPI

DownwardAPIVolumeSource core/v1

DownwardAPI represents downward API about the pod that should populate this volume

.emptyDir

EmptyDirVolumeSource core/v1

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

.ephemeral

EphemeralVolumeSource core/v1

Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

.fc

FCVolumeSource core/v1

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

.flexVolume

FlexVolumeSource core/v1

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

.flocker

FlockerVolumeSource core/v1

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

.gcePersistentDisk

GCEPersistentDiskVolumeSource core/v1

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 core/v1

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 core/v1

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

.hostPath

HostPathVolumeSource core/v1

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 core/v1

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/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 core/v1

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 core/v1

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

.photonPersistentDisk

PhotonPersistentDiskVolumeSource core/v1

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

.portworxVolume

PortworxVolumeSource core/v1

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

.projected

ProjectedVolumeSource core/v1

Items for all in one resources secrets, configmaps, and downward API

.quobyte

QuobyteVolumeSource core/v1

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

.rbd

RBDVolumeSource core/v1

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

.scaleIO

ScaleIOVolumeSource core/v1

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

.secret

SecretVolumeSource core/v1

Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

.storageos

StorageOSVolumeSource core/v1

StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

.vsphereVolume

VsphereVirtualDiskVolumeSource core/v1

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

VolumeAttachmentList [storage.k8s.io/v1]

Description

VolumeAttachmentList is a collection of VolumeAttachment objects.

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (VolumeAttachment storage.k8s.io/v1)

Items is the list of VolumeAttachments

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

VolumeDevice [core/v1]

Description

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

Type

object

Required

  • name

  • devicePath

Specification

Property Type 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 [core/v1]

Description

VolumeMount describes a mounting of a Volume within a container.

Type

object

Required

  • name

  • mountPath

Specification

Property Type 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).

.subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive.

VolumeNodeAffinity [core/v1]

Description

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

Type

object

Specification

Property Type Description

.required

NodeSelector core/v1

Required specifies hard node constraints that must be met.

VolumeProjection [core/v1]

Description

Projection that may be projected along with other supported volume types

Type

object

Specification

Property Type Description

.configMap

ConfigMapProjection core/v1

information about the configMap data to project

.downwardAPI

DownwardAPIProjection core/v1

information about the downwardAPI data to project

.secret

SecretProjection core/v1

information about the secret data to project

.serviceAccountToken

ServiceAccountTokenProjection core/v1

information about the serviceAccountToken data to project

VolumeSnapshotClassList [snapshot.storage.k8s.io/v1beta1]

Description

VolumeSnapshotClassList is a list of VolumeSnapshotClass

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (VolumeSnapshotClass snapshot.storage.k8s.io/v1beta1)

List of volumesnapshotclasses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

VolumeSnapshotContentList [snapshot.storage.k8s.io/v1beta1]

Description

VolumeSnapshotContentList is a list of VolumeSnapshotContent

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (VolumeSnapshotContent snapshot.storage.k8s.io/v1beta1)

List of volumesnapshotcontents. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

VolumeSnapshotList [snapshot.storage.k8s.io/v1beta1]

Description

VolumeSnapshotList is a list of VolumeSnapshot

Type

object

Required

  • items

Specification

Property Type 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/sig-architecture/api-conventions.md#resources

.items

array (VolumeSnapshot snapshot.storage.k8s.io/v1beta1)

List of volumesnapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

.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/sig-architecture/api-conventions.md#types-kinds

.metadata

ListMeta meta/v1

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

VsphereVirtualDiskVolumeSource [core/v1]

Description

Represents a vSphere volume resource.

Type

object

Required

  • volumePath

Specification

Property Type 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 [core/v1]

Description

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

Type

object

Required

  • weight

  • podAffinityTerm

Specification

Property Type Description

.podAffinityTerm

PodAffinityTerm core/v1

Required. A pod affinity term, associated with the corresponding weight.

.weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

WindowsSecurityContextOptions [core/v1]

Description

WindowsSecurityContextOptions contain Windows-specific options and credentials.

Type

object

Specification

Property Type Description

.gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the 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.