This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Reference

Reference documentation for Custom Resource Definitions (CRDs)

1 - SpinApp

Custom Resource Definition (CRD) reference for SpinApp

Resource Types:

SpinApp

SpinApp is the Schema for the spinapps API

NameTypeDescriptionRequired
apiVersionstringcore.spinoperator.dev/v1alpha1true
kindstringSpinApptrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectSpinAppSpec defines the desired state of SpinApp
false
statusobjectSpinAppStatus defines the observed state of SpinApp
false

SpinApp.spec

back to parent

SpinAppSpec defines the desired state of SpinApp

NameTypeDescriptionRequired
executorstringExecutor controls how this app is executed in the cluster.

Defaults to whatever executor is available on the cluster. If multiple executors are available then the first executor in alphabetical order will be chosen. If no executors are available then no default will be set.

true
imagestringImage is the source for this app.
true
checksobjectChecks defines health checks that should be used by Kubernetes to monitor the application.
false
deploymentAnnotationsmap[string]stringDeploymentAnnotations defines annotations to be applied to the underlying deployment.
false
enableAutoscalingbooleanEnableAutoscaling indicates whether the app is allowed to autoscale. If true then the operator leaves the replica count of the underlying deployment to be managed by an external autoscaler (HPA/KEDA). Replicas cannot be defined if this is enabled. By default EnableAutoscaling is false.

Default: false
false
imagePullSecrets[]objectImagePullSecrets is a list of references to secrets in the same namespace to use for pulling the image.
false
podAnnotationsmap[string]stringPodAnnotations defines annotations to be applied to the underlying pods.
false
replicasintegerNumber of replicas to run.

Format: int32
false
resourcesobjectResources defines the resource requirements for this app.
false
runtimeConfigobjectRuntimeConfig defines configuration to be applied at runtime for this app.
false
serviceAnnotationsmap[string]stringServiceAnnotations defines annotations to be applied to the underlying service.
false
variables[]objectVariables provide Kubernetes Bindings to Spin App Variables.
false
volumeMounts[]objectVolumeMounts defines how volumes are mounted in the underlying containers.
false
volumes[]objectVolumes defines the volumes to be mounted in the underlying pods.
false

SpinApp.spec.checks

back to parent

Checks defines health checks that should be used by Kubernetes to monitor the application.

NameTypeDescriptionRequired
livenessobjectLiveness defines the liveness probe for the application.
false
readinessobjectReadiness defines the readiness probe for the application.
false

SpinApp.spec.checks.liveness

back to parent

Liveness defines the liveness probe for the application.

NameTypeDescriptionRequired
failureThresholdintegerMinimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Format: int32
Default: 3
false
httpGetobjectHTTPGet describes a health check that should be performed using a GET request.
false
initialDelaySecondsintegerNumber of seconds after the app has started before liveness probes are initiated. Default 10s.

Format: int32
Default: 10
false
periodSecondsintegerHow often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Format: int32
Default: 10
false
successThresholdintegerMinimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

Format: int32
Default: 1
false
timeoutSecondsintegerNumber of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.

Format: int32
Default: 1
false

SpinApp.spec.checks.liveness.httpGet

back to parent

HTTPGet describes a health check that should be performed using a GET request.

NameTypeDescriptionRequired
pathstringPath is the path that should be used when calling the application for a health check, e.g /healthz.
true
httpHeaders[]objectHTTPHeaders are headers that should be included in the health check request.
false

SpinApp.spec.checks.liveness.httpGet.httpHeaders[index]

back to parent

HTTPHealthProbeHeader is an abstraction around a http header key/value pair.

NameTypeDescriptionRequired
namestring
true
valuestring
true

SpinApp.spec.checks.readiness

back to parent

Readiness defines the readiness probe for the application.

