Skip to main content
Version: 3.1

storagecluster-crd

StorageCluster Schema

FieldDescriptionType
spec.metadataMetadata contains metadata for different storage cluster components.object
spec.resourcesSpecifies the compute resource requirements for the storage pod.object
spec.imageDocker image of the storage driver.string
spec.versionVersion of the storage driver. This field is read-only.string
spec.imagePullPolicyImage pull policy. One of Always, Never, IfNotPresent. Defaults to Always.string
spec.imagePullSecretImage pull secret is a reference to secret in the same namespace as the StorageCluster. It is used for pulling all images used by the StorageCluster.string
spec.customImageRegistryCustom container image registry server that will be used instead of index.docker.io to download Docker images. This may include the repository as well. (Example: myregistry.net:5443 or myregistry.com/myrepository)string
spec.preserveFullCustomImageRegistrySetting this to true this stops part of the image tag being swallowed when setting a customImageRegistry with a / in it. When set to false using a customImageRegistry of example.io/public and an image of portworx/oci-monitor the full image path is is example.io/public/oci-monitor, setting to true gives you example.io/public/portworx/oci-monitor. Defaults to falseboolean
spec.secretsProviderSecrets provider is the name of secret provider that driver will connect to.string
spec.startPortStart port is the starting port in the range of ports used by the cluster.integer
spec.autoUpdateComponentsA strategy to determine how component versions are to be updated automatically.string
spec.updateStrategyAn update strategy to replace existing StorageCluster pods with new pods.object
spec.deleteStrategyDelete strategy to uninstall and wipe the storage cluster.object
spec.revisionHistoryLimitThe number of old history to retain to allow rollback. This is a pointer to distinguish between an explicit zero and not specified. Defaults to 10.integer
spec.featureGatesThis is a map of feature names to string values.object
spec.runtimeOptionsThis is map of any runtime options that need to be sent to the storage driver. The value is a string.object
spec.placementDescribes placement configuration for the storage cluster pods.object
spec.kvdbDetails of KVDB that the storage driver will use.object
spec.storageDetails of the storage used by the storage driver.object
spec.cloudStorageDetails of storage used in cloud environment.object
spec.networkContains network information that is needed by the storage driver.object
spec.storkContains STORK related spec.object
spec.userInterfaceContains spec of a user interface for the storage driver.object
spec.autopilotContains spec of autopilot component for storage driver.object
spec.monitoringContains monitoring configuration for the storage cluster.object
spec.securityContains security configuration for the storage cluster.object
spec.csiContains CSI configuration for the storage cluster.object
spec.portworxApiContains a spec to configure the Portworx API component.object
spec.envList of environment variables used by the driver. This is an array of Kubernetes EnvVar where the value can be given directly or from a source like field, config map or secret.array
spec.nodesNode level configurations that will override the configuration at cluster level. These configurations can be for individual nodes or can be grouped to override configuration of multiple nodes based on label selectors.array

metadata configuration

FieldDescriptionType
spec.metadata.annotationsThe annotations section of spec is a map of map to pass custom annotations to different storage cluster components. The key specifies component in format of "kind/component", e.g. "deployment/stork" to pass custom annotations to stork deployment. The value is a map of string that contains custom annotation key and value pairs.object
spec.metadata.labelsThe labels section of spec is a map of map to pass custom labels to different storage cluster components. The key specifies component in format of "kind/component", e.g. "service/portworx-api" to pass custom labels to portworx-api service. The value is a map of string that contains custom label key and value pairs.object

resources configuration

FieldDescriptionType
spec.resources.requestsRequested resources for the storage pod.object
spec.resources.requests.memoryRequested memory for the storage pod.string
spec.resources.requests.cpuRequested cpu for the storage pod.string
spec.resources.limitsLimits describes the maximum amount of compute resources allowed for the storage pod.object
spec.resources.limits.memoryMaximum memory for the storage pod.string
spec.resources.limits.cpuMaximum cpu for the storage pod.string

updateStrategy configuration

FieldDescriptionType
spec.updateStrategy.typeType of storage cluster update. Can be RollingUpdate or OnDelete. Default is RollingUpdate.string
spec.updateStrategy.rollingUpdateSpec to control the desired behavior of storage cluster rolling update.object
spec.updateStrategy.rollingUpdate.minReadySecondsMinimum number of seconds for which a newly created Portworx pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).integer

deleteStrategy configuration

FieldDescriptionType
spec.deleteStrategy.typeType of storage cluster delete. Can be Uninstall or UninstallAndWipe. There is no default delete strategy. When no delete strategy only objects managed by the StorageCluster controller and owned by the StorageCluster object are deleted. The storage driver will be left in a state where it will not be managed by any object. Uninstall strategy ensures that the cluster is completely uninstalled even from the storage driver perspective. UninstallAndWipe strategy ensures that the cluster is completely uninstalled as well as the storage devices and metadata are wiped for reuse. This may result in data loss.string

placement configuration

FieldDescriptionType
spec.placement.nodeAffinityDescribes node affinity scheduling rules for the storage cluster pods. This is exactly the same object as Kubernetes node affinity for pods.object
spec.placement.tolerationsTolerations for all the pods deployed by the StorageCluster controller. The pod with this toleration attached will tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>.array
spec.placement.tolerations.effectEffect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.string
spec.placement.tolerations.keyKey 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.string
spec.placement.tolerations.operatorOperator 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.string
spec.placement.tolerations.valueValue is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.string
spec.placement.tolerations.tolerationSecondsTolerationSeconds 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.integer

kvdb configuration

FieldDescriptionType
spec.kvdb.internalFlag indicating whether to use internal KVDB or an external KVDB.boolean
spec.kvdb.endpointsIf using external KVDB, this is the list of KVDB endpoints.array
spec.kvdb.authSecretAuthentication secret is the name of Kubernetes secret containing information to authenticate with the external KVDB. It could have the username/password for basic auth, certificate information or an ACL token.string
spec.kvdb.resourcesSpecifies the compute resource requirements for the kvdb pod.object
spec.kvdb.resources.requestsRequested resources for the kvdb pod.object
spec.kvdb.resources.requests.memoryRequested memory for the kvdb pod.string
spec.kvdb.resources.requests.cpuRequested cpu for the kvdb pod.string
spec.kvdb.resources.limitsLimits describes the maximum amount of compute resources allowed for the kvdb pod.object
spec.kvdb.resources.limits.memoryMaximum memory for the kvdb pod.string
spec.kvdb.resources.limits.cpuMaximum cpu for the kvdb pod.string

