Subscription [operators.coreos.com/v1alpha1]
Description
Subscription keeps operators up to date by tracking changes to Catalogs.
Type
object
Required
metadata
spec
Specification
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| SubscriptionSpec defines an Application that can be installed |
|
|
.spec
Description
SubscriptionSpec defines an Application that can be installed
Type
object
Required
name
source
sourceNamespace
Property | Type | Description |
---|---|---|
|
| |
|
| SubscriptionConfig contains configuration specified for a subscription. |
|
| Approval is the user approval policy for an InstallPlan. It must be one of “Automatic” or “Manual”. |
|
| |
|
| |
|
| |
|
|
.spec.config
Description
SubscriptionConfig contains configuration specified for a subscription.
Type
object
Property | Type | Description |
---|---|---|
|
| Env is a list of environment variables to set in the container. Cannot be updated. |
|
| EnvVar represents an environment variable present in a Container. |
|
| 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. |
|
| EnvFromSource represents the source of a set of ConfigMaps |
|
| 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/ |
|
| Resources represents compute resources required by this container. Immutable. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
| 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. |
|
| Tolerations are the pod’s tolerations. |
|
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
| List of VolumeMounts to set in the container. |
|
| VolumeMount describes a mounting of a Volume within a container. |
|
| List of Volumes to set in the podSpec. |
|
| Volume represents a named volume in a pod that may be accessed by any container in the pod. |
.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
Property | Type | Description |
---|---|---|
|
| Name of the environment variable. Must be a C_IDENTIFIER. |
|
| Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Selects a key of a ConfigMap. |
|
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
| 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. |
|
| 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
Property | Type | Description |
---|---|---|
|
| The key to select. |
|
| 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? |
|
| 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, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
Property | Type | Description |
---|---|---|
|
| Version of the schema the FieldPath is written in terms of, defaults to “v1”. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Container name: required for volumes, optional for env vars |
|
| Specifies the output format of the exposed resources, defaults to “1” |
|
| 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
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| 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? |
|
| 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
Property | Type | Description |
---|---|---|
|
| The ConfigMap to select from |
|
| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
|
| The Secret to select from |
.spec.config.envFrom[].configMapRef
Description
The ConfigMap to select from
Type
object
Property | Type | Description |
---|---|---|
|
| 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? |
|
| Specify whether the ConfigMap must be defined |
.spec.config.envFrom[].secretRef
Description
The Secret to select from
Type
object
Property | Type | Description |
---|---|---|
|
| 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? |
|
| Specify whether the Secret must be defined |
.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
Property | Type | Description |
---|---|---|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
.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
Property | Type | Description |
---|---|---|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
| 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
key
operator
Property | Type | Description |
---|---|---|
|
| key is the label key that the selector applies to. |
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
| 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.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
Property | Type | Description |
---|---|---|
|
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
| Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
| Value 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
mountPath
name
Property | Type | Description |
---|---|---|
|
| Path within the container at which the volume should be mounted. Must not contain ‘:’. |
|
| 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. |
|
| This must match the Name of a Volume. |
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
| Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). |
|
| 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
Property | Type | 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 |
|
| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
|
| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
|
| CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
|
| Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| ConfigMap represents a configMap that should populate this volume |
|
| CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). |
|
| DownwardAPI represents downward API about the pod that should populate this volume |
|
| EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
|
| Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
|
| GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container. |
|
| Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md |
|
| 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. |
|
| 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 |
|
| Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| NFS represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
|
| PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
|
| Items for all in one resources secrets, configmaps, and downward API |
|
| Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
|
| RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md |
|
| ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
|
| Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
| StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| 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). |
|
| 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 |
|
| 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
diskName
diskURI
Property | Type | Description |
---|---|---|
|
| Host Caching mode: None, Read Only, Read Write. |
|
| The Name of the data disk in the blob storage |
|
| The URI the data disk in the blob storage |
|
| 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. |
|
| 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 |
|
| 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
secretName
shareName
Property | Type | Description |
---|---|---|
|
| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| the name of secret that contains Azure Storage Account Name and Key |
|
| 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
Property | Type | Description |
---|---|---|
|
| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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.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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| 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 |
|
| Optional: points to a secret object containing parameters used to connect to OpenStack. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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 ‘..’. |
|
| Maps a string key to a path within a volume. |
|
| 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? |
|
| 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
key
path
Property | Type | Description |
---|---|---|
|
| The key to project. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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 storage that is handled by an external CSI driver (Alpha feature).
Type
object
Required
driver
Property | Type | Description |
---|---|---|
|
| 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. |
|
| Filesystem type to mount. Ex. “ext4”, “xfs”, “ntfs”. If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. |
|
| NodePublishSecretRef 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. |
|
| Specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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[].downwardAPI
Description
DownwardAPI represents downward API about the pod that should populate this volume
Type
object
Property | Type | Description |
---|---|---|
|
| Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| Items is a list of downward API volume file |
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
.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
Property | Type | Description |
---|---|---|
|
| Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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 ‘..’ |
|
| 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
Property | Type | Description |
---|---|---|
|
| Version of the schema the FieldPath is written in terms of, defaults to “v1”. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Container name: required for volumes, optional for env vars |
|
| Specifies the output format of the exposed resources, defaults to “1” |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| 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[].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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| Optional: FC target lun number |
|
| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| Optional: FC target worldwide names (WWNs) |
|
| 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[].flexVolume
Description
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
Type
object
Required
driver
Property | Type | Description |
---|---|---|
|
| Driver is the name of the driver to use for this volume. |
|
| 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. |
|
| Optional: Extra command options if any. |
|
| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| 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.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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| 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 |
|
| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| ReadOnly 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
Property | Type | Description |
---|---|---|
|
| Target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
|
| Repository URL |
|
| 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
endpoints
path
Property | Type | Description |
---|---|---|
|
| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| 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
Property | Type | Description |
---|---|---|
|
| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| Type 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
iqn
lun
targetPortal
Property | Type | Description |
---|---|---|
|
| whether support iSCSI Discovery CHAP authentication |
|
| whether support iSCSI Session CHAP authentication |
|
| 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 |
|
| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
|
| Target iSCSI Qualified Name. |
|
| iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp). |
|
| iSCSI Target Lun number. |
|
| iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
|
| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
| CHAP Secret for iSCSI target and initiator authentication |
|
| 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.secretRef
Description
CHAP Secret for iSCSI target and initiator authentication
Type
object
Property | Type | Description |
---|---|---|
|
| 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
path
server
Property | Type | Description |
---|---|---|
|
| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| Server 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
Property | Type | Description |
---|---|---|
|
| 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 |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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. |
|
| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| VolumeID uniquely identifies a Portworx volume |
.spec.config.volumes[].projected
Description
Items for all in one resources secrets, configmaps, and downward API
Type
object
Required
sources
Property | Type | Description |
---|---|---|
|
| Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| list of volume projections |
|
| Projection that may be projected along with other supported volume types |
.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
Property | Type | Description |
---|---|---|
|
| information about the configMap data to project |
|
| information about the downwardAPI data to project |
|
| information about the secret data to project |
|
| information about the serviceAccountToken data to project |
.spec.config.volumes[].projected.sources[].configMap
Description
information about the configMap data to project
Type
object
Property | Type | 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 ‘..’. |
|
| Maps a string key to a path within a volume. |
|
| 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? |
|
| 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
key
path
Property | Type | Description |
---|---|---|
|
| The key to project. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Items is a list of DownwardAPIVolume file |
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
.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
Property | Type | Description |
---|---|---|
|
| Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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 ‘..’ |
|
| 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
Property | Type | Description |
---|---|---|
|
| Version of the schema the FieldPath is written in terms of, defaults to “v1”. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Container name: required for volumes, optional for env vars |
|
| Specifies the output format of the exposed resources, defaults to “1” |
|
| Required: resource to select |
.spec.config.volumes[].projected.sources[].secret
Description
information about the secret data to project
Type
object
Property | Type | 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 ‘..’. |
|
| Maps a string key to a path within a volume. |
|
| 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? |
|
| 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
key
path
Property | Type | Description |
---|---|---|
|
| The key to project. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
| ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
| Path 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
registry
volume
Property | Type | Description |
---|---|---|
|
| Group to map volume access to Default is no group |
|
| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
| User to map volume access to Defaults to serivceaccount user |
|
| 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
image
monitors
Property | Type | Description |
---|---|---|
|
| 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 |
|
| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| 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 |
|
| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| SecretRef 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 |
|
| 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.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
Property | Type | Description |
---|---|---|
|
| 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
gateway
secretRef
system
Property | Type | Description |
---|---|---|
|
| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”. |
|
| The host address of the ScaleIO API Gateway. |
|
| The name of the ScaleIO Protection Domain for the configured storage. |
|
| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
| Flag to enable/disable SSL communication with Gateway, default false |
|
| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
| The ScaleIO Storage Pool associated with the protection domain. |
|
| The name of the storage system as configured in ScaleIO. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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 ‘..’. |
|
| Maps a string key to a path within a volume. |
|
| Specify whether the Secret or its keys must be defined |
|
| 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
key
path
Property | Type | Description |
---|---|---|
|
| The key to project. |
|
| Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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. |
|
| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
| SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| 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. |
|
| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
| Storage Policy Based Management (SPBM) profile name. |
|
| Path that identifies vSphere volume vmdk |
.status
Description
Type
object
Required
lastUpdated
Property | Type | Description |
---|---|---|
|
| CatalogHealth contains the Subscription’s view of its relevant CatalogSources’ status. It is used to determine SubscriptionStatusConditions related to CatalogSources. |
|
| SubscriptionCatalogHealth describes the health of a CatalogSource the Subscription knows about. |
|
| Conditions is a list of the latest available observations about a Subscription’s current state. |
|
| SubscriptionCondition represents the latest available observations of a Subscription’s state. |
|
| CurrentCSV is the CSV the Subscription is progressing to. |
|
| InstallPlanGeneration is the current generation of the installplan |
|
| InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription’s current CSV. |
|
| InstalledCSV is the CSV currently installed by the Subscription. |
|
| Install is a reference to the latest InstallPlan generated for the Subscription. DEPRECATED: InstallPlanRef |
|
| LastUpdated represents the last time that the Subscription status was updated. |
|
| Reason is the reason the Subscription was transitioned to its current state. |
|
| 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
catalogSourceRef
healthy
lastUpdated
Property | Type | Description |
---|---|---|
|
| CatalogSourceRef is a reference to a CatalogSource. |
|
| Healthy is true if the CatalogSource is healthy; false otherwise. |
|
| LastUpdated represents the last time that the CatalogSourceHealth changed |
.status.catalogHealth[].catalogSourceRef
Description
CatalogSourceRef is a reference to a CatalogSource.
Type
object
Property | Type | Description |
---|---|---|
|
| API version of the referent. |
|
| 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. |
|
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| UID 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
status
type
Property | Type | Description |
---|---|---|
|
| LastHeartbeatTime is the last time we got an update on a given condition |
|
| LastTransitionTime is the last time the condition transit from one status to another |
|
| Message is a human-readable message indicating details about last transition. |
|
| Reason is a one-word CamelCase reason for the condition’s last transition. |
|
| Status is the status of the condition, one of True, False, Unknown. |
|
| 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
Property | Type | Description |
---|---|---|
|
| API version of the referent. |
|
| 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. |
|
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| UID 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
apiVersion
kind
name
uuid
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| 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/subscriptions
GET
: list objects of kind Subscription
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions
DELETE
: delete collection of SubscriptionGET
: list objects of kind SubscriptionPOST
: create a Subscription
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}
DELETE
: delete a SubscriptionGET
: read the specified SubscriptionPATCH
: partially update the specified SubscriptionPUT
: replace the specified Subscription
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status
GET
: read status of the specified SubscriptionPATCH
: partially update status of the specified SubscriptionPUT
: replace status of the specified Subscription
/apis/operators.coreos.com/v1alpha1/subscriptions
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| If ‘true’, then the output is pretty printed. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
list objects of kind Subscription
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of Subscription
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind Subscription
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | Empty |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Subscription |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
202 - Accepted | |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | Empty |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the Subscription |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read status of the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified Subscription
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | Empty |