NameTypeDescriptionRequired
failureThresholdintegerMinimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Format: int32
Default: 3
false
httpGetobjectHTTPGet describes a health check that should be performed using a GET request.
false
initialDelaySecondsintegerNumber of seconds after the app has started before liveness probes are initiated. Default 10s.

Format: int32
Default: 10
false
periodSecondsintegerHow often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Format: int32
Default: 10
false
successThresholdintegerMinimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

Format: int32
Default: 1
false
timeoutSecondsintegerNumber of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.

Format: int32
Default: 1
false

SpinApp.spec.checks.readiness.httpGet

back to parent

HTTPGet describes a health check that should be performed using a GET request.

NameTypeDescriptionRequired
pathstringPath is the path that should be used when calling the application for a health check, e.g /healthz.
true
httpHeaders[]objectHTTPHeaders are headers that should be included in the health check request.
false

SpinApp.spec.checks.readiness.httpGet.httpHeaders[index]

back to parent

HTTPHealthProbeHeader is an abstraction around a http header key/value pair.

NameTypeDescriptionRequired
namestring
true
valuestring
true

SpinApp.spec.imagePullSecrets[index]

back to parent

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

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

SpinApp.spec.resources

back to parent

Resources defines the resource requirements for this app.

NameTypeDescriptionRequired
limitsmap[string]int or stringLimits describes the maximum amount of compute resources allowed.
false
requestsmap[string]int or stringRequests 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. Requests cannot exceed Limits.
false

SpinApp.spec.runtimeConfig

back to parent

RuntimeConfig defines configuration to be applied at runtime for this app.

NameTypeDescriptionRequired
keyValueStores[]object
false
llmComputeobject
false
loadFromSecretstringLoadFromSecret is the name of the secret to load runtime config from. The secret should have a single key named "runtime-config.toml" that contains the base64 encoded runtime config. If this is provided all other runtime config is ignored.
false
sqliteDatabases[]objectSqliteDatabases provides spin bindings to different SQLite database providers. e.g on-disk or turso.
false

SpinApp.spec.runtimeConfig.keyValueStores[index]

back to parent

NameTypeDescriptionRequired
namestring
true
typestring
true
options[]object
false

SpinApp.spec.runtimeConfig.keyValueStores[index].options[index]

back to parent

NameTypeDescriptionRequired
namestringName of the config option.
true
valuestringValue is the static value to bind to the variable.
false
valueFromobjectValueFrom is a reference to dynamically bind the variable to.
false

SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom

back to parent

ValueFrom is a reference to dynamically bind the variable to.

NameTypeDescriptionRequired
configMapKeyRefobjectSelects a key of a ConfigMap.
false
secretKeyRefobjectSelects a key of a secret in the apps namespace
false

SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom.configMapKeyRef

back to parent

Selects a key of a ConfigMap.

NameTypeDescriptionRequired
keystringThe key to select.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the ConfigMap or its key must be defined
false

SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom.secretKeyRef

back to parent

Selects a key of a secret in the apps namespace

NameTypeDescriptionRequired
keystringThe key of the secret to select from. Must be a valid secret key.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the Secret or its key must be defined
false

SpinApp.spec.runtimeConfig.llmCompute

back to parent

NameTypeDescriptionRequired
typestring
true
options[]object
false

SpinApp.spec.runtimeConfig.llmCompute.options[index]

back to parent

NameTypeDescriptionRequired
namestringName of the config option.
true
valuestringValue is the static value to bind to the variable.
false
valueFromobjectValueFrom is a reference to dynamically bind the variable to.
false

SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom

back to parent

ValueFrom is a reference to dynamically bind the variable to.

NameTypeDescriptionRequired
configMapKeyRefobjectSelects a key of a ConfigMap.
false
secretKeyRefobjectSelects a key of a secret in the apps namespace
false

SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom.configMapKeyRef

back to parent

Selects a key of a ConfigMap.

NameTypeDescriptionRequired
keystringThe key to select.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the ConfigMap or its key must be defined
false

SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom.secretKeyRef

back to parent

