• Русский
  • Subscription [operators.coreos.com/v1alpha1]

    Description
    Subscription keeps operators up to date by tracking changes to Catalogs.
    Type
    object
    Required
    metadataspec

    Specification

    PropertyTypeDescription
    apiVersionstring

    APIVersion defines the versioned schema of this representation of an object. 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

    kindstring

    Kind is a string value representing the REST resource this object represents. Servers may 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

    metadataObjectMeta

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

    specobject

    SubscriptionSpec defines an Application that can be installed

    statusobject

    .spec

    Description
    SubscriptionSpec defines an Application that can be installed
    Type
    object
    Required
    namesourcesourceNamespace
    PropertyTypeDescription
    channelstring
    configobject

    SubscriptionConfig contains configuration specified for a subscription.

    installPlanApprovalstring

    Approval is the user approval policy for an InstallPlan. It must be one of "Automatic" or "Manual".

    namestring
    sourcestring
    sourceNamespacestring
    startingCSVstring

    .spec.config

    Description
    SubscriptionConfig contains configuration specified for a subscription.
    Type
    object
    PropertyTypeDescription
    envarray

    Env is a list of environment variables to set in the container. Cannot be updated.

    envFromarray

    EnvFrom is a 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. Immutable.

    nodeSelectorobject

    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

    resourcesobject

    Resources represents compute resources required by this container. Immutable. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

    selectorobject

    Selector is the label selector for pods to be configured. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

    tolerationsarray

    Tolerations are the pod's tolerations.

    volumeMountsarray

    List of VolumeMounts to set in the container.

    volumesarray

    List of Volumes to set in the podSpec.

    .spec.config.env

    Description
    Env is a list of environment variables to set in the container. Cannot be updated.
    Type
    array

    .spec.config.env[]

    Description
    EnvVar represents an environment variable present in a Container.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name of the environment variable. Must be a C_IDENTIFIER.

    valuestring

    Variable references $(VAR_NAME) are expanded using the previously 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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

    valueFromobject

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

    .spec.config.env[].valueFrom

    Description
    Source for the environment variable's value. Cannot be used if value is not empty.
    Type
    object
    PropertyTypeDescription
    configMapKeyRefobject

    Selects a key of a ConfigMap.

    fieldRefobject

    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.

    resourceFieldRefobject

    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.

    secretKeyRefobject

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

    .spec.config.env[].valueFrom.configMapKeyRef

    Description
    Selects a key of a ConfigMap.
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

    The key to select.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the ConfigMap or its key must be defined

    .spec.config.env[].valueFrom.fieldRef

    Description
    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.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.config.env[].valueFrom.resourceFieldRef

    Description
    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.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.config.env[].valueFrom.secretKeyRef

    Description
    Selects a key of a secret in the pod's namespace
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

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

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the Secret or its key must be defined

    .spec.config.envFrom

    Description
    EnvFrom is a 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. Immutable.
    Type
    array

    .spec.config.envFrom[]

    Description
    EnvFromSource represents the source of a set of ConfigMaps
    Type
    object
    PropertyTypeDescription
    configMapRefobject

    The ConfigMap to select from

    prefixstring

    An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

    secretRefobject

    The Secret to select from

    .spec.config.envFrom[].configMapRef

    Description
    The ConfigMap to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the ConfigMap must be defined

    .spec.config.envFrom[].secretRef

    Description
    The Secret to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the Secret must be defined

    .spec.config.nodeSelector

    Description
    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
    Type
    object

    .spec.config.resources

    Description
    Resources represents compute resources required by this container. Immutable. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
    Type
    object
    PropertyTypeDescription
    limitsobject

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    requestsobject

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

    .spec.config.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.config.resources.requests

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

    .spec.config.selector

    Description
    Selector is the label selector for pods to be configured. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

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

    matchLabelsobject

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

    .spec.config.selector.matchExpressions

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

    .spec.config.selector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.config.selector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.config.selector.matchExpressions[].values[]

    Type
    string

    .spec.config.selector.matchLabels

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

    .spec.config.tolerations

    Description
    Tolerations are the pod's tolerations.
    Type
    array

    .spec.config.tolerations[]

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

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    keystring

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

    operatorstring

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    tolerationSecondsinteger

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    valuestring

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

    .spec.config.volumeMounts

    Description
    List of VolumeMounts to set in the container.
    Type
    array

    .spec.config.volumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.config.volumes

    Description
    List of Volumes to set in the podSpec.
    Type
    array

    .spec.config.volumes[]

    Description
    Volume represents a named volume in a pod that may be accessed by any container in the pod.
    Type
    object
    Required
    name
    PropertyTypeDescription
    awsElasticBlockStoreobject

    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    azureDiskobject

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

    azureFileobject

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

    cephfsobject

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

    cinderobject

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

    configMapobject

    ConfigMap represents a configMap that should populate this volume

    csiobject

    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

    downwardAPIobject

    DownwardAPI represents downward API about the pod that should populate this volume

    emptyDirobject

    EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    ephemeralobject

    Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.

    fcobject

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

    flexVolumeobject

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

    flockerobject

    Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

    gcePersistentDiskobject

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

    gitRepoobject

    GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

    glusterfsobject

    Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

    hostPathobject

    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

    iscsiobject

    ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

    namestring

    Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    nfsobject

    NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    persistentVolumeClaimobject

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    photonPersistentDiskobject

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

    portworxVolumeobject

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

    projectedobject

    Items for all in one resources secrets, configmaps, and downward API

    quobyteobject

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

    rbdobject

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

    scaleIOobject

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

    secretobject

    Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    storageosobject

    StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

    vsphereVolumeobject

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

    .spec.config.volumes[].awsElasticBlockStore

    Description
    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    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 TODO: how do we prevent errors in the filesystem from compromising the machine

    partitioninteger

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

    readOnlyboolean

    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

    volumeIDstring

    Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    .spec.config.volumes[].azureDisk

    Description
    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
    Type
    object
    Required
    diskNamediskURI
    PropertyTypeDescription
    cachingModestring

    Host Caching mode: None, Read Only, Read Write.

    diskNamestring

    The Name of the data disk in the blob storage

    diskURIstring

    The URI the data disk in the blob storage

    fsTypestring

    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.

    kindstring

    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

    readOnlyboolean

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

    .spec.config.volumes[].azureFile

    Description
    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
    Type
    object
    Required
    secretNameshareName
    PropertyTypeDescription
    readOnlyboolean

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

    secretNamestring

    the name of secret that contains Azure Storage Account Name and Key

    shareNamestring

    Share Name

    .spec.config.volumes[].cephfs

    Description
    CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
    Type
    object
    Required
    monitors
    PropertyTypeDescription
    monitorsarray

    Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    pathstring

    Optional: Used as the mounted root, rather than the full Ceph tree, default is /

    readOnlyboolean

    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

    secretFilestring

    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

    secretRefobject

    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

    userstring

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

    .spec.config.volumes[].cephfs.monitors

    Description
    Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    Type
    array

    .spec.config.volumes[].cephfs.monitors[]

    Type
    string

    .spec.config.volumes[].cephfs.secretRef

    Description
    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
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].cinder

    Description
    Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    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

    readOnlyboolean

    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

    secretRefobject

    Optional: points to a secret object containing parameters used to connect to OpenStack.

    volumeIDstring

    volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

    .spec.config.volumes[].cinder.secretRef

    Description
    Optional: points to a secret object containing parameters used to connect to OpenStack.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].configMap

    Description
    ConfigMap represents a configMap that should populate this volume
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    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.

    itemsarray

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

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the ConfigMap or its keys must be defined

    .spec.config.volumes[].configMap.items

    Description
    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 '..'.
    Type
    array

    .spec.config.volumes[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    The key to project.

    modeinteger

    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.

    pathstring

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.config.volumes[].csi

    Description
    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

    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.

    fsTypestring

    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.

    nodePublishSecretRefobject

    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.

    readOnlyboolean

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

    volumeAttributesobject

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

    .spec.config.volumes[].csi.nodePublishSecretRef

    Description
    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.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].csi.volumeAttributes

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

    .spec.config.volumes[].downwardAPI

    Description
    DownwardAPI represents downward API about the pod that should populate this volume
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    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.

    itemsarray

    Items is a list of downward API volume file

    .spec.config.volumes[].downwardAPI.items

    Description
    Items is a list of downward API volume file
    Type
    array

    .spec.config.volumes[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

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

    modeinteger

    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.

    pathstring

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

    resourceFieldRefobject

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

    .spec.config.volumes[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.config.volumes[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.config.volumes[].emptyDir

    Description
    EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
    Type
    object
    PropertyTypeDescription
    mediumstring

    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

    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

    .spec.config.volumes[].ephemeral

    Description
    Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
    Type
    object
    PropertyTypeDescription
    volumeClaimTemplateobject

    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.

    .spec.config.volumes[].ephemeral.volumeClaimTemplate

    Description
    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.
    Type
    object
    Required
    spec
    PropertyTypeDescription
    metadataObjectMeta

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

    specobject

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec

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

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

    dataSourceobject

    This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

    dataSourceRefobject

    Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    resourcesobject

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

    selectorobject

    A label query over volumes to consider for binding.

    storageClassNamestring

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

    volumeModestring

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

    volumeNamestring

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes[]

    Type
    string

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

    Description
    This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

    Description
    Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources

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

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    requestsobject

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources.requests

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector

    Description
    A label query over volumes to consider for binding.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

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

    matchLabelsobject

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

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

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values[]

    Type
    string

    .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

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

    .spec.config.volumes[].fc

    Description
    FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
    Type
    object
    PropertyTypeDescription
    fsTypestring

    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. TODO: how do we prevent errors in the filesystem from compromising the machine

    luninteger

    Optional: FC target lun number

    readOnlyboolean

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

    targetWWNsarray

    Optional: FC target worldwide names (WWNs)

    wwidsarray

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

    .spec.config.volumes[].fc.targetWWNs

    Description
    Optional: FC target worldwide names (WWNs)
    Type
    array

    .spec.config.volumes[].fc.targetWWNs[]

    Type
    string

    .spec.config.volumes[].fc.wwids

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

    .spec.config.volumes[].fc.wwids[]

    Type
    string

    .spec.config.volumes[].flexVolume

    Description
    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

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

    fsTypestring

    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.

    optionsobject

    Optional: Extra command options if any.

    readOnlyboolean

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

    secretRefobject

    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.

    .spec.config.volumes[].flexVolume.options

    Description
    Optional: Extra command options if any.
    Type
    object

    .spec.config.volumes[].flexVolume.secretRef

    Description
    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.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].flocker

    Description
    Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
    Type
    object
    PropertyTypeDescription
    datasetNamestring

    Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

    datasetUUIDstring

    UUID of the dataset. This is unique identifier of a Flocker dataset

    .spec.config.volumes[].gcePersistentDisk

    Description
    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    Type
    object
    Required
    pdName
    PropertyTypeDescription
    fsTypestring

    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 TODO: how do we prevent errors in the filesystem from compromising the machine

    partitioninteger

    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

    pdNamestring

    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

    readOnlyboolean

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    .spec.config.volumes[].gitRepo

    Description
    GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
    Type
    object
    Required
    repository
    PropertyTypeDescription
    directorystring

    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.

    repositorystring

    Repository URL

    revisionstring

    Commit hash for the specified revision.

    .spec.config.volumes[].glusterfs

    Description
    Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
    Type
    object
    Required
    endpointspath
    PropertyTypeDescription
    endpointsstring

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

    pathstring

    Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

    readOnlyboolean

    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

    .spec.config.volumes[].hostPath

    Description
    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
    Type
    object
    Required
    path
    PropertyTypeDescription
    pathstring

    Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

    typestring

    Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

    .spec.config.volumes[].iscsi

    Description
    ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
    Type
    object
    Required
    iqnluntargetPortal
    PropertyTypeDescription
    chapAuthDiscoveryboolean

    whether support iSCSI Discovery CHAP authentication

    chapAuthSessionboolean

    whether support iSCSI Session CHAP authentication

    fsTypestring

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine

    initiatorNamestring

    Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

    iqnstring

    Target iSCSI Qualified Name.

    iscsiInterfacestring

    iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

    luninteger

    iSCSI Target Lun number.

    portalsarray

    iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

    readOnlyboolean

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

    secretRefobject

    CHAP Secret for iSCSI target and initiator authentication

    targetPortalstring

    iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

    .spec.config.volumes[].iscsi.portals

    Description
    iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    Type
    array

    .spec.config.volumes[].iscsi.portals[]

    Type
    string

    .spec.config.volumes[].iscsi.secretRef

    Description
    CHAP Secret for iSCSI target and initiator authentication
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].nfs

    Description
    NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    Type
    object
    Required
    pathserver
    PropertyTypeDescription
    pathstring

    Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    readOnlyboolean

    ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    serverstring

    Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    .spec.config.volumes[].persistentVolumeClaim

    Description
    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    Type
    object
    Required
    claimName
    PropertyTypeDescription
    claimNamestring

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    readOnlyboolean

    Will force the ReadOnly setting in VolumeMounts. Default false.

    .spec.config.volumes[].photonPersistentDisk

    Description
    PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
    Type
    object
    Required
    pdID
    PropertyTypeDescription
    fsTypestring

    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.

    pdIDstring

    ID that identifies Photon Controller persistent disk

    .spec.config.volumes[].portworxVolume

    Description
    PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

    readOnlyboolean

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

    volumeIDstring

    VolumeID uniquely identifies a Portworx volume

    .spec.config.volumes[].projected

    Description
    Items for all in one resources secrets, configmaps, and downward API
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    sourcesarray

    list of volume projections

    .spec.config.volumes[].projected.sources

    Description
    list of volume projections
    Type
    array

    .spec.config.volumes[].projected.sources[]

    Description
    Projection that may be projected along with other supported volume types
    Type
    object
    PropertyTypeDescription
    configMapobject

    information about the configMap data to project

    downwardAPIobject

    information about the downwardAPI data to project

    secretobject

    information about the secret data to project

    serviceAccountTokenobject

    information about the serviceAccountToken data to project

    .spec.config.volumes[].projected.sources[].configMap

    Description
    information about the configMap data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

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

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the ConfigMap or its keys must be defined

    .spec.config.volumes[].projected.sources[].configMap.items

    Description
    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 '..'.
    Type
    array

    .spec.config.volumes[].projected.sources[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    The key to project.

    modeinteger

    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.

    pathstring

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.config.volumes[].projected.sources[].downwardAPI

    Description
    information about the downwardAPI data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    Items is a list of DownwardAPIVolume file

    .spec.config.volumes[].projected.sources[].downwardAPI.items

    Description
    Items is a list of DownwardAPIVolume file
    Type
    array

    .spec.config.volumes[].projected.sources[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

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

    modeinteger

    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.

    pathstring

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

    resourceFieldRefobject

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

    .spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.config.volumes[].projected.sources[].secret

    Description
    information about the secret data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    optionalboolean

    Specify whether the Secret or its key must be defined

    .spec.config.volumes[].projected.sources[].secret.items

    Description
    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.config.volumes[].projected.sources[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    The key to project.

    modeinteger

    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.

    pathstring

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.config.volumes[].projected.sources[].serviceAccountToken

    Description
    information about the serviceAccountToken data to project
    Type
    object
    Required
    path
    PropertyTypeDescription
    audiencestring

    Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

    expirationSecondsinteger

    ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

    pathstring

    Path is the path relative to the mount point of the file to project the token into.

    .spec.config.volumes[].quobyte

    Description
    Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
    Type
    object
    Required
    registryvolume
    PropertyTypeDescription
    groupstring

    Group to map volume access to Default is no group

    readOnlyboolean

    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    registrystring

    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    tenantstring

    Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

    userstring

    User to map volume access to Defaults to serivceaccount user

    volumestring

    Volume is a string that references an already created Quobyte volume by name.

    .spec.config.volumes[].rbd

    Description
    RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
    Type
    object
    Required
    imagemonitors
    PropertyTypeDescription
    fsTypestring

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine

    imagestring

    The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    keyringstring

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    monitorsarray

    A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    poolstring

    The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    readOnlyboolean

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    secretRefobject

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    userstring

    The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    .spec.config.volumes[].rbd.monitors

    Description
    A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    Type
    array

    .spec.config.volumes[].rbd.monitors[]

    Type
    string

    .spec.config.volumes[].rbd.secretRef

    Description
    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].scaleIO

    Description
    ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
    Type
    object
    Required
    gatewaysecretRefsystem
    PropertyTypeDescription
    fsTypestring

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

    gatewaystring

    The host address of the ScaleIO API Gateway.

    protectionDomainstring

    The name of the ScaleIO Protection Domain for the configured storage.

    readOnlyboolean

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

    secretRefobject

    SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

    sslEnabledboolean

    Flag to enable/disable SSL communication with Gateway, default false

    storageModestring

    Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

    storagePoolstring

    The ScaleIO Storage Pool associated with the protection domain.

    systemstring

    The name of the storage system as configured in ScaleIO.

    volumeNamestring

    The name of a volume already created in the ScaleIO system that is associated with this volume source.

    .spec.config.volumes[].scaleIO.secretRef

    Description
    SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].secret

    Description
    Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    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.

    itemsarray

    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    optionalboolean

    Specify whether the Secret or its keys must be defined

    secretNamestring

    Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    .spec.config.volumes[].secret.items

    Description
    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.config.volumes[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    The key to project.

    modeinteger

    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.

    pathstring

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.config.volumes[].storageos

    Description
    StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
    Type
    object
    PropertyTypeDescription
    fsTypestring

    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.

    readOnlyboolean

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

    secretRefobject

    SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

    volumeNamestring

    VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

    volumeNamespacestring

    VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

    .spec.config.volumes[].storageos.secretRef

    Description
    SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

    .spec.config.volumes[].vsphereVolume

    Description
    VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
    Type
    object
    Required
    volumePath
    PropertyTypeDescription
    fsTypestring

    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.

    storagePolicyIDstring

    Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

    storagePolicyNamestring

    Storage Policy Based Management (SPBM) profile name.

    volumePathstring

    Path that identifies vSphere volume vmdk

    .status

    Type
    object
    Required
    lastUpdated
    PropertyTypeDescription
    catalogHealtharray

    CatalogHealth contains the Subscription's view of its relevant CatalogSources' status. It is used to determine SubscriptionStatusConditions related to CatalogSources.

    conditionsarray

    Conditions is a list of the latest available observations about a Subscription's current state.

    currentCSVstring

    CurrentCSV is the CSV the Subscription is progressing to.

    installPlanGenerationinteger

    InstallPlanGeneration is the current generation of the installplan

    installPlanRefobject

    InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription's current CSV.

    installedCSVstring

    InstalledCSV is the CSV currently installed by the Subscription.

    installplanobject

    Install is a reference to the latest InstallPlan generated for the Subscription. DEPRECATED: InstallPlanRef

    lastUpdatedstring

    LastUpdated represents the last time that the Subscription status was updated.

    reasonstring

    Reason is the reason the Subscription was transitioned to its current state.

    statestring

    State represents the current state of the Subscription

    .status.catalogHealth

    Description
    CatalogHealth contains the Subscription's view of its relevant CatalogSources' status. It is used to determine SubscriptionStatusConditions related to CatalogSources.
    Type
    array

    .status.catalogHealth[]

    Description
    SubscriptionCatalogHealth describes the health of a CatalogSource the Subscription knows about.
    Type
    object
    Required
    catalogSourceRefhealthylastUpdated
    PropertyTypeDescription
    catalogSourceRefobject

    CatalogSourceRef is a reference to a CatalogSource.

    healthyboolean

    Healthy is true if the CatalogSource is healthy; false otherwise.

    lastUpdatedstring

    LastUpdated represents the last time that the CatalogSourceHealth changed

    .status.catalogHealth[].catalogSourceRef

    Description
    CatalogSourceRef is a reference to a CatalogSource.
    Type
    object
    PropertyTypeDescription
    apiVersionstring

    API version of the referent.

    fieldPathstring

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

    kindstring

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

    namestring

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

    namespacestring

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

    resourceVersionstring

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

    uidstring

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

    .status.conditions

    Description
    Conditions is a list of the latest available observations about a Subscription's current state.
    Type
    array

    .status.conditions[]

    Description
    SubscriptionCondition represents the latest available observations of a Subscription's state.
    Type
    object
    Required
    statustype
    PropertyTypeDescription
    lastHeartbeatTimestring

    LastHeartbeatTime is the last time we got an update on a given condition

    lastTransitionTimestring

    LastTransitionTime is the last time the condition transit from one status to another

    messagestring

    Message is a human-readable message indicating details about last transition.

    reasonstring

    Reason is a one-word CamelCase reason for the condition's last transition.

    statusstring

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

    typestring

    Type is the type of Subscription condition.

    .status.installPlanRef

    Description
    InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription's current CSV.
    Type
    object
    PropertyTypeDescription
    apiVersionstring

    API version of the referent.

    fieldPathstring

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

    kindstring

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

    namestring

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

    namespacestring

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

    resourceVersionstring

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

    uidstring

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

    .status.installplan

    Description
    Install is a reference to the latest InstallPlan generated for the Subscription. DEPRECATED: InstallPlanRef
    Type
    object
    Required
    apiVersionkindnameuuid
    PropertyTypeDescription
    apiVersionstring
    kindstring
    namestring
    uuidstring

    UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

    API Endpoints

    The following API endpoints are available:

    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions
      • DELETE: delete collection of Subscription
      • GET: list objects of kind Subscription
      • POST: create a new Subscription
    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}
      • DELETE: delete the specified Subscription
      • GET: read the specified Subscription
      • PATCH: partially update the specified Subscription
      • PUT: replace the specified Subscription
    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status
      • GET: read status of the specified Subscription
      • PATCH: partially update status of the specified Subscription
      • PUT: replace status of the specified Subscription

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions

    HTTP method
    DELETE
    Description
    delete collection of Subscription
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind Subscription
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscriptionList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodySubscription schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    201 - CreatedSubscription schema
    202 - AcceptedSubscription schema
    401 - UnauthorizedEmpty

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}

    HTTP method
    DELETE
    Description
    delete the specified Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    read the specified Subscription
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodySubscription schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    201 - CreatedSubscription schema
    401 - UnauthorizedEmpty

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status

    HTTP method
    GET
    Description
    read status of the specified Subscription
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update status of the specified Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace status of the specified Subscription
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen 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
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodySubscription schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKSubscription schema
    201 - CreatedSubscription schema
    401 - UnauthorizedEmpty