storage configuration

FieldDescriptionType
spec.storage.useAllUse all available, unformatted, unpartitioned devices. This will be ignored if spec.storage.devices is not empty.boolean
spec.storage.useAllWithPartitionsUse all available unformatted devices. This will be ignored if spec.storage.devices is not empty.boolean
spec.storage.forceUseDisksFlag indicating to use the devices even if there is file system present on it. Note that the devices may be wiped before using.boolean
spec.storage.devicesList of devices to be used by the storage driver.array
spec.storage.cacheDevicesList of cache devices to be used by the storage driver.array
spec.storage.journalDeviceDevice used for journaling.string
spec.storage.systemMetadataDeviceDevice that will be used to store system metadata by the driver.string
spec.storage.kvdbDeviceDevice used for internal KVDB.string

cloudStorage configuration

FieldDescriptionType
spec.cloudStorage.providerCloud provider name.string
spec.cloudStorage.maxStorageNodesMaximum nodes that will have storage in the cluster.integer
spec.cloudStorage.maxStorageNodesPerZoneMaximum nodes in every zone that will have storage in the cluster.integer
spec.cloudStorage.maxStorageNodesPerZonePerNodeGroupMaximum nodes in every zone in every node group that will have storage in the cluster.integer
spec.cloudStorage.nodePoolLabelKubernetes node label key with which nodes are grouped into node pools for storage distribution in cloud environment.string
spec.cloudStorage.deviceSpecsList of storage device specs. A cloud storage device will be created for every spec in the list. The specs will be applied to all nodes in the cluster up to spec.cloudStorage.maxStorageNodes or spec.cloudStorage.maxStorageNodesPerZone or spec.cloudStorage.maxStorageNodesPerZonePerNodeGroup. This will be ignored if spec.cloudStorage.capacitySpecs is present.array
spec.cloudStorage.capacitySpecsList of cluster wide storage types and their capacities. A single capacity spec identifies a storage pool with a set of minimum requested IOPS and size. Based on the cloud provider, the total storage capacity will get divided amongst the nodes. The nodes bearing storage themselves will get uniformly distributed across all the zones.array
spec.cloudStorage.capacitySpecs.minIOPSMinimum IOPS expected from the cloud drive.integer
spec.cloudStorage.capacitySpecs.minCapacityInGiBMinimum capacity for this storage cluster. The total capacity of devices created by this capacity spec should not be less than this number for the entire cluster.integer
spec.cloudStorage.capacitySpecs.maxCapacityInGiBMaximum capacity for this storage cluster. The total capacity of devices created by this capacity spec should not be greater than this number for the entire cluster.integer
spec.cloudStorage.capacitySpecs.optionsAdditional options required to provision the drive in cloud.object
spec.cloudStorage.journalDeviceSpecDevice spec for the journal device.string
spec.cloudStorage.systemMetadataDeviceSpecDevice spec for the metadata device. This device will be used to store system metadata by the driver.string
spec.cloudStorage.kvdbDeviceSpecDevice spec for internal KVDB device.string

network configuration

FieldDescriptionType
spec.network.dataInterfaceName of the network interface used by the storage driver for data traffic.string
spec.network.mgmtInterfaceName of the network interface used by the storage driver for management traffic.string

stork configuration

FieldDescriptionType
spec.stork.enabledFlag indicating whether STORK needs to be enabled.boolean
spec.stork.lockImageFlag indicating if the STORK image needs to be locked to the given image. If the image is not locked, it can be updated by the storage driver during upgrades.boolean
spec.stork.imageDocker image of the STORK container.string
spec.stork.hostNetworkFlag indicating if Stork pods should run in host network.boolean
spec.stork.argsIt is map of arguments given to STORK. Example: driver: pxdobject
spec.stork.envList of environment variables used by STORK. This is an array of Kubernetes EnvVar where the value can be given directly or from a source like field, config map or secret.array
spec.stork.resourcesSpecifies the resource requirements for stork and stork scheduler.object
spec.stork.resources.requestsRequested resources.object
spec.stork.resources.requests.memoryRequested memory.string
spec.stork.resources.requests.cpuRequested cpu.string
spec.stork.resources.limitsResource limit.object
spec.stork.resources.limits.memoryMemory limit.string
spec.stork.resources.limits.cpuCPU limit.string

userInterface configuration

FieldDescriptionType
spec.userInterface.enabledFlag indicating whether the user interface needs to be enabled.boolean
spec.userInterface.lockImageFlag indicating if the user interface image needs to be locked to the given image. If the image is not locked, it can be updated by the storage driver during upgrades.boolean
spec.userInterface.imageDocker image of the user interface container.string
spec.userInterface.envList of environment variables used by the UI components. This is an array of Kubernetes EnvVar where the value can be given directly or from a source like field, config map or secret.array

autopilot configuration

FieldDescriptionType
spec.autopilot.enabledFlag indicating whether autopilot needs to be enabled.boolean
spec.autopilot.lockImageFlag indicating if the autopilot image needs to be locked to the given image. If the image is not locked, it can be updated by the storage driver during upgrades.boolean
spec.autopilot.imageDocker image of the autopilot container.string
spec.autopilot.argsIt is a map of arguments provided to autopilot. Example: log-level: debugobject
spec.autopilot.envList of environment variables used by autopilot. This is an array of Kubernetes EnvVar where the value can be given directly or from a source like field, config map or secret.array
spec.autopilot.providersList of input data providers to autopilot.array
spec.autopilot.providers.nameUnique name of the data provider.string
spec.autopilot.providers.typeType of the data provider. For instance - prometheusstring
spec.autopilot.providers.paramsMap of key-value params for the provider.object
spec.autopilot.resourcesSpecifies the resource requirements for the autopilot pod.object
spec.autopilot.resources.requestsRequested resources.object
spec.autopilot.resources.requests.memoryRequested memory.string
spec.autopilot.resources.requests.cpuRequested cpu.string
spec.autopilot.resources.limitsResource limit.object
spec.autopilot.resources.limits.memoryMemory limit.string
spec.autopilot.resources.limits.cpuCPU limit.string