Selects a key of a secret in the apps namespace

NameTypeDescriptionRequired
keystringThe key of the secret to select from. Must be a valid secret key.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the Secret or its key must be defined
false

SpinApp.spec.runtimeConfig.sqliteDatabases[index]

back to parent

NameTypeDescriptionRequired
namestring
true
typestring
true
options[]object
false

SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index]

back to parent

NameTypeDescriptionRequired
namestringName of the config option.
true
valuestringValue is the static value to bind to the variable.
false
valueFromobjectValueFrom is a reference to dynamically bind the variable to.
false

SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom

back to parent

ValueFrom is a reference to dynamically bind the variable to.

NameTypeDescriptionRequired
configMapKeyRefobjectSelects a key of a ConfigMap.
false
secretKeyRefobjectSelects a key of a secret in the apps namespace
false

SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom.configMapKeyRef

back to parent

Selects a key of a ConfigMap.

NameTypeDescriptionRequired
keystringThe key to select.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the ConfigMap or its key must be defined
false

SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom.secretKeyRef

back to parent

Selects a key of a secret in the apps namespace

NameTypeDescriptionRequired
keystringThe key of the secret to select from. Must be a valid secret key.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the Secret or its key must be defined
false

SpinApp.spec.variables[index]

back to parent

SpinVar defines a binding between a spin variable and a static or dynamic value.

NameTypeDescriptionRequired
namestringName of the variable to bind.
true
valuestringValue is the static value to bind to the variable.
false
valueFromobjectValueFrom is a reference to dynamically bind the variable to.
false

SpinApp.spec.variables[index].valueFrom

back to parent

ValueFrom is a reference to dynamically bind the variable to.

NameTypeDescriptionRequired
configMapKeyRefobjectSelects a key of a ConfigMap.
false
fieldRefobjectSelects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
false
resourceFieldRefobjectSelects 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.
false
secretKeyRefobjectSelects a key of a secret in the pod's namespace
false

SpinApp.spec.variables[index].valueFrom.configMapKeyRef

back to parent

Selects a key of a ConfigMap.

NameTypeDescriptionRequired
keystringThe key to select.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the ConfigMap or its key must be defined
false

SpinApp.spec.variables[index].valueFrom.fieldRef

back to parent

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.

NameTypeDescriptionRequired
fieldPathstringPath of the field to select in the specified API version.
true
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".
false

SpinApp.spec.variables[index].valueFrom.resourceFieldRef

back to parent

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.

NameTypeDescriptionRequired
resourcestringRequired: resource to select
true
containerNamestringContainer name: required for volumes, optional for env vars
false
divisorint or stringSpecifies the output format of the exposed resources, defaults to "1"
false

SpinApp.spec.variables[index].valueFrom.secretKeyRef

back to parent

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

NameTypeDescriptionRequired
keystringThe key of the secret to select from. Must be a valid secret key.
true
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanSpecify whether the Secret or its key must be defined
false

SpinApp.spec.volumeMounts[index]

back to parent

VolumeMount describes a mounting of a Volume within a container.

NameTypeDescriptionRequired
mountPathstringPath within the container at which the volume should be mounted. Must not contain ':'.
true
namestringThis must match the Name of a Volume.
true
mountPropagationstringmountPropagation 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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
false
readOnlybooleanMounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
false
recursiveReadOnlystringRecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

false
subPathstringPath within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
false
subPathExprstringExpanded 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.
false

SpinApp.spec.volumes[index]

back to parent

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

NameTypeDescriptionRequired
namestringname of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
true
awsElasticBlockStoreobjectawsElasticBlockStore 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
false
azureDiskobjectazureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
false
azureFileobjectazureFile represents an Azure File Service mount on the host and bind mount to the pod.
false
cephfsobjectcephFS represents a Ceph FS mount on the host that shares a pod's lifetime
false
cinderobjectcinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
false
configMapobjectconfigMap represents a configMap that should populate this volume
false
csiobjectcsi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
false
downwardAPIobjectdownwardAPI represents downward API about the pod that should populate this volume
false
emptyDirobjectemptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
false
ephemeralobjectephemeral 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.

