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

GroupVersionKin