monitoring configuration

FieldDescriptionType
spec.monitoring.enableMetricsIf this flag is enabled it will expose the storage cluster metrics to external monitoring solutions like Prometheus. DEPRECATED - use prometheus.exportMetrics insteadboolean
spec.monitoring.prometheusContains configuration of Prometheus to monitor the storage cluster.object
spec.monitoring.prometheus.resourcesDefine resources requests and limits for single Pods.object
spec.monitoring.prometheus.resources.limitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/object
spec.monitoring.prometheus.resources.requestsRequests 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/object
spec.monitoring.prometheus.securityContextSecurity options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/object
spec.monitoring.prometheus.securityContext.allowPrivilegeEscalationAllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMINboolean
spec.monitoring.prometheus.securityContext.capabilitiesThe capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.object
spec.monitoring.prometheus.securityContext.capabilities.addAdded capabilitiesarray
spec.monitoring.prometheus.securityContext.capabilities.dropRemoved capabilitiesarray
spec.monitoring.prometheus.securityContext.privilegedRun container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.boolean
spec.monitoring.prometheus.securityContext.procMountprocMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.string
spec.monitoring.prometheus.securityContext.readOnlyRootFilesystemWhether this container has a read-only root filesystem. Default is false.boolean
spec.monitoring.prometheus.securityContext.runAsGroupThe GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.integer
spec.monitoring.prometheus.securityContext.runAsNonRootIndicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.boolean
spec.monitoring.prometheus.securityContext.runAsUserThe UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.integer
spec.monitoring.prometheus.securityContext.seLinuxOptionsThe SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.object
spec.monitoring.prometheus.securityContext.seLinuxOptions.levelLevel is SELinux level label that applies to the container.string
spec.monitoring.prometheus.securityContext.seLinuxOptions.roleRole is a SELinux role label that applies to the container.string
spec.monitoring.prometheus.securityContext.seLinuxOptions.typeType is a SELinux type label that applies to the container.string
spec.monitoring.prometheus.securityContext.seLinuxOptions.userUser is a SELinux user label that applies to the container.string
spec.monitoring.prometheus.securityContext.windowsOptionsThe Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.object
spec.monitoring.prometheus.securityContext.windowsOptions.gmsaCredentialSpecGMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.string
spec.monitoring.prometheus.securityContext.windowsOptions.gmsaCredentialSpecNameGMSACredentialSpecName is the name of the GMSA credential spec to use.string
spec.monitoring.prometheus.securityContext.windowsOptions.runAsUserNameThe UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.string
spec.monitoring.prometheus.exportMetricsIf this flag is enabled it will expose the storage cluster metrics to Prometheus.boolean
spec.monitoring.prometheus.enabledFlag indicating whether Prometheus stack needs to be enabled and deployed by the Storage operator.boolean
spec.monitoring.prometheus.remoteWriteEndpointSpecifies the remote write endpoint for Prometheus.string
spec.monitoring.prometheus.alertManagerContains configuration of AlertManager for the storage cluster.object
spec.monitoring.prometheus.alertManager.enabledFlag indicating whether AlertManager needs to be enabled and deployed by the Storage operator.boolean
spec.monitoring.prometheus.replicasTotal number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector).integer
spec.monitoring.prometheus.retentionTime duration Prometheus shall retain data for. Default is '24h' if retentionSize is not set, and must match the regular expression `[0-9]+(mss
spec.monitoring.prometheus.retentionSizeMaximum amount of disk space used by blocks.string
spec.monitoring.prometheus.storageStorage spec to specify how storage shall be used.object
spec.monitoring.prometheus.storage.disableMountSubPathDeprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath allows to remove any subPath usage in volume mounts.boolean
spec.monitoring.prometheus.storage.emptyDirEmptyDirVolumeSource to be used by the StatefulSet. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydirobject
spec.monitoring.prometheus.storage.emptyDir.mediummedium 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#emptydirstring
spec.monitoring.prometheus.storage.ephemeralEphemeralVolumeSource to be used by the StatefulSet. This is a beta field in k8s 1.21, for lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumesobject
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplateWill 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.
object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.metadataMay 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.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.specThe 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.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.accessModesaccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1array
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourcedataSource 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.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSource.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSource.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSource.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRefdataSourceRef 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.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespaceNamespace 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.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.resourcesresources 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#resourcesobject
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.resources.claimsClaims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
array
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.resources.claims.nameName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.resources.limitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.resources.requestsRequests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selectorselector is a label query over volumes to consider for binding.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.keykey is the label key that the selector applies to.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.operatoroperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.valuesvalues 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.array
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.selector.matchLabelsmatchLabels 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.object
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.storageClassNamestorageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.volumeModevolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.string
spec.monitoring.prometheus.storage.ephemeral.volumeClaimTemplate.spec.volumeNamevolumeName is the binding reference to the PersistentVolume backing this claim.string
spec.monitoring.prometheus.storage.volumeClaimTemplateA PVC spec to be used by the StatefulSet. The easiest way to use a volume that cannot be automatically provisioned (for whatever reason) is to use a label selector alongside manually created PersistentVolumes.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.apiVersionAPIVersion 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#resourcesstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.kindKind 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-kindsstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.metadataEmbeddedMetadata contains metadata relevant to an EmbeddedResource.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.metadata.annotationsAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotationsobject
spec.monitoring.prometheus.storage.volumeClaimTemplate.metadata.labelsMap of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labelsobject
spec.monitoring.prometheus.storage.volumeClaimTemplate.metadata.nameName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namesstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.specSpec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsobject
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.accessModesaccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1array
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourcedataSource 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.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSource.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSource.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSource.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourceRefdataSourceRef 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.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourceRef.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourceRef.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourceRef.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.dataSourceRef.namespaceNamespace 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.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.resourcesresources 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#resourcesobject
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.resources.claimsClaims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
array
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.resources.claims.nameName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.resources.limitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.resources.requestsRequests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selectorselector is a label query over volumes to consider for binding.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selector.matchExpressions.keykey is the label key that the selector applies to.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selector.matchExpressions.operatoroperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selector.matchExpressions.valuesvalues 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.array
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.selector.matchLabelsmatchLabels 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.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.storageClassNamestorageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.volumeModevolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.spec.volumeNamevolumeName is the binding reference to the PersistentVolume backing this claim.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.statusStatus represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsobject
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.accessModesaccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1array
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.allocatedResourcesallocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.capacitycapacity represents the actual resources of the underlying volume.object
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditionsconditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.array
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditions.lastProbeTimelastProbeTime is the time we probed the condition.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditions.lastTransitionTimelastTransitionTime is the time the condition transitioned from one status to another.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditions.messagemessage is the human-readable message indicating details about last transition.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditions.reasonreason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.conditions.typePersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Typestring
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.phasephase represents the current phase of PersistentVolumeClaim.string
spec.monitoring.prometheus.storage.volumeClaimTemplate.status.resizeStatusresizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.string
spec.monitoring.prometheus.volumesVolumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.array
spec.monitoring.prometheus.volumes.awsElasticBlockStoreawsElasticBlockStore 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#awselasticblockstoreobject
spec.monitoring.prometheus.volumes.awsElasticBlockStore.fsTypefsType 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 machinestring
spec.monitoring.prometheus.volumes.awsElasticBlockStore.partitionpartition 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).integer
spec.monitoring.prometheus.volumes.awsElasticBlockStore.readOnlyreadOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreboolean
spec.monitoring.prometheus.volumes.awsElasticBlockStore.volumeIDvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstorestring
spec.monitoring.prometheus.volumes.azureDiskazureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.object
spec.monitoring.prometheus.volumes.azureDisk.cachingModecachingMode is the Host Caching mode: None, Read Only, Read Write.string
spec.monitoring.prometheus.volumes.azureDisk.diskNamediskName is the Name of the data disk in the blob storagestring
spec.monitoring.prometheus.volumes.azureDisk.diskURIdiskURI is the URI of data disk in the blob storagestring
spec.monitoring.prometheus.volumes.azureDisk.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.azureDisk.kindkind 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 sharedstring
spec.monitoring.prometheus.volumes.azureDisk.readOnlyreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.azureFileazureFile represents an Azure File Service mount on the host and bind mount to the pod.object
spec.monitoring.prometheus.volumes.azureFile.readOnlyreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.azureFile.secretNamesecretName is the name of secret that contains Azure Storage Account Name and Keystring
spec.monitoring.prometheus.volumes.azureFile.shareNameshareName is the azure share Namestring
spec.monitoring.prometheus.volumes.cephfscephFS represents a Ceph FS mount on the host that shares a pod's lifetimeobject
spec.monitoring.prometheus.volumes.cephfs.monitorsmonitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itarray
spec.monitoring.prometheus.volumes.cephfs.pathpath is Optional: Used as the mounted root, rather than the full Ceph tree, default is /string
spec.monitoring.prometheus.volumes.cephfs.readOnlyreadOnly 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-itboolean
spec.monitoring.prometheus.volumes.cephfs.secretFilesecretFile 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-itstring
spec.monitoring.prometheus.volumes.cephfs.secretRefsecretRef 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-itobject
spec.monitoring.prometheus.volumes.cephfs.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.cephfs.useruser is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itstring
spec.monitoring.prometheus.volumes.cindercinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdobject
spec.monitoring.prometheus.volumes.cinder.fsTypefsType 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.mdstring
spec.monitoring.prometheus.volumes.cinder.readOnlyreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdboolean
spec.monitoring.prometheus.volumes.cinder.secretRefsecretRef is optional: points to a secret object containing parameters used to connect to OpenStack.object
spec.monitoring.prometheus.volumes.cinder.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.cinder.volumeIDvolumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdstring
spec.monitoring.prometheus.volumes.configMapconfigMap represents a configMap that should populate this volumeobject
spec.monitoring.prometheus.volumes.configMap.defaultModedefaultMode 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.integer
spec.monitoring.prometheus.volumes.configMap.itemsitems 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 '..'.array
spec.monitoring.prometheus.volumes.configMap.items.keykey is the key to project.string
spec.monitoring.prometheus.volumes.configMap.items.modemode 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.integer
spec.monitoring.prometheus.volumes.configMap.items.pathpath 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 '..'.string
spec.monitoring.prometheus.volumes.configMap.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.configMap.optionaloptional specify whether the ConfigMap or its keys must be definedboolean
spec.monitoring.prometheus.volumes.csicsi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).object
spec.monitoring.prometheus.volumes.csi.driverdriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.string
spec.monitoring.prometheus.volumes.csi.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.csi.nodePublishSecretRefnodePublishSecretRef 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.object
spec.monitoring.prometheus.volumes.csi.nodePublishSecretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.csi.readOnlyreadOnly specifies a read-only configuration for the volume. Defaults to false (read/write).boolean
spec.monitoring.prometheus.volumes.csi.volumeAttributesvolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.object
spec.monitoring.prometheus.volumes.downwardAPIdownwardAPI represents downward API about the pod that should populate this volumeobject
spec.monitoring.prometheus.volumes.downwardAPI.defaultModeOptional: 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.integer
spec.monitoring.prometheus.volumes.downwardAPI.itemsItems is a list of downward API volume filearray
spec.monitoring.prometheus.volumes.downwardAPI.items.fieldRefRequired: Selects a field of the pod: only annotations, labels, name and namespace are supported.object
spec.monitoring.prometheus.volumes.downwardAPI.items.fieldRef.apiVersionVersion of the schema the FieldPath is written in terms of, defaults to "v1".string
spec.monitoring.prometheus.volumes.downwardAPI.items.fieldRef.fieldPathPath of the field to select in the specified API version.string
spec.monitoring.prometheus.volumes.downwardAPI.items.modeOptional: 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.integer
spec.monitoring.prometheus.volumes.downwardAPI.items.pathRequired: 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 '..'string
spec.monitoring.prometheus.volumes.downwardAPI.items.resourceFieldRefSelects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.object
spec.monitoring.prometheus.volumes.downwardAPI.items.resourceFieldRef.containerNameContainer name: required for volumes, optional for env varsstring
spec.monitoring.prometheus.volumes.downwardAPI.items.resourceFieldRef.resourceRequired: resource to selectstring
spec.monitoring.prometheus.volumes.emptyDiremptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydirobject
spec.monitoring.prometheus.volumes.emptyDir.mediummedium 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#emptydirstring
spec.monitoring.prometheus.volumes.ephemeralephemeral 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.
object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplateWill 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.
object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.metadataMay 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.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.specThe 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.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.accessModesaccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1array
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourcedataSource 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.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRefdataSourceRef 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.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroupAPIGroup 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.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.kindKind is the type of resource being referencedstring
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.nameName is the name of resource being referencedstring
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespaceNamespace 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.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.resourcesresources 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#resourcesobject
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.resources.claimsClaims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
array
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims.nameName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.resources.limitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.resources.requestsRequests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selectorselector is a label query over volumes to consider for binding.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.keykey is the label key that the selector applies to.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.operatoroperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.valuesvalues 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.array
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchLabelsmatchLabels 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.object
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.storageClassNamestorageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.volumeModevolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.string
spec.monitoring.prometheus.volumes.ephemeral.volumeClaimTemplate.spec.volumeNamevolumeName is the binding reference to the PersistentVolume backing this claim.string
spec.monitoring.prometheus.volumes.fcfc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.object
spec.monitoring.prometheus.volumes.fc.fsTypefsType 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 machinestring
spec.monitoring.prometheus.volumes.fc.lunlun is Optional: FC target lun numberinteger
spec.monitoring.prometheus.volumes.fc.readOnlyreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.fc.targetWWNstargetWWNs is Optional: FC target worldwide names (WWNs)array
spec.monitoring.prometheus.volumes.fc.wwidswwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.array
spec.monitoring.prometheus.volumes.flexVolumeflexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.object
spec.monitoring.prometheus.volumes.flexVolume.driverdriver is the name of the driver to use for this volume.string
spec.monitoring.prometheus.volumes.flexVolume.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.flexVolume.optionsoptions is Optional: this field holds extra command options if any.object
spec.monitoring.prometheus.volumes.flexVolume.readOnlyreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.flexVolume.secretRefsecretRef 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.object
spec.monitoring.prometheus.volumes.flexVolume.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.flockerflocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being runningobject
spec.monitoring.prometheus.volumes.flocker.datasetNamedatasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecatedstring
spec.monitoring.prometheus.volumes.flocker.datasetUUIDdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker datasetstring
spec.monitoring.prometheus.volumes.gcePersistentDiskgcePersistentDisk 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#gcepersistentdiskobject
spec.monitoring.prometheus.volumes.gcePersistentDisk.fsTypefsType 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 machinestring
spec.monitoring.prometheus.volumes.gcePersistentDisk.partitionpartition 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#gcepersistentdiskinteger
spec.monitoring.prometheus.volumes.gcePersistentDisk.pdNamepdName 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#gcepersistentdiskstring
spec.monitoring.prometheus.volumes.gcePersistentDisk.readOnlyreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskboolean
spec.monitoring.prometheus.volumes.gitRepogitRepo 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.object
spec.monitoring.prometheus.volumes.gitRepo.directorydirectory 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.string
spec.monitoring.prometheus.volumes.gitRepo.repositoryrepository is the URLstring
spec.monitoring.prometheus.volumes.gitRepo.revisionrevision is the commit hash for the specified revision.string
spec.monitoring.prometheus.volumes.glusterfsglusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.mdobject
spec.monitoring.prometheus.volumes.glusterfs.endpointsendpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podstring
spec.monitoring.prometheus.volumes.glusterfs.pathpath is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podstring
spec.monitoring.prometheus.volumes.glusterfs.readOnlyreadOnly 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-podboolean
spec.monitoring.prometheus.volumes.hostPathhostPath 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.object
spec.monitoring.prometheus.volumes.hostPath.pathpath 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#hostpathstring
spec.monitoring.prometheus.volumes.hostPath.typetype for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpathstring
spec.monitoring.prometheus.volumes.iscsiiscsi 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.mdobject
spec.monitoring.prometheus.volumes.iscsi.chapAuthDiscoverychapAuthDiscovery defines whether support iSCSI Discovery CHAP authenticationboolean
spec.monitoring.prometheus.volumes.iscsi.chapAuthSessionchapAuthSession defines whether support iSCSI Session CHAP authenticationboolean
spec.monitoring.prometheus.volumes.iscsi.fsTypefsType 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 machinestring
spec.monitoring.prometheus.volumes.iscsi.initiatorNameinitiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.string
spec.monitoring.prometheus.volumes.iscsi.iqniqn is the target iSCSI Qualified Name.string
spec.monitoring.prometheus.volumes.iscsi.iscsiInterfaceiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).string
spec.monitoring.prometheus.volumes.iscsi.lunlun represents iSCSI Target Lun number.integer
spec.monitoring.prometheus.volumes.iscsi.portalsportals 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).array
spec.monitoring.prometheus.volumes.iscsi.readOnlyreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.boolean
spec.monitoring.prometheus.volumes.iscsi.secretRefsecretRef is the CHAP Secret for iSCSI target and initiator authenticationobject
spec.monitoring.prometheus.volumes.iscsi.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.iscsi.targetPortaltargetPortal 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).string
spec.monitoring.prometheus.volumes.namename 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/#namesstring
spec.monitoring.prometheus.volumes.nfsnfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsobject
spec.monitoring.prometheus.volumes.nfs.pathpath that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsstring
spec.monitoring.prometheus.volumes.nfs.readOnlyreadOnly 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#nfsboolean
spec.monitoring.prometheus.volumes.nfs.serverserver is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsstring
spec.monitoring.prometheus.volumes.persistentVolumeClaimpersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsobject
spec.monitoring.prometheus.volumes.persistentVolumeClaim.claimNameclaimName 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#persistentvolumeclaimsstring
spec.monitoring.prometheus.volumes.persistentVolumeClaim.readOnlyreadOnly Will force the ReadOnly setting in VolumeMounts. Default false.boolean
spec.monitoring.prometheus.volumes.photonPersistentDiskphotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machineobject
spec.monitoring.prometheus.volumes.photonPersistentDisk.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.photonPersistentDisk.pdIDpdID is the ID that identifies Photon Controller persistent diskstring
spec.monitoring.prometheus.volumes.portworxVolumeportworxVolume represents a portworx volume attached and mounted on kubelets host machineobject
spec.monitoring.prometheus.volumes.portworxVolume.fsTypefSType 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.string
spec.monitoring.prometheus.volumes.portworxVolume.readOnlyreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.portworxVolume.volumeIDvolumeID uniquely identifies a Portworx volumestring
spec.monitoring.prometheus.volumes.projectedprojected items for all in one resources secrets, configmaps, and downward APIobject
spec.monitoring.prometheus.volumes.projected.defaultModedefaultMode 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.integer
spec.monitoring.prometheus.volumes.projected.sourcessources is the list of volume projectionsarray
spec.monitoring.prometheus.volumes.projected.sources.configMapconfigMap information about the configMap data to projectobject
spec.monitoring.prometheus.volumes.projected.sources.configMap.itemsitems 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 '..'.array
spec.monitoring.prometheus.volumes.projected.sources.configMap.items.keykey is the key to project.string
spec.monitoring.prometheus.volumes.projected.sources.configMap.items.modemode 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.integer
spec.monitoring.prometheus.volumes.projected.sources.configMap.items.pathpath 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 '..'.string
spec.monitoring.prometheus.volumes.projected.sources.configMap.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.projected.sources.configMap.optionaloptional specify whether the ConfigMap or its keys must be definedboolean
spec.monitoring.prometheus.volumes.projected.sources.downwardAPIdownwardAPI information about the downwardAPI data to projectobject
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.itemsItems is a list of DownwardAPIVolume filearray
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.fieldRefRequired: Selects a field of the pod: only annotations, labels, name and namespace are supported.object
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.fieldRef.apiVersionVersion of the schema the FieldPath is written in terms of, defaults to "v1".string
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.fieldRef.fieldPathPath of the field to select in the specified API version.string
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.modeOptional: 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.integer
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.pathRequired: 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 '..'string
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.resourceFieldRefSelects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.object
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.resourceFieldRef.containerNameContainer name: required for volumes, optional for env varsstring
spec.monitoring.prometheus.volumes.projected.sources.downwardAPI.items.resourceFieldRef.resourceRequired: resource to selectstring
spec.monitoring.prometheus.volumes.projected.sources.secretsecret information about the secret data to projectobject
spec.monitoring.prometheus.volumes.projected.sources.secret.itemsitems 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 '..'.array
spec.monitoring.prometheus.volumes.projected.sources.secret.items.keykey is the key to project.string
spec.monitoring.prometheus.volumes.projected.sources.secret.items.modemode 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.integer
spec.monitoring.prometheus.volumes.projected.sources.secret.items.pathpath 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 '..'.string
spec.monitoring.prometheus.volumes.projected.sources.secret.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.projected.sources.secret.optionaloptional field specify whether the Secret or its key must be definedboolean
spec.monitoring.prometheus.volumes.projected.sources.serviceAccountTokenserviceAccountToken is information about the serviceAccountToken data to projectobject
spec.monitoring.prometheus.volumes.projected.sources.serviceAccountToken.audienceaudience 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.string
spec.monitoring.prometheus.volumes.projected.sources.serviceAccountToken.expirationSecondsexpirationSeconds 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.integer
spec.monitoring.prometheus.volumes.projected.sources.serviceAccountToken.pathpath is the path relative to the mount point of the file to project the token into.string
spec.monitoring.prometheus.volumes.quobytequobyte represents a Quobyte mount on the host that shares a pod's lifetimeobject
spec.monitoring.prometheus.volumes.quobyte.groupgroup to map volume access to Default is no groupstring
spec.monitoring.prometheus.volumes.quobyte.readOnlyreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.boolean
spec.monitoring.prometheus.volumes.quobyte.registryregistry 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 volumesstring
spec.monitoring.prometheus.volumes.quobyte.tenanttenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the pluginstring
spec.monitoring.prometheus.volumes.quobyte.useruser to map volume access to Defaults to serivceaccount userstring
spec.monitoring.prometheus.volumes.quobyte.volumevolume is a string that references an already created Quobyte volume by name.string
spec.monitoring.prometheus.volumes.rbdrbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.mdobject
spec.monitoring.prometheus.volumes.rbd.fsTypefsType 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 machinestring
spec.monitoring.prometheus.volumes.rbd.imageimage is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itstring
spec.monitoring.prometheus.volumes.rbd.keyringkeyring 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-itstring
spec.monitoring.prometheus.volumes.rbd.monitorsmonitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itarray
spec.monitoring.prometheus.volumes.rbd.poolpool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itstring
spec.monitoring.prometheus.volumes.rbd.readOnlyreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itboolean
spec.monitoring.prometheus.volumes.rbd.secretRefsecretRef 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-itobject
spec.monitoring.prometheus.volumes.rbd.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.rbd.useruser is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itstring
spec.monitoring.prometheus.volumes.scaleIOscaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.object
spec.monitoring.prometheus.volumes.scaleIO.fsTypefsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".string
spec.monitoring.prometheus.volumes.scaleIO.gatewaygateway is the host address of the ScaleIO API Gateway.string
spec.monitoring.prometheus.volumes.scaleIO.protectionDomainprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.string
spec.monitoring.prometheus.volumes.scaleIO.readOnlyreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.scaleIO.secretRefsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.object
spec.monitoring.prometheus.volumes.scaleIO.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.scaleIO.sslEnabledsslEnabled Flag enable/disable SSL communication with Gateway, default falseboolean
spec.monitoring.prometheus.volumes.scaleIO.storageModestorageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.string
spec.monitoring.prometheus.volumes.scaleIO.storagePoolstoragePool is the ScaleIO Storage Pool associated with the protection domain.string
spec.monitoring.prometheus.volumes.scaleIO.systemsystem is the name of the storage system as configured in ScaleIO.string
spec.monitoring.prometheus.volumes.scaleIO.volumeNamevolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.string
spec.monitoring.prometheus.volumes.secretsecret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secretobject
spec.monitoring.prometheus.volumes.secret.defaultModedefaultMode 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.integer
spec.monitoring.prometheus.volumes.secret.itemsitems 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 '..'.array
spec.monitoring.prometheus.volumes.secret.items.keykey is the key to project.string
spec.monitoring.prometheus.volumes.secret.items.modemode 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.integer
spec.monitoring.prometheus.volumes.secret.items.pathpath 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 '..'.string
spec.monitoring.prometheus.volumes.secret.optionaloptional field specify whether the Secret or its keys must be definedboolean
spec.monitoring.prometheus.volumes.secret.secretNamesecretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secretstring
spec.monitoring.prometheus.volumes.storageosstorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.object
spec.monitoring.prometheus.volumes.storageos.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.storageos.readOnlyreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.boolean
spec.monitoring.prometheus.volumes.storageos.secretRefsecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.object
spec.monitoring.prometheus.volumes.storageos.secretRef.nameName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?string
spec.monitoring.prometheus.volumes.storageos.volumeNamevolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.string
spec.monitoring.prometheus.volumes.storageos.volumeNamespacevolumeNamespace 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.string
spec.monitoring.prometheus.volumes.vsphereVolumevsphereVolume represents a vSphere volume attached and mounted on kubelets host machineobject
spec.monitoring.prometheus.volumes.vsphereVolume.fsTypefsType 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.string
spec.monitoring.prometheus.volumes.vsphereVolume.storagePolicyIDstoragePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.string
spec.monitoring.prometheus.volumes.vsphereVolume.storagePolicyNamestoragePolicyName is the storage Policy Based Management (SPBM) profile name.string
spec.monitoring.prometheus.volumes.vsphereVolume.volumePathvolumePath is the path that identifies vSphere volume vmdkstring
spec.monitoring.prometheus.volumeMountsVolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects.array
spec.monitoring.prometheus.volumeMounts.mountPathPath within the container at which the volume should be mounted. Must not contain ':'.string
spec.monitoring.prometheus.volumeMounts.mountPropagationmountPropagation 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.string
spec.monitoring.prometheus.volumeMounts.nameThis must match the Name of a Volume.string
spec.monitoring.prometheus.volumeMounts.readOnlyMounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.boolean
spec.monitoring.prometheus.volumeMounts.subPathPath within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).string
spec.monitoring.prometheus.volumeMounts.subPathExprExpanded 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.string
spec.monitoring.grafanaContains configuration of Grafana to monitor the storage cluster.object
spec.monitoring.grafana.enabledFlag indicating whether Grafana stack needs to be enabled and deployed by the Storage operator.boolean
spec.monitoring.telemetryContains telemetry configuration for the storage cluster.object
spec.monitoring.telemetry.enabledFlag indicates if telemetry component needs to be enabledboolean
spec.monitoring.telemetry.imageDocker image of the telemetry container.string
spec.monitoring.telemetry.logUploaderImageDocker image of the log-upload-service container.string

security configuration

FieldDescriptionType
spec.security.enabledFlag indicating whether security features need to be enabled for the storage cluster.boolean
spec.security.authAuthorization configurations for a RBAC enabled storage clusterobject
spec.security.auth.guestAccessDefines the access mode of a guest userstring
spec.security.auth.selfSignedConfiguration for self signed authenticationobject
spec.security.auth.selfSigned.issuerToken issuer for the tokens used to connect with storage cluster.string
spec.security.auth.selfSigned.tokenLifetimeLifetime of auto-generated RBAC tokens to access the storage cluster.string
spec.security.auth.selfSigned.sharedSecretShared secret is the name of the Kubernetes secret containing the shared key used for signing RBAC tokens. The secret has to be present in the StorageCluster namespace.string

csi configuration

FieldDescriptionType
spec.csi.enabledFlag indicating whether CSI needs to be installed for the storage cluster.boolean
spec.csi.installSnapshotControllerFlag indicating whether CSI Snapshot Controller needs to be installed for the storage cluster.boolean
spec.csi.topologyContains CSI topology configurations.object
spec.csi.topology.enabledFlag indicating whether CSI topology feature gate is enabled.boolean
spec.csi.placementDescribes placement configuration for the CSI sidecar pods.object
spec.csi.placement.nodeAffinityDescribes node affinity scheduling rules for the CSI sidecar pods. This is exactly the same object as Kubernetes node affinity for pods.object
spec.csi.placement.tolerationsTolerations for the CSI sidecar pods. The pod with this toleration attached will tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>.array
spec.csi.placement.tolerations.effectEffect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.string
spec.csi.placement.tolerations.keyKey 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.string
spec.csi.placement.tolerations.operatorOperator 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.string
spec.csi.placement.tolerations.valueValue is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.string
spec.csi.placement.tolerations.tolerationSecondsTolerationSeconds 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.integer
spec.csi.nodeDriverRegistrarDefines configuration for the CSI node driver registrar.object
spec.csi.nodeDriverRegistrar.resourcesSpecifies the resource requirements for the csi node driver registar container.object
spec.csi.nodeDriverRegistrar.resources.requestsRequested resources for the csi node driver registrar container.object
spec.csi.nodeDriverRegistrar.resources.requests.memoryRequested memory for the csi node driver registrar container.string
spec.csi.nodeDriverRegistrar.resources.requests.cpuRequested cpu for the csi node driver registrar container.string
spec.csi.nodeDriverRegistrar.resources.limitsLimits describes the maximum amount of resources allowed for the csi node driver registrar container.object
spec.csi.nodeDriverRegistrar.resources.limits.memoryMaximum memory for the csi node driver registrar container.string
spec.csi.nodeDriverRegistrar.resources.limits.cpuMaximum cpu for the csi node driver registrar container.string
spec.csi.externalProvisionerDefines configuration for the CSI provisioner.object
spec.csi.externalProvisioner.resourcesSpecifies the resource requirements for the csi provisioner container.object
spec.csi.externalProvisioner.resources.requestsRequested resources for the csi provisioner container.object
spec.csi.externalProvisioner.resources.requests.memoryRequested memory for the csi provisioner container.string
spec.csi.externalProvisioner.resources.requests.cpuRequested cpu for the csi provisioner container.string
spec.csi.externalProvisioner.resources.limitsLimits describes the maximum amount of resources allowed for the csi provisioner container.object
spec.csi.externalProvisioner.resources.limits.memoryMaximum memory for the csi provisioner container.string
spec.csi.externalProvisioner.resources.limits.cpuMaximum cpu for the csi provisioner container.string
spec.csi.snapshotterDefines configuration for the CSI snapshotter.object
spec.csi.snapshotter.resourcesSpecifies the resource requirements for the csi snapshotter container.object
spec.csi.snapshotter.resources.requestsRequested resources for the csi snapshotter container.object
spec.csi.snapshotter.resources.requests.memoryRequested memory for the csi snapshotter container.string
spec.csi.snapshotter.resources.requests.cpuRequested cpu for the csi snapshotter container.string
spec.csi.snapshotter.resources.limitsLimits describes the maximum amount of resources allowed for the csi snapshotter container.object
spec.csi.snapshotter.resources.limits.memoryMaximum memory for the csi snapshotter container.string
spec.csi.snapshotter.resources.limits.cpuMaximum cpu for the csi snapshotter container.string
spec.csi.resizerDefines configuration for the CSI resizer.object
spec.csi.resizer.resourcesSpecifies the resource requirements for the csi resizer container.object
spec.csi.resizer.resources.requestsRequested resources for the csi resizer container.object
spec.csi.resizer.resources.requests.memoryRequested memory for the csi resizer container.string
spec.csi.resizer.resources.requests.cpuRequested cpu for the csi resizer container.string
spec.csi.resizer.resources.limitsLimits describes the maximum amount of resources allowed for the csi resizer container.object
spec.csi.resizer.resources.limits.memoryMaximum memory for the csi resizer container.string
spec.csi.resizer.resources.limits.cpuMaximum cpu for the csi resizer container.string
spec.csi.snapshotControllerDefines configuration for the CSI snapshot controller.object
spec.csi.snapshotController.resourcesSpecifies the resource requirements for the csi snapshot controller container.object
spec.csi.snapshotController.resources.requestsRequested resources for the csi snapshot controller container.object
spec.csi.snapshotController.resources.requests.memoryRequested memory for the csi snapshot controller container.string
spec.csi.snapshotController.resources.requests.cpuRequested cpu for the csi snapshot controller container.string
spec.csi.snapshotController.resources.limitsLimits describes the maximum amount of resources allowed for the csi snapshot controller container.object
spec.csi.snapshotController.resources.limits.memoryMaximum memory for the csi snapshot controller container.string
spec.csi.snapshotController.resources.limits.cpuMaximum cpu for the csi snapshot controller container.string

portworxApi configuration

FieldDescriptionType
spec.portworxApi.resourcesSpecifies the compute resource requirements for the portworx api container.object
spec.portworxApi.resources.requestsRequested resources for the portworx api container.object
spec.portworxApi.resources.requests.memoryRequested memory for the portworx api container.string
spec.portworxApi.resources.requests.cpuRequested cpu for the portworx api container.string
spec.portworxApi.resources.limitsLimits describes the maximum amount of compute resources allowed for the portworx api container.object
spec.portworxApi.resources.limits.memoryMaximum memory for the portworx api container.string
spec.portworxApi.resources.limits.cpuMaximum cpu for the portworx api container.string

nodes configuration

FieldDescriptionType
spec.nodes.selectorConfiguration in this node block is applied to nodes based on this selector. Use either nodeName of labelSelector, not both. If nodeName is used, labelSelector will be ignored.object
spec.nodes.selector.nodeNameName of the Kubernetes node that is to be selected. If present then the labelSelector is ignored even if the node with the given name is absent and the labelSelector matches another node.string
spec.nodes.selector.labelSelectorIt is a label query over all the nodes. The result of matchLabels and matchExpressions is ANDed. An empty label selector matches all nodes. A null label selector matches no objects.object
spec.nodes.selector.labelSelector.matchLabelsIt 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.object
spec.nodes.selector.labelSelector.matchExpressionsIt is a list of label selector requirements. The requirements are ANDed.array
spec.nodes.selector.labelSelector.matchExpressions.keyIt is the label key that the selector applies to.string
spec.nodes.selector.labelSelector.matchExpressions.operatorIt represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.string
spec.nodes.selector.labelSelector.matchExpressions.valuesIt 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.array
spec.nodes.storageDetails of the storage used by the storage driver.object
spec.nodes.storage.useAllUse all available, unformatted, unpartitioned devices. This will be ignored if spec.storage.devices is not empty.boolean
spec.nodes.storage.useAllWithPartitionsUse all available unformatted devices. This will be ignored if spec.storage.devices is not empty.boolean
spec.nodes.storage.forceUseDisksFlag indicating to use the devices even if there is file system present on it. Note that the devices may be wiped before using.boolean
spec.nodes.storage.devicesList of devices to be used by the storage driver.array
spec.nodes.storage.cacheDevicesList of cache devices to be used by the storage driver.array
spec.nodes.storage.journalDeviceDevice used for journaling.string
spec.nodes.storage.systemMetadataDeviceDevice that will be used to store system metadata by the driver.string
spec.nodes.storage.kvdbDeviceDevice used for internal KVDB.string
spec.nodes.cloudStorageDetails of storage used in cloud environment.object
spec.nodes.cloudStorage.deviceSpecsList of storage device specs. A cloud storage device will be created for every spec in the list. The specs will be applied to all nodes in the cluster that match the node group selector. The number of nodes that will come up with storage are constrained by maxStorageNodes, maxStorageNodesPerZone and maxStorageNodesPerZonePerNodeGroup.array
spec.nodes.cloudStorage.journalDeviceSpecDevice spec for the journal device.string
spec.nodes.cloudStorage.systemMetadataDeviceSpecDevice spec for the metadata device. This device will be used to store system metadata by the driver.string
spec.nodes.cloudStorage.kvdbDeviceSpecDevice spec for internal KVDB device.string
spec.nodes.cloudStorage.maxStorageNodesPerZonePerNodeGroupMaximum nodes in every zone in every node group that will have storage in the cluster.integer
spec.nodes.networkContains network information that is needed by the storage driver.object
spec.nodes.network.dataInterfaceName of the network interface used by the storage driver for data traffic.string
spec.nodes.network.mgmtInterfaceName of the network interface used by the storage driver for management traffic.string
spec.nodes.runtimeOptionsThis is map of any runtime options that need to be sent to the storage driver. The value is a string. If runtime options are present here at node level, they will override the ones from cluster configuration.object
spec.nodes.envList of environment variables used by the driver. This is an array of Kubernetes EnvVar where the value can be given directly or from a source like field, config map or secret. Environment variables specified here at the node level will be merged with the ones present in cluster configuration and sent to the nodes. If there is duplicate, the node level value will take precedence.array
Was this page helpful?