false
fcobjectfc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
false
flexVolumeobjectflexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
false
flockerobjectflocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running
false
gcePersistentDiskobjectgcePersistentDisk 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
false
gitRepoobjectgitRepo 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.
false
glusterfsobjectglusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
false
hostPathobjecthostPath 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.

false
iscsiobjectiscsi 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
false
nfsobjectnfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
false
persistentVolumeClaimobjectpersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
false
photonPersistentDiskobjectphotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
false
portworxVolumeobjectportworxVolume represents a portworx volume attached and mounted on kubelets host machine
false
projectedobjectprojected items for all in one resources secrets, configmaps, and downward API
false
quobyteobjectquobyte represents a Quobyte mount on the host that shares a pod’s lifetime
false
rbdobjectrbd 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
false
scaleIOobjectscaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
false
secretobjectsecret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
false
storageosobjectstorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
false
vsphereVolumeobjectvsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
false

SpinApp.spec.volumes[index].awsElasticBlockStore

back to parent

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

NameTypeDescriptionRequired
volumeIDstringvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
true
fsTypestringfsType is the 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
false
partitionintegerpartition is 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).

Format: int32
false
readOnlybooleanreadOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
false

SpinApp.spec.volumes[index].azureDisk

back to parent

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

NameTypeDescriptionRequired
diskNamestringdiskName is the Name of the data disk in the blob storage
true
diskURIstringdiskURI is the URI of data disk in the blob storage
true
cachingModestringcachingMode is the Host Caching mode: None, Read Only, Read Write.
false
fsTypestringfsType is 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.
false
kindstringkind expected values are 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
false
readOnlybooleanreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false

SpinApp.spec.volumes[index].azureFile

back to parent

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

NameTypeDescriptionRequired
secretNamestringsecretName is the name of secret that contains Azure Storage Account Name and Key
true
shareNamestringshareName is the azure share Name
true
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false

SpinApp.spec.volumes[index].cephfs

back to parent

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

NameTypeDescriptionRequired
monitors[]stringmonitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
true
pathstringpath is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
false
readOnlybooleanreadOnly 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
false
secretFilestringsecretFile is 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
false
secretRefobjectsecretRef is 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
false
userstringuser is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
false

SpinApp.spec.volumes[index].cephfs.secretRef

back to parent

secretRef is 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

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

SpinApp.spec.volumes[index].cinder

back to parent

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

NameTypeDescriptionRequired
volumeIDstringvolumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
true
fsTypestringfsType is the 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
false
readOnlybooleanreadOnly 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
false
secretRefobjectsecretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
false

SpinApp.spec.volumes[index].cinder.secretRef

back to parent

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

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

SpinApp.spec.volumes[index].configMap

back to parent

configMap represents a configMap that should populate this volume

NameTypeDescriptionRequired
defaultModeintegerdefaultMode is 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.

Format: int32
false
items[]objectitems 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 '..'.
false
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanoptional specify whether the ConfigMap or its keys must be defined
false

SpinApp.spec.volumes[index].configMap.items[index]

back to parent

Maps a string key to a path within a volume.

NameTypeDescriptionRequired
keystringkey is the key to project.
true
pathstringpath is 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 '..'.
true
modeintegermode is 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.

Format: int32
false

SpinApp.spec.volumes[index].csi

back to parent

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

NameTypeDescriptionRequired
driverstringdriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
true
fsTypestringfsType 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.
false
nodePublishSecretRefobjectnodePublishSecretRef 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.
false
readOnlybooleanreadOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
false
volumeAttributesmap[string]stringvolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
false

SpinApp.spec.volumes[index].csi.nodePublishSecretRef

back to parent

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.

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

SpinApp.spec.volumes[index].downwardAPI

back to parent

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

NameTypeDescriptionRequired
defaultModeintegerOptional: 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.

Format: int32
false
items[]objectItems is a list of downward API volume file
false

SpinApp.spec.volumes[index].downwardAPI.items[index]

back to parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

NameTypeDescriptionRequired
pathstringRequired: 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 '..'
true
fieldRefobjectRequired: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
false
modeintegerOptional: 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.

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

SpinApp.spec.volumes[index].downwardAPI.items[index].fieldRef

back to parent

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

NameTypeDescriptionRequired
fieldPathstringPath of the field to select in the specified API version.
true
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".
false

SpinApp.spec.volumes[index].downwardAPI.items[index].resourceFieldRef

back to parent

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

NameTypeDescriptionRequired
resourcestringRequired: resource to select
true
containerNamestringContainer name: required for volumes, optional for env vars
false
divisorint or stringSpecifies the output format of the exposed resources, defaults to "1"
false

SpinApp.spec.volumes[index].emptyDir

back to parent

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

NameTypeDescriptionRequired
mediumstringmedium represents 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
false
sizeLimitint or stringsizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
false

SpinApp.spec.volumes[index].ephemeral

back to parent

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.

NameTypeDescriptionRequired
volumeClaimTemplateobjectWill 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 `-` where `` 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.

false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate

back to parent

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.

NameTypeDescriptionRequired
specobjectThe 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.
true
metadataobjectMay 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.
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec

back to parent

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.

NameTypeDescriptionRequired
accessModes[]stringaccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
false
dataSourceobjectdataSource 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. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
false
dataSourceRefobjectdataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, 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. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three 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. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
false
resourcesobjectresources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
false
selectorobjectselector is a label query over volumes to consider for binding.
false
storageClassNamestringstorageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
false
volumeAttributesClassNamestringvolumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
false
volumeModestringvolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
false
volumeNamestringvolumeName is the binding reference to the PersistentVolume backing this claim.
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

back to parent

dataSource 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. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
NameTypeDescriptionRequired
kindstringKind is the type of resource being referenced
true
namestringName is the name of resource being referenced
true
apiGroupstringAPIGroup 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.
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

back to parent

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any 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, when namespace isn’t specified in dataSourceRef, 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. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three 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.
  • While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
NameTypeDescriptionRequired
kindstringKind is the type of resource being referenced
true
namestringName is the name of resource being referenced
true
apiGroupstringAPIGroup 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.
false
namespacestringNamespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

back to parent

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

NameTypeDescriptionRequired
limitsmap[string]int or stringLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false
requestsmap[string]int or stringRequests 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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

back to parent

selector is a label query over volumes to consider for binding.

NameTypeDescriptionRequired
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
false
matchLabelsmap[string]stringmatchLabels 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.
false

SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

back to parent

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

NameTypeDescriptionRequired
keystringkey is the label key that the selector applies to.
true
operatorstringoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
true
values[]stringvalues 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.
false

SpinApp.spec.volumes[index].fc

back to parent

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

NameTypeDescriptionRequired
fsTypestringfsType is the 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
false
lunintegerlun is Optional: FC target lun number

Format: int32
false
readOnlybooleanreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs[]stringtargetWWNs is Optional: FC target worldwide names (WWNs)
false
wwids[]stringwwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
false

SpinApp.spec.volumes[index].flexVolume

back to parent

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

NameTypeDescriptionRequired
driverstringdriver is the name of the driver to use for this volume.
true
fsTypestringfsType is the 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.
false
optionsmap[string]stringoptions is Optional: this field holds extra command options if any.
false
readOnlybooleanreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
secretRefobjectsecretRef is 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.
false

SpinApp.spec.volumes[index].flexVolume.secretRef

back to parent

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

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

SpinApp.spec.volumes[index].flocker

back to parent

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

NameTypeDescriptionRequired
datasetNamestringdatasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
false
datasetUUIDstringdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
false

SpinApp.spec.volumes[index].gcePersistentDisk

back to parent

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

NameTypeDescriptionRequired
pdNamestringpdName is 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
true
fsTypestringfsType is 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
false
partitionintegerpartition is 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

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

SpinApp.spec.volumes[index].gitRepo

back to parent

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.

NameTypeDescriptionRequired
repositorystringrepository is the URL
true
directorystringdirectory is the 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.
false
revisionstringrevision is the commit hash for the specified revision.
false

SpinApp.spec.volumes[index].glusterfs

back to parent

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

NameTypeDescriptionRequired
endpointsstringendpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
true
pathstringpath is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
true
readOnlybooleanreadOnly 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
false

SpinApp.spec.volumes[index].hostPath

back to parent

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.

NameTypeDescriptionRequired
pathstringpath 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
true
typestringtype for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
false

SpinApp.spec.volumes[index].iscsi

back to parent

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

NameTypeDescriptionRequired
iqnstringiqn is the target iSCSI Qualified Name.
true
lunintegerlun represents iSCSI Target Lun number.

Format: int32
true
targetPortalstringtargetPortal is 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).
true
chapAuthDiscoverybooleanchapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
false
chapAuthSessionbooleanchapAuthSession defines whether support iSCSI Session CHAP authentication
false
fsTypestringfsType is the 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
false
initiatorNamestringinitiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
false
iscsiInterfacestringiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
false
portals[]stringportals is the 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).
false
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
false
secretRefobjectsecretRef is the CHAP Secret for iSCSI target and initiator authentication
false

SpinApp.spec.volumes[index].iscsi.secretRef

back to parent

secretRef is the CHAP Secret for iSCSI target and initiator authentication

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

SpinApp.spec.volumes[index].nfs

back to parent

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

NameTypeDescriptionRequired
pathstringpath that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
true
serverstringserver is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
true
readOnlybooleanreadOnly 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
false

SpinApp.spec.volumes[index].persistentVolumeClaim

back to parent

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

NameTypeDescriptionRequired
claimNamestringclaimName 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
true
readOnlybooleanreadOnly Will force the ReadOnly setting in VolumeMounts. Default false.
false

SpinApp.spec.volumes[index].photonPersistentDisk

back to parent

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

NameTypeDescriptionRequired
pdIDstringpdID is the ID that identifies Photon Controller persistent disk
true
fsTypestringfsType is the 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.
false

SpinApp.spec.volumes[index].portworxVolume

back to parent

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

NameTypeDescriptionRequired
volumeIDstringvolumeID uniquely identifies a Portworx volume
true
fsTypestringfSType 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.
false
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false

SpinApp.spec.volumes[index].projected

back to parent

projected items for all in one resources secrets, configmaps, and downward API

NameTypeDescriptionRequired
defaultModeintegerdefaultMode are the 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.

Format: int32
false
sources[]objectsources is the list of volume projections
false

SpinApp.spec.volumes[index].projected.sources[index]

back to parent

Projection that may be projected along with other supported volume types

NameTypeDescriptionRequired
clusterTrustBundleobjectClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

false
configMapobjectconfigMap information about the configMap data to project
false
downwardAPIobjectdownwardAPI information about the downwardAPI data to project
false
secretobjectsecret information about the secret data to project
false
serviceAccountTokenobjectserviceAccountToken is information about the serviceAccountToken data to project
false

SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle

back to parent

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

NameTypeDescriptionRequired
pathstringRelative path from the volume root to write the bundle.
true
labelSelectorobjectSelect all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
false
namestringSelect a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
false
optionalbooleanIf true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
false
signerNamestringSelect all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
false

SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector

back to parent

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.

NameTypeDescriptionRequired
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
false
matchLabelsmap[string]stringmatchLabels 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.
false

SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

back to parent

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

NameTypeDescriptionRequired
keystringkey is the label key that the selector applies to.
true
operatorstringoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
true
values[]stringvalues 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.
false

SpinApp.spec.volumes[index].projected.sources[index].configMap

back to parent

configMap information about the configMap data to project

NameTypeDescriptionRequired
items[]objectitems 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 '..'.
false
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanoptional specify whether the ConfigMap or its keys must be defined
false

SpinApp.spec.volumes[index].projected.sources[index].configMap.items[index]

back to parent

Maps a string key to a path within a volume.

NameTypeDescriptionRequired
keystringkey is the key to project.
true
pathstringpath is 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 '..'.
true
modeintegermode is 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.

Format: int32
false

SpinApp.spec.volumes[index].projected.sources[index].downwardAPI

back to parent

downwardAPI information about the downwardAPI data to project

NameTypeDescriptionRequired
items[]objectItems is a list of DownwardAPIVolume file
false

SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index]

back to parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

NameTypeDescriptionRequired
pathstringRequired: 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 '..'
true
fieldRefobjectRequired: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
false
modeintegerOptional: 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.

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

SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

back to parent

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

NameTypeDescriptionRequired
fieldPathstringPath of the field to select in the specified API version.
true
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".
false

SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

back to parent

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

NameTypeDescriptionRequired
resourcestringRequired: resource to select
true
containerNamestringContainer name: required for volumes, optional for env vars
false
divisorint or stringSpecifies the output format of the exposed resources, defaults to "1"
false

SpinApp.spec.volumes[index].projected.sources[index].secret

back to parent

secret information about the secret data to project

NameTypeDescriptionRequired
items[]objectitems 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 '..'.
false
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false
optionalbooleanoptional field specify whether the Secret or its key must be defined
false

SpinApp.spec.volumes[index].projected.sources[index].secret.items[index]

back to parent

Maps a string key to a path within a volume.

NameTypeDescriptionRequired
keystringkey is the key to project.
true
pathstringpath is 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 '..'.
true
modeintegermode is 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.

Format: int32
false

SpinApp.spec.volumes[index].projected.sources[index].serviceAccountToken

back to parent

serviceAccountToken is information about the serviceAccountToken data to project

NameTypeDescriptionRequired
pathstringpath is the path relative to the mount point of the file to project the token into.
true
audiencestringaudience 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.
false
expirationSecondsintegerexpirationSeconds 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.

Format: int64
false

SpinApp.spec.volumes[index].quobyte

back to parent

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

NameTypeDescriptionRequired
registrystringregistry 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
true
volumestringvolume is a string that references an already created Quobyte volume by name.
true
groupstringgroup to map volume access to Default is no group
false
readOnlybooleanreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
false
tenantstringtenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
false
userstringuser to map volume access to Defaults to serivceaccount user
false

SpinApp.spec.volumes[index].rbd

back to parent

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

NameTypeDescriptionRequired
imagestringimage is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
monitors[]stringmonitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
fsTypestringfsType is the 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
false
keyringstringkeyring 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
false
poolstringpool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
false
readOnlybooleanreadOnly 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
false
secretRefobjectsecretRef 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
false
userstringuser is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
false

SpinApp.spec.volumes[index].rbd.secretRef

back to parent

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

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

SpinApp.spec.volumes[index].scaleIO

back to parent

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

NameTypeDescriptionRequired
gatewaystringgateway is the host address of the ScaleIO API Gateway.
true
secretRefobjectsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
true
systemstringsystem is the name of the storage system as configured in ScaleIO.
true
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
false
protectionDomainstringprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
false
readOnlybooleanreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
sslEnabledbooleansslEnabled Flag enable/disable SSL communication with Gateway, default false
false
storageModestringstorageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
false
storagePoolstringstoragePool is the ScaleIO Storage Pool associated with the protection domain.
false
volumeNamestringvolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
false

SpinApp.spec.volumes[index].scaleIO.secretRef

back to parent

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

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

SpinApp.spec.volumes[index].secret

back to parent

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

NameTypeDescriptionRequired
defaultModeintegerdefaultMode is 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.

Format: int32
false
items[]objectitems 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 '..'.
false
optionalbooleanoptional field specify whether the Secret or its keys must be defined
false
secretNamestringsecretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
false

SpinApp.spec.volumes[index].secret.items[index]

back to parent

Maps a string key to a path within a volume.

NameTypeDescriptionRequired
keystringkey is the key to project.
true
pathstringpath is 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 '..'.
true
modeintegermode is 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.

Format: int32
false

SpinApp.spec.volumes[index].storageos

back to parent

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

NameTypeDescriptionRequired
fsTypestringfsType is the 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.
false
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
secretRefobjectsecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
false
volumeNamestringvolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
false
volumeNamespacestringvolumeNamespace 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.
false

SpinApp.spec.volumes[index].storageos.secretRef

back to parent

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

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

SpinApp.spec.volumes[index].vsphereVolume

back to parent

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

NameTypeDescriptionRequired
volumePathstringvolumePath is the path that identifies vSphere volume vmdk
true
fsTypestringfsType is 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.
false
storagePolicyIDstringstoragePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
false
storagePolicyNamestringstoragePolicyName is the storage Policy Based Management (SPBM) profile name.
false

SpinApp.status

back to parent

SpinAppStatus defines the observed state of SpinApp

NameTypeDescriptionRequired
readyReplicasintegerRepresents the current number of active replicas on the application deployment.

Format: int32
true
activeSchedulerstringActiveScheduler is the name of the scheduler that is currently scheduling this SpinApp.
false
conditions[]objectRepresents the observations of a SpinApps's current state. SpinApp.status.conditions.type are: "Available" and "Progressing" SpinApp.status.conditions.status are one of True, False, Unknown. SpinApp.status.conditions.reason the value should be a CamelCase string and producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. SpinApp.status.conditions.Message is a human readable message indicating details about the transition. For further information see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
false

SpinApp.status.conditions[index]

back to parent

Condition contains details for one aspect of the current state of this API Resource.

This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`


    // other fields
}
NameTypeDescriptionRequired
lastTransitionTimestringlastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
true
reasonstringreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
statusenumstatus of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
true
observedGenerationintegerobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
Minimum: 0
false

2 - SpinAppExecutor

Custom Resource Definition (CRD) reference for SpinAppExecutor

Resource Types:

SpinAppExecutor

SpinAppExecutor is the Schema for the spinappexecutors API

NameTypeDescriptionRequired
apiVersionstringcore.spinoperator.dev/v1alpha1true
kindstringSpinAppExecutortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectSpinAppExecutorSpec defines the desired state of SpinAppExecutor
false
statusobjectSpinAppExecutorStatus defines the observed state of SpinAppExecutor
false

SpinAppExecutor.spec

back to parent

SpinAppExecutorSpec defines the desired state of SpinAppExecutor

NameTypeDescriptionRequired
createDeploymentbooleanCreateDeployment specifies whether the Executor wants the SpinKube operator to create a deployment for the application or if it will be realized externally.
true
deploymentConfigobjectDeploymentConfig specifies how the deployment should be configured when createDeployment is true.
false

SpinAppExecutor.spec.deploymentConfig

back to parent

DeploymentConfig specifies how the deployment should be configured when createDeployment is true.

NameTypeDescriptionRequired
runtimeClassNamestringRuntimeClassName is the runtime class name that should be used by pods created as part of a deployment.
true
caCertSecretstringCACertSecret specifies the name of the secret containing the CA certificates to be mounted to the deployment.
false
installDefaultCACertsbooleanInstallDefaultCACerts specifies whether the default CA certificate bundle should be generated. When set a new secret will be created containing the certificates. If no secret name is defined in `CACertSecret` the secret name will be `spin-ca`.
false