NifiCluster
Kind
nifi.stackable.tech
Group
v1alpha1
Version

apiVersion: nifi.stackable.tech/v1alpha1
kind: NifiCluster
spec object

A NiFi cluster stacklet. This resource is managed by the Stackable operator for Apache NiFi. Find more information on how to use it and the resources that the operator generates in the operator documentation.


clusterConfig object required

Settings that affect all roles and role groups. The settings in the clusterConfig are cluster wide settings that do not need to be configurable at role or role group level.


authentication []object required

Authentication options for NiFi (required). Read more about authentication in the security documentation.


authenticationClass string required

Name of the AuthenticationClass used to authenticate users. Supported providers are static and ldap. For static the "admin" user needs to be present in the referenced secret, and only this user will be added to NiFi, other users are ignored.

extraVolumes []object

Extra volumes to mount into every container, this can be useful to for example make client certificates, keytabs or similar things available to processors These volumes will be mounted below /stackable/userdata/{volumename}. See also the external files usage guide.


awsElasticBlockStore object

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


fsType string

fsType 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

partition integer

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

readOnly boolean

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

volumeID string required

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

azureDisk object

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


cachingMode string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

diskName string required

diskName is the Name of the data disk in the blob storage

diskURI string required

diskURI is the URI of data disk in the blob storage

fsType string

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

kind string

kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

readOnly boolean

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

azureFile object

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


readOnly boolean

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

secretName string required

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

shareName string required

shareName is the azure share Name

cephfs object

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


monitors []string required

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

path string

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

readOnly boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile string

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef object

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it


name string
user string

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

cinder object

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


fsType string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef object

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


name string
volumeID string required

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

configMap object

configMap represents a configMap that should populate this volume


defaultMode integer

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

items []object

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


key string required

key is the key to project.

mode integer

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

path string required

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

name string
optional boolean

optional specify whether the ConfigMap or its keys must be defined

csi object

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


driver string required

driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

fsType string

fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

nodePublishSecretRef object

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.


name string
readOnly boolean

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

volumeAttributes object

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

downwardAPI object

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


defaultMode integer

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

items []object

Items is a list of downward API volume file


fieldRef object

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


apiVersion string

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

fieldPath string required

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

mode integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

path string required

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

resourceFieldRef object

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


containerName string

Container name: required for volumes, optional for env vars

divisor string

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

resource string required

Required: resource to select

emptyDir object

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


medium string

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit string

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral object

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.


volumeClaimTemplate object

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.


metadata object

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


annotations object

Annotations 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/annotations

creationTimestamp string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds integer

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers []string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels object

Map 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/labels

managedFields []object

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.


apiVersion string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsType string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager string

Manager is an identifier of the workflow managing these fields.

operation string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

subresource string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

time string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

name string

Name 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/names#names

namespace string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences []object

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.


apiVersion string required

API version of the referent.

blockOwnerDeletion boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

controller boolean

If true, this reference points to the managing controller.

kind string required
name string required
uid string required
resourceVersion string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink string
uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

spec object required

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


accessModes []string

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

dataSource object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.


apiGroup string

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

kind string required

Kind is the type of resource being referenced

name string required

Name is the name of resource being referenced

dataSourceRef object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.

  • While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
  • While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

apiGroup string

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

kind string required

Kind is the type of resource being referenced

name string required

Name is the name of resource being referenced

namespace string

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

resources object

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


limits object

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

requests object

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

selector object

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


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClassName string

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

volumeAttributesClassName string

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.

volumeMode string

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

volumeName string

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

fc object

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


fsType string

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

lun integer

lun is Optional: FC target lun number

readOnly boolean

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

targetWWNs []string

targetWWNs is Optional: FC target worldwide names (WWNs)

wwids []string

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

flexVolume object

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


driver string required

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

fsType string

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

options object

options is Optional: this field holds extra command options if any.

readOnly boolean

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

secretRef object

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.


name string
flocker object

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


datasetName string

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

datasetUUID string

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

gcePersistentDisk object

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


fsType string

fsType 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

partition integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName string required

pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly boolean

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

gitRepo object

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


directory string

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

repository string required

repository is the URL

revision string

revision is the commit hash for the specified revision.

glusterfs object

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


endpoints string required

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

path string required

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

readOnly boolean

readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

hostPath object

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath


path string required

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

type string

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

iscsi object

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


chapAuthDiscovery boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

chapAuthSession boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

fsType string

fsType 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

initiatorName string

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

iqn string required

iqn is the target iSCSI Qualified Name.

iscsiInterface string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

lun integer required

lun represents iSCSI Target Lun number.

portals []string

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

readOnly boolean

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

secretRef object

secretRef is the CHAP Secret for iSCSI target and initiator authentication


name string
targetPortal string required

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

name string required

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

nfs object

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


path string required

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

readOnly boolean

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

server string required

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

persistentVolumeClaim object

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


claimName string required

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

readOnly boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

photonPersistentDisk object

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


fsType string

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

pdID string required

pdID is the ID that identifies Photon Controller persistent disk

portworxVolume object

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


fsType string

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

readOnly boolean

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

volumeID string required

volumeID uniquely identifies a Portworx volume

projected object

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


defaultMode integer

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

sources []object

sources is the list of volume projections


clusterTrustBundle object

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

Alpha, gated by the ClusterTrustBundleProjection feature gate.

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

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


labelSelector object

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


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

name string

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

optional boolean

If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.

path string required

Relative path from the volume root to write the bundle.

signerName string

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

configMap object

configMap information about the configMap data to project


items []object

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


key string required

key is the key to project.

mode integer

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

path string required

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

name string
optional boolean

optional specify whether the ConfigMap or its keys must be defined

downwardAPI object

downwardAPI information about the downwardAPI data to project


items []object

Items is a list of DownwardAPIVolume file


fieldRef object

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


apiVersion string

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

fieldPath string required

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

mode integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

path string required

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

resourceFieldRef object

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


containerName string

Container name: required for volumes, optional for env vars

divisor string

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

resource string required

Required: resource to select

secret object

secret information about the secret data to project


items []object

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


key string required

key is the key to project.

mode integer

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

path string required

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

name string
optional boolean

optional field specify whether the Secret or its key must be defined

serviceAccountToken object

serviceAccountToken is information about the serviceAccountToken data to project


audience string

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

expirationSeconds integer

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

path string required

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

quobyte object

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


group string

group to map volume access to Default is no group

readOnly boolean

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

registry string required

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

tenant string

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

user string

user to map volume access to Defaults to serivceaccount user

volume string required

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

rbd object

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


fsType string

fsType 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

image string required

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

keyring string

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

monitors []string required

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

pool string

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

readOnly boolean

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

secretRef object

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


name string
user string

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

scaleIO object

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


fsType string

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

gateway string required

gateway is the host address of the ScaleIO API Gateway.

protectionDomain string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

readOnly boolean

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

secretRef object required

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


name string
sslEnabled boolean

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

storageMode string

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

storagePool string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

system string required

system is the name of the storage system as configured in ScaleIO.

volumeName string

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

secret object

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


defaultMode integer

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

items []object

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


key string required

key is the key to project.

mode integer

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

path string required

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

optional boolean

optional field specify whether the Secret or its keys must be defined

secretName string

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

storageos object

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


fsType string

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

readOnly boolean

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

secretRef object

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


name string
volumeName string

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

volumeNamespace string

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

vsphereVolume object

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


fsType string

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

storagePolicyID string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

volumePath string required

volumePath is the path that identifies vSphere volume vmdk

listenerClass string: enum
Enum variants: cluster-internalexternal-unstable

This field controls which type of Service the Operator creates for this NifiCluster:

  • cluster-internal: Use a ClusterIP service

  • external-unstable: Use a NodePort service

This is a temporary solution with the goal to keep yaml manifests forward compatible. In the future, this setting will control which ListenerClass will be used to expose the service, and ListenerClass names will stay the same, allowing for a non-breaking change.

sensitiveProperties object required

These settings configure the encryption of sensitive properties in NiFi processors. NiFi supports encrypting sensitive properties in processors as they are written to disk. You can configure the encryption algorithm and the key to use. You can also let the operator generate an encryption key for you.


algorithm string: enum
Enum variants: nifiArgon2AesGcm128nifiArgon2AesGcm256nifiBcryptAesGcm128nifiBcryptAesGcm256nifiPbkdf2AesGcm128nifiPbkdf2AesGcm256nifiScryptAesGcm128nifiScryptAesGcm256

This is setting the nifi.sensitive.props.algorithm property in NiFi. This setting configures the encryption algorithm to use to encrypt sensitive properties. Valid values are:

nifiPbkdf2AesGcm256 (the default value), nifiArgon2AesGcm256,

The following algorithms are deprecated and will be removed in future versions:

nifiArgon2AesGcm128, nifiBcryptAesGcm128, nifiBcryptAesGcm256, nifiPbkdf2AesGcm128, nifiScryptAesGcm128, nifiScryptAesGcm256.

Learn more about the specifics of the algorithm parameters in the NiFi documentation.

autoGenerate boolean

Whether to generate the keySecret if it is missing. Defaults to false.

keySecret string required

A reference to a Secret. The Secret needs to contain a key nifiSensitivePropsKey. If autoGenerate is false and this object is missing, the Operator will raise an error. The encryption key needs to be at least 12 characters long.

tls object

TLS configuration options for the server.


serverSecretClass string

This only affects client connections and is used to control which certificate the servers should use to authenticate themselves against the client.

vectorAggregatorConfigMapName string

Name of the Vector aggregator discovery ConfigMap. It must contain the key ADDRESS with the address of the Vector aggregator. Follow the logging tutorial to learn how to configure log aggregation with Vector.

zookeeperConfigMapName string required

NiFi requires a ZooKeeper cluster connection to run. Provide the name of the ZooKeeper discovery ConfigMap here. When using the Stackable operator for Apache ZooKeeper to deploy a ZooKeeper cluster, this will simply be the name of your ZookeeperCluster resource.

clusterOperation object

Cluster operations properties, allow stopping the product instance as well as pausing reconciliation.


reconciliationPaused boolean

Flag to stop cluster reconciliation by the operator. This means that all changes in the custom resource spec are ignored until this flag is set to false or removed. The operator will however still watch the deployed resources at the time and update the custom resource status field. If applied at the same time with stopped, reconciliationPaused will take precedence over stopped and stop the reconciliation immediately.

stopped boolean

Flag to stop the cluster. This means all deployed resources (e.g. Services, StatefulSets, ConfigMaps) are kept but all deployed Pods (e.g. replicas from a StatefulSet) are scaled to 0 and therefore stopped and removed. If applied at the same time with reconciliationPaused, the latter will pause reconciliation and stopped will take no effect until reconciliationPaused is set to false or removed.

image object required

Specify which image to use, the easiest way is to only configure the productVersion. You can also configure a custom image registry to pull from, as well as completely custom images.

Consult the Product image selection documentation for details.


custom string

Overwrite the docker image. Specify the full docker image name, e.g. docker.stackable.tech/stackable/superset:1.4.1-stackable2.1.0

productVersion string

Version of the product, e.g. 1.4.1.

pullPolicy string: enum
Enum variants: IfNotPresentAlwaysNever

Pull policy used when pulling the image.

pullSecrets []object

Image pull secrets to pull images from a private registry.


name string
repo string

Name of the docker repo, e.g. docker.stackable.tech/stackable

stackableVersion string

Stackable version of the product, e.g. 23.4, 23.4.1 or 0.0.0-dev. If not specified, the operator will use its own version, e.g. 23.4.1. When using a nightly operator or a pr version, it will use the nightly 0.0.0-dev image.

nodes object

This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a key-value-map containing all the roleGroups that are part of this role. Additionally, there is a config, which is configurable at the role and roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level. There is also a second form of config, which can only be configured at role level, the roleConfig. You can learn more about this in the Roles and role group concept documentation.


cliOverrides object

No Description Provided.

config object

No Description Provided.


affinity object

These configuration settings control Pod placement.


nodeAffinity object

Node affinity is a group of node affinity scheduling rules.


preferredDuringSchedulingIgnoredDuringExecution []object

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.


preference object required

A node selector term, associated with the corresponding weight.


matchExpressions []object

A list of node selector requirements by node's labels.


key string required

The label key that the selector applies to.

operator string required

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values []string

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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

matchFields []object

A list of node selector requirements by node's fields.


key string required

The label key that the selector applies to.

operator string required

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values []string

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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

weight integer required

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

requiredDuringSchedulingIgnoredDuringExecution object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.


nodeSelectorTerms []object required

Required. A list of node selector terms. The terms are ORed.


matchExpressions []object

A list of node selector requirements by node's labels.


key string required

The label key that the selector applies to.

operator string required

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values []string

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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

matchFields []object

A list of node selector requirements by node's fields.


key string required

The label key that the selector applies to.

operator string required

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values []string

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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

nodeSelector object

No Description Provided.

podAffinity object

Pod affinity is a group of inter pod affinity scheduling rules.


preferredDuringSchedulingIgnoredDuringExecution []object

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.


podAffinityTerm object required

Required. A pod affinity term, associated with the corresponding weight.


labelSelector object

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

matchLabelKeys []string

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

mismatchLabelKeys []string

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

namespaceSelector object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

namespaces []string

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

topologyKey string required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

weight integer required

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

requiredDuringSchedulingIgnoredDuringExecution []object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.


labelSelector object

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

matchLabelKeys []string

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

mismatchLabelKeys []string

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

namespaceSelector object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

namespaces []string

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

topologyKey string required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

podAntiAffinity object

Pod anti affinity is a group of inter pod anti affinity scheduling rules.


preferredDuringSchedulingIgnoredDuringExecution []object

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.


podAffinityTerm object required

Required. A pod affinity term, associated with the corresponding weight.


labelSelector object

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

matchLabelKeys []string

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

mismatchLabelKeys []string

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

namespaceSelector object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

namespaces []string

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

topologyKey string required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

weight integer required

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

requiredDuringSchedulingIgnoredDuringExecution []object

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.


labelSelector object

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

matchLabelKeys []string

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

mismatchLabelKeys []string

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.

namespaceSelector object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

namespaces []string

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

topologyKey string required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

gracefulShutdownTimeout string

Time period Pods have to gracefully shut down, e.g. 30m, 1h or 2d. Consult the operator documentation for details.

logging object

Logging configuration, learn more in the logging concept documentation.


containers object

Log configuration per container.

enableVectorAgent boolean

Wether or not to deploy a container with the Vector log agent.

resources object

Resource usage is configured here, this includes CPU usage, memory usage and disk storage usage. The default CPU request and limit are 500m and 2000m respectively. The default memory limit is 4GB.


cpu object

No Description Provided.


max string

The maximum amount of CPU cores that can be requested by Pods. Equivalent to the limit for Pod resource configuration. Cores are specified either as a decimal point number or as milli units. For example:1.5 will be 1.5 cores, also written as 1500m.

min string

The minimal amount of CPU cores that Pods need to run. Equivalent to the request for Pod resource configuration. Cores are specified either as a decimal point number or as milli units. For example:1.5 will be 1.5 cores, also written as 1500m.

memory object

No Description Provided.


limit string

The maximum amount of memory that should be available to the Pod. Specified as a byte Quantity, which means these suffixes are supported: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following represent roughly the same value: 128974848, 129e6, 129M, 128974848000m, 123Mi

runtimeLimits object

Additional options that can be specified.

storage object

No Description Provided.


contentRepo object

The Content Repository is simply a place in local storage where the content of all FlowFiles exists and it is typically the largest of the Repositories.

Default size: 4GB


capacity string

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:


    (Note that  may be empty, from the "" case in .)

           ::= 0 | 1 | ... | 9           ::=  |            ::=  | . | . | .             ::= "+" | "-"     ::=  |            ::=  |  |          ::= Ki | Mi | Gi | Ti | Pi | Ei

    (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

       ::= m | "" | k | M | G | T | P | E

    (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 ::= "e"  | "E"  ```

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
selectors object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClass string

No Description Provided.

databaseRepo object

Default size: 1GB


capacity string

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:


    (Note that  may be empty, from the "" case in .)

           ::= 0 | 1 | ... | 9           ::=  |            ::=  | . | . | .             ::= "+" | "-"     ::=  |            ::=  |  |          ::= Ki | Mi | Gi | Ti | Pi | Ei

    (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

       ::= m | "" | k | M | G | T | P | E

    (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 ::= "e"  | "E"  ```

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
selectors object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClass string

No Description Provided.

flowfileRepo object

The FlowFile Repository is where NiFi keeps track of the state and metadata of FlowFiles as they traverse the data flow. The repository ensures durability, reliability, and recoverability of data in case of system failures or interruptions.

Default size: 1GB


capacity string

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:


    (Note that  may be empty, from the "" case in .)

           ::= 0 | 1 | ... | 9           ::=  |            ::=  | . | . | .             ::= "+" | "-"     ::=  |            ::=  |  |          ::= Ki | Mi | Gi | Ti | Pi | Ei

    (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

       ::= m | "" | k | M | G | T | P | E

    (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 ::= "e"  | "E"  ```

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
selectors object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClass string

No Description Provided.

provenanceRepo object

The Provenance Repository is where the history of each FlowFile is stored. This history is used to provide the Data Lineage (also known as the Chain of Custody) of each piece of data.

Default size: 2GB


capacity string

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:


    (Note that  may be empty, from the "" case in .)

           ::= 0 | 1 | ... | 9           ::=  |            ::=  | . | . | .             ::= "+" | "-"     ::=  |            ::=  |  |          ::= Ki | Mi | Gi | Ti | Pi | Ei

    (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

       ::= m | "" | k | M | G | T | P | E

    (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 ::= "e"  | "E"  ```

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
selectors object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClass string

No Description Provided.

stateRepo object

Default size: 1GB


capacity string

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:


    (Note that  may be empty, from the "" case in .)

           ::= 0 | 1 | ... | 9           ::=  |            ::=  | . | . | .             ::= "+" | "-"     ::=  |            ::=  |  |          ::= Ki | Mi | Gi | Ti | Pi | Ei

    (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

       ::= m | "" | k | M | G | T | P | E

    (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 ::= "e"  | "E"  ```

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
selectors object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.


matchExpressions []object

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


key string required

key is the label key that the selector applies to.

operator string required

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

values []string

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

matchLabels object

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

storageClass string

No Description Provided.

configOverrides object

The configOverrides can be used to configure properties in product config files that are not exposed in the CRD. Read the config overrides documentation and consult the operator specific usage guide documentation for details on the available config files and settings for the specific product.

envOverrides object

envOverrides configure environment variables to be set in the Pods. It is a map from strings to strings - environment variables and the value to set. Read the environment variable overrides documentation for more information and consult the operator specific usage guide to find out about the product specific environment variables that are available.

podOverrides object

In the podOverrides property you can define a PodTemplateSpec to override any property that can be set on a Kubernetes Pod. Read the Pod overrides documentation for more information.


metadata object

No Description Provided.


annotations object

No Description Provided.

creationTimestamp string

No Description Provided.

deletionGracePeriodSeconds integer

No Description Provided.

deletionTimestamp string

No Description Provided.

finalizers []string

No Description Provided.

generateName string

No Description Provided.

generation integer

No Description Provided.

labels object

No Description Provided.

managedFields []object

No Description Provided.


apiVersion string

No Description Provided.

fieldsType string

No Description Provided.

fieldsV1 object

No Description Provided.

manager string

No Description Provided.

operation string

No Description Provided.

subresource string

No Description Provided.

time string

No Description Provided.

name string

No Description Provided.

namespace string

No Description Provided.

ownerReferences []object

No Description Provided.


apiVersion string

No Description Provided.

blockOwnerDeletion boolean

No Description Provided.

controller boolean

No Description Provided.

kind string

No Description Provided.

name string

No Description Provided.

uid string

No Description Provided.

resourceVersion string

No Description Provided.

selfLink string
uid string

No Description Provided.

spec object

No Description Provided.


activeDeadlineSeconds integer

No Description Provided.

affinity object

No Description Provided.


nodeAffinity object

No Description Provided.


preferredDuringSchedulingIgnoredDuringExecution []object

No Description Provided.


preference object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchFields []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

weight integer

No Description Provided.

requiredDuringSchedulingIgnoredDuringExecution object

No Description Provided.


nodeSelectorTerms []object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchFields []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

podAffinity object

No Description Provided.


preferredDuringSchedulingIgnoredDuringExecution []object

No Description Provided.


podAffinityTerm object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

matchLabelKeys []string

No Description Provided.

mismatchLabelKeys []string

No Description Provided.

namespaceSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

namespaces []string

No Description Provided.

topologyKey string

No Description Provided.

weight integer

No Description Provided.

requiredDuringSchedulingIgnoredDuringExecution []object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

matchLabelKeys []string

No Description Provided.

mismatchLabelKeys []string

No Description Provided.

namespaceSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

namespaces []string

No Description Provided.

topologyKey string

No Description Provided.

podAntiAffinity object

No Description Provided.


preferredDuringSchedulingIgnoredDuringExecution []object

No Description Provided.


podAffinityTerm object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

matchLabelKeys []string

No Description Provided.

mismatchLabelKeys []string

No Description Provided.

namespaceSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

namespaces []string

No Description Provided.

topologyKey string

No Description Provided.

weight integer

No Description Provided.

requiredDuringSchedulingIgnoredDuringExecution []object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

matchLabelKeys []string

No Description Provided.

mismatchLabelKeys []string

No Description Provided.

namespaceSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

namespaces []string

No Description Provided.

topologyKey string

No Description Provided.

automountServiceAccountToken boolean

No Description Provided.

containers []object

No Description Provided.


args []string

No Description Provided.

command []string

No Description Provided.

env []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

valueFrom object

No Description Provided.


configMapKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

fieldRef object

No Description Provided.


apiVersion string

No Description Provided.

fieldPath string

No Description Provided.

resourceFieldRef object

No Description Provided.


containerName string

No Description Provided.

divisor string

No Description Provided.

resource string

No Description Provided.

secretKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

envFrom []object

No Description Provided.


configMapRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

prefix string

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

image string

No Description Provided.

imagePullPolicy string

No Description Provided.

lifecycle object

No Description Provided.


postStart object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

preStop object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

livenessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

name string

No Description Provided.

ports []object

No Description Provided.


containerPort integer

No Description Provided.

hostIP string

No Description Provided.

hostPort integer

No Description Provided.

name string

No Description Provided.

protocol string

No Description Provided.

readinessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

resizePolicy []object

No Description Provided.


resourceName string

No Description Provided.

restartPolicy string

No Description Provided.

resources object

No Description Provided.


claims []object

No Description Provided.


name string

No Description Provided.

limits object

No Description Provided.

requests object

No Description Provided.

restartPolicy string

No Description Provided.

securityContext object

No Description Provided.


allowPrivilegeEscalation boolean

No Description Provided.

appArmorProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

capabilities object

No Description Provided.


add []string

No Description Provided.

drop []string

No Description Provided.

privileged boolean

No Description Provided.

procMount string

No Description Provided.

readOnlyRootFilesystem boolean

No Description Provided.

runAsGroup integer

No Description Provided.

runAsNonRoot boolean

No Description Provided.

runAsUser integer

No Description Provided.

seLinuxOptions object

No Description Provided.


level string

No Description Provided.

role string

No Description Provided.

type string

No Description Provided.

user string

No Description Provided.

seccompProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

windowsOptions object

No Description Provided.


gmsaCredentialSpec string

No Description Provided.

gmsaCredentialSpecName string

No Description Provided.

hostProcess boolean

No Description Provided.

runAsUserName string

No Description Provided.

startupProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

stdin boolean

No Description Provided.

stdinOnce boolean

No Description Provided.

terminationMessagePath string

No Description Provided.

terminationMessagePolicy string

No Description Provided.

tty boolean

No Description Provided.

volumeDevices []object

No Description Provided.


devicePath string

No Description Provided.

name string

No Description Provided.

volumeMounts []object

No Description Provided.


mountPath string

No Description Provided.

mountPropagation string

No Description Provided.

name string

No Description Provided.

readOnly boolean

No Description Provided.

recursiveReadOnly string

No Description Provided.

subPath string

No Description Provided.

subPathExpr string

No Description Provided.

workingDir string

No Description Provided.

dnsConfig object

No Description Provided.


nameservers []string

No Description Provided.

options []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

searches []string

No Description Provided.

dnsPolicy string

No Description Provided.

enableServiceLinks boolean
ephemeralContainers []object

No Description Provided.


args []string

No Description Provided.

command []string

No Description Provided.

env []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

valueFrom object

No Description Provided.


configMapKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

fieldRef object

No Description Provided.


apiVersion string

No Description Provided.

fieldPath string

No Description Provided.

resourceFieldRef object

No Description Provided.


containerName string

No Description Provided.

divisor string

No Description Provided.

resource string

No Description Provided.

secretKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

envFrom []object

No Description Provided.


configMapRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

prefix string

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

image string

No Description Provided.

imagePullPolicy string

No Description Provided.

lifecycle object

No Description Provided.


postStart object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

preStop object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

livenessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

name string

No Description Provided.

ports []object

No Description Provided.


containerPort integer

No Description Provided.

hostIP string

No Description Provided.

hostPort integer

No Description Provided.

name string

No Description Provided.

protocol string

No Description Provided.

readinessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

resizePolicy []object

No Description Provided.


resourceName string

No Description Provided.

restartPolicy string

No Description Provided.

resources object

No Description Provided.


claims []object

No Description Provided.


name string

No Description Provided.

limits object

No Description Provided.

requests object

No Description Provided.

restartPolicy string

No Description Provided.

securityContext object

No Description Provided.


allowPrivilegeEscalation boolean

No Description Provided.

appArmorProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

capabilities object

No Description Provided.


add []string

No Description Provided.

drop []string

No Description Provided.

privileged boolean

No Description Provided.

procMount string

No Description Provided.

readOnlyRootFilesystem boolean

No Description Provided.

runAsGroup integer

No Description Provided.

runAsNonRoot boolean

No Description Provided.

runAsUser integer

No Description Provided.

seLinuxOptions object

No Description Provided.


level string

No Description Provided.

role string

No Description Provided.

type string

No Description Provided.

user string

No Description Provided.

seccompProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

windowsOptions object

No Description Provided.


gmsaCredentialSpec string

No Description Provided.

gmsaCredentialSpecName string

No Description Provided.

hostProcess boolean

No Description Provided.

runAsUserName string

No Description Provided.

startupProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

stdin boolean

No Description Provided.

stdinOnce boolean

No Description Provided.

targetContainerName string

No Description Provided.

terminationMessagePath string

No Description Provided.

terminationMessagePolicy string

No Description Provided.

tty boolean

No Description Provided.

volumeDevices []object

No Description Provided.


devicePath string

No Description Provided.

name string

No Description Provided.

volumeMounts []object

No Description Provided.


mountPath string

No Description Provided.

mountPropagation string

No Description Provided.

name string

No Description Provided.

readOnly boolean

No Description Provided.

recursiveReadOnly string

No Description Provided.

subPath string

No Description Provided.

subPathExpr string

No Description Provided.

workingDir string

No Description Provided.

hostAliases []object

No Description Provided.


hostnames []string

No Description Provided.

ip string

No Description Provided.

hostIPC boolean

No Description Provided.

hostNetwork boolean

No Description Provided.

hostPID boolean

No Description Provided.

hostUsers boolean

No Description Provided.

hostname string

No Description Provided.

imagePullSecrets []object

No Description Provided.


name string

No Description Provided.

initContainers []object

No Description Provided.


args []string

No Description Provided.

command []string

No Description Provided.

env []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

valueFrom object

No Description Provided.


configMapKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

fieldRef object

No Description Provided.


apiVersion string

No Description Provided.

fieldPath string

No Description Provided.

resourceFieldRef object

No Description Provided.


containerName string

No Description Provided.

divisor string

No Description Provided.

resource string

No Description Provided.

secretKeyRef object

No Description Provided.


key string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

envFrom []object

No Description Provided.


configMapRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

prefix string

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

optional boolean

No Description Provided.

image string

No Description Provided.

imagePullPolicy string

No Description Provided.

lifecycle object

No Description Provided.


postStart object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

preStop object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

sleep object

No Description Provided.


seconds integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

livenessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

name string

No Description Provided.

ports []object

No Description Provided.


containerPort integer

No Description Provided.

hostIP string

No Description Provided.

hostPort integer

No Description Provided.

name string

No Description Provided.

protocol string

No Description Provided.

readinessProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

resizePolicy []object

No Description Provided.


resourceName string

No Description Provided.

restartPolicy string

No Description Provided.

resources object

No Description Provided.


claims []object

No Description Provided.


name string

No Description Provided.

limits object

No Description Provided.

requests object

No Description Provided.

restartPolicy string

No Description Provided.

securityContext object

No Description Provided.


allowPrivilegeEscalation boolean

No Description Provided.

appArmorProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

capabilities object

No Description Provided.


add []string

No Description Provided.

drop []string

No Description Provided.

privileged boolean

No Description Provided.

procMount string

No Description Provided.

readOnlyRootFilesystem boolean

No Description Provided.

runAsGroup integer

No Description Provided.

runAsNonRoot boolean

No Description Provided.

runAsUser integer

No Description Provided.

seLinuxOptions object

No Description Provided.


level string

No Description Provided.

role string

No Description Provided.

type string

No Description Provided.

user string

No Description Provided.

seccompProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

windowsOptions object

No Description Provided.


gmsaCredentialSpec string

No Description Provided.

gmsaCredentialSpecName string

No Description Provided.

hostProcess boolean

No Description Provided.

runAsUserName string

No Description Provided.

startupProbe object

No Description Provided.


exec object

No Description Provided.


command []string

No Description Provided.

failureThreshold integer

No Description Provided.

grpc object

No Description Provided.


port integer

No Description Provided.

service string

No Description Provided.

httpGet object

No Description Provided.


host string

No Description Provided.

httpHeaders []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

path string

No Description Provided.

port

No Description Provided.

scheme string

No Description Provided.

initialDelaySeconds integer

No Description Provided.

periodSeconds integer

No Description Provided.

successThreshold integer

No Description Provided.

tcpSocket object

No Description Provided.


host string

No Description Provided.

port

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

timeoutSeconds integer

No Description Provided.

stdin boolean

No Description Provided.

stdinOnce boolean

No Description Provided.

terminationMessagePath string

No Description Provided.

terminationMessagePolicy string

No Description Provided.

tty boolean

No Description Provided.

volumeDevices []object

No Description Provided.


devicePath string

No Description Provided.

name string

No Description Provided.

volumeMounts []object

No Description Provided.


mountPath string

No Description Provided.

mountPropagation string

No Description Provided.

name string

No Description Provided.

readOnly boolean

No Description Provided.

recursiveReadOnly string

No Description Provided.

subPath string

No Description Provided.

subPathExpr string

No Description Provided.

workingDir string

No Description Provided.

nodeName string

No Description Provided.

nodeSelector object

No Description Provided.

os object

No Description Provided.


name string

No Description Provided.

overhead object

No Description Provided.

preemptionPolicy string

No Description Provided.

priority integer

No Description Provided.

priorityClassName string

No Description Provided.

readinessGates []object

No Description Provided.


conditionType string

No Description Provided.

resourceClaims []object

No Description Provided.


name string

No Description Provided.

source object

No Description Provided.


resourceClaimName string

No Description Provided.

resourceClaimTemplateName string

No Description Provided.

restartPolicy string

No Description Provided.

runtimeClassName string

No Description Provided.

schedulerName string

No Description Provided.

schedulingGates []object

No Description Provided.


name string

No Description Provided.

securityContext object

No Description Provided.


appArmorProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

fsGroup integer

No Description Provided.

fsGroupChangePolicy string

No Description Provided.

runAsGroup integer

No Description Provided.

runAsNonRoot boolean

No Description Provided.

runAsUser integer

No Description Provided.

seLinuxOptions object

No Description Provided.


level string

No Description Provided.

role string

No Description Provided.

type string

No Description Provided.

user string

No Description Provided.

seccompProfile object

No Description Provided.


localhostProfile string

No Description Provided.

type string

No Description Provided.

supplementalGroups []integer

No Description Provided.

sysctls []object

No Description Provided.


name string

No Description Provided.

value string

No Description Provided.

windowsOptions object

No Description Provided.


gmsaCredentialSpec string

No Description Provided.

gmsaCredentialSpecName string

No Description Provided.

hostProcess boolean

No Description Provided.

runAsUserName string

No Description Provided.

serviceAccount string

No Description Provided.

serviceAccountName string

No Description Provided.

setHostnameAsFQDN boolean

No Description Provided.

shareProcessNamespace boolean

No Description Provided.

subdomain string

No Description Provided.

terminationGracePeriodSeconds integer

No Description Provided.

tolerations []object

No Description Provided.


effect string

No Description Provided.

key string

No Description Provided.

operator string

No Description Provided.

tolerationSeconds integer

No Description Provided.

value string

No Description Provided.

topologySpreadConstraints []object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

matchLabelKeys []string

No Description Provided.

maxSkew integer

No Description Provided.

minDomains integer

No Description Provided.

nodeAffinityPolicy string

No Description Provided.

nodeTaintsPolicy string

No Description Provided.

topologyKey string

No Description Provided.

whenUnsatisfiable string

No Description Provided.

volumes []object

No Description Provided.


awsElasticBlockStore object

No Description Provided.


fsType string

No Description Provided.

partition integer

No Description Provided.

readOnly boolean

No Description Provided.

volumeID string

No Description Provided.

azureDisk object

No Description Provided.


cachingMode string

No Description Provided.

diskName string

No Description Provided.

diskURI string

No Description Provided.

fsType string

No Description Provided.

kind string

No Description Provided.

readOnly boolean

No Description Provided.

azureFile object

No Description Provided.


readOnly boolean

No Description Provided.

secretName string

No Description Provided.

shareName string

No Description Provided.

cephfs object

No Description Provided.


monitors []string

No Description Provided.

path string

No Description Provided.

readOnly boolean

No Description Provided.

secretFile string

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

user string

No Description Provided.

cinder object

No Description Provided.


fsType string

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

volumeID string

No Description Provided.

configMap object

No Description Provided.


defaultMode integer

No Description Provided.

items []object

No Description Provided.


key string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

csi object

No Description Provided.


driver string

No Description Provided.

fsType string

No Description Provided.

nodePublishSecretRef object

No Description Provided.


name string

No Description Provided.

readOnly boolean

No Description Provided.

volumeAttributes object

No Description Provided.

downwardAPI object

No Description Provided.


defaultMode integer

No Description Provided.

items []object

No Description Provided.


fieldRef object

No Description Provided.


apiVersion string

No Description Provided.

fieldPath string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

resourceFieldRef object

No Description Provided.


containerName string

No Description Provided.

divisor string

No Description Provided.

resource string

No Description Provided.

emptyDir object

No Description Provided.


medium string

No Description Provided.

sizeLimit string

No Description Provided.

ephemeral object

No Description Provided.


volumeClaimTemplate object

No Description Provided.


metadata object

No Description Provided.


annotations object

No Description Provided.

creationTimestamp string

No Description Provided.

deletionGracePeriodSeconds integer

No Description Provided.

deletionTimestamp string

No Description Provided.

finalizers []string

No Description Provided.

generateName string

No Description Provided.

generation integer

No Description Provided.

labels object

No Description Provided.

managedFields []object

No Description Provided.


apiVersion string

No Description Provided.

fieldsType string

No Description Provided.

fieldsV1 object

No Description Provided.

manager string

No Description Provided.

operation string

No Description Provided.

subresource string

No Description Provided.

time string

No Description Provided.

name string

No Description Provided.

namespace string

No Description Provided.

ownerReferences []object

No Description Provided.


apiVersion string

No Description Provided.

blockOwnerDeletion boolean

No Description Provided.

controller boolean

No Description Provided.

kind string

No Description Provided.

name string

No Description Provided.

uid string

No Description Provided.

resourceVersion string

No Description Provided.

selfLink string
uid string

No Description Provided.

spec object

No Description Provided.


accessModes []string

No Description Provided.

dataSource object

No Description Provided.


apiGroup string

No Description Provided.

kind string

No Description Provided.

name string

No Description Provided.

dataSourceRef object

No Description Provided.


apiGroup string

No Description Provided.

kind string

No Description Provided.

name string

No Description Provided.

namespace string

No Description Provided.

resources object

No Description Provided.


limits object

No Description Provided.

requests object

No Description Provided.

selector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

storageClassName string

No Description Provided.

volumeAttributesClassName string

No Description Provided.

volumeMode string

No Description Provided.

volumeName string

No Description Provided.

fc object

No Description Provided.


fsType string

No Description Provided.

lun integer

No Description Provided.

readOnly boolean

No Description Provided.

targetWWNs []string

No Description Provided.

wwids []string

No Description Provided.

flexVolume object

No Description Provided.


driver string

No Description Provided.

fsType string

No Description Provided.

options object

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

flocker object

No Description Provided.


datasetName string

No Description Provided.

datasetUUID string

No Description Provided.

gcePersistentDisk object

No Description Provided.


fsType string

No Description Provided.

partition integer

No Description Provided.

pdName string

No Description Provided.

readOnly boolean

No Description Provided.

gitRepo object

No Description Provided.


directory string

No Description Provided.

repository string

No Description Provided.

revision string

No Description Provided.

glusterfs object

No Description Provided.


endpoints string

No Description Provided.

path string

No Description Provided.

readOnly boolean

No Description Provided.

hostPath object

No Description Provided.


path string

No Description Provided.

type string

No Description Provided.

iscsi object

No Description Provided.


chapAuthDiscovery boolean

No Description Provided.

chapAuthSession boolean

No Description Provided.

fsType string

No Description Provided.

initiatorName string

No Description Provided.

iqn string

No Description Provided.

iscsiInterface string

No Description Provided.

lun integer

No Description Provided.

portals []string

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

targetPortal string

No Description Provided.

name string

No Description Provided.

nfs object

No Description Provided.


path string

No Description Provided.

readOnly boolean

No Description Provided.

server string

No Description Provided.

persistentVolumeClaim object

No Description Provided.


claimName string

No Description Provided.

readOnly boolean

No Description Provided.

photonPersistentDisk object

No Description Provided.


fsType string

No Description Provided.

pdID string

No Description Provided.

portworxVolume object

No Description Provided.


fsType string

No Description Provided.

readOnly boolean

No Description Provided.

volumeID string

No Description Provided.

projected object

No Description Provided.


defaultMode integer

No Description Provided.

sources []object

No Description Provided.


clusterTrustBundle object

No Description Provided.


labelSelector object

No Description Provided.


matchExpressions []object

No Description Provided.


key string

No Description Provided.

operator string

No Description Provided.

values []string

No Description Provided.

matchLabels object

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

path string

No Description Provided.

signerName string

No Description Provided.

configMap object

No Description Provided.


items []object

No Description Provided.


key string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

downwardAPI object

No Description Provided.


items []object

No Description Provided.


fieldRef object

No Description Provided.


apiVersion string

No Description Provided.

fieldPath string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

resourceFieldRef object

No Description Provided.


containerName string

No Description Provided.

divisor string

No Description Provided.

resource string

No Description Provided.

secret object

No Description Provided.


items []object

No Description Provided.


key string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

name string

No Description Provided.

optional boolean

No Description Provided.

serviceAccountToken object

No Description Provided.


audience string

No Description Provided.

expirationSeconds integer

No Description Provided.

path string

No Description Provided.

quobyte object

No Description Provided.


group string

No Description Provided.

readOnly boolean

No Description Provided.

registry string

No Description Provided.

tenant string

No Description Provided.

user string

No Description Provided.

volume string

No Description Provided.

rbd object

No Description Provided.


fsType string

No Description Provided.

image string

No Description Provided.

keyring string

No Description Provided.

monitors []string

No Description Provided.

pool string

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

user string

No Description Provided.

scaleIO object

No Description Provided.


fsType string

No Description Provided.

gateway string

No Description Provided.

protectionDomain string

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

sslEnabled boolean

No Description Provided.

storageMode string

No Description Provided.

storagePool string

No Description Provided.

system string

No Description Provided.

volumeName string

No Description Provided.

secret object

No Description Provided.


defaultMode integer

No Description Provided.

items []object

No Description Provided.


key string

No Description Provided.

mode integer

No Description Provided.

path string

No Description Provided.

optional boolean

No Description Provided.

secretName string

No Description Provided.

storageos object

No Description Provided.


fsType string

No Description Provided.

readOnly boolean

No Description Provided.

secretRef object

No Description Provided.


name string

No Description Provided.

volumeName string

No Description Provided.

volumeNamespace string

No Description Provided.

vsphereVolume object

No Description Provided.


fsType string

No Description Provided.

storagePolicyID string

No Description Provided.

storagePolicyName string

No Description Provided.

volumePath string

No Description Provided.

roleConfig object

This is a product-agnostic RoleConfig, which is sufficient for most of the products.


podDisruptionBudget object

This struct is used to configure:

  1. If PodDisruptionBudgets are created by the operator 2. The allowed number of Pods to be unavailable (maxUnavailable)

Learn more in the allowed Pod disruptions documentation.


enabled boolean

Whether a PodDisruptionBudget should be written out for this role. Disabling this enables you to specify your own - custom - one. Defaults to true.

maxUnavailable integer

The number of Pods that are allowed to be down because of voluntary disruptions. If you don't explicitly set this, the operator will use a sane default based upon knowledge about the individual product.

roleGroups object required

No Description Provided.

status object

No Description Provided.


conditions []object

No Description Provided.


lastTransitionTime string

Last time the condition transitioned from one status to another.

lastUpdateTime string

The last time this condition was updated.

message string

A human readable message indicating details about the transition.

reason string

The reason for the condition's last transition.

status string: enum required
Enum variants: TrueFalseUnknown

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

type string: enum required
Enum variants: AvailableDegradedProgressingReconciliationPausedStopped

Type of deployment condition.

deployed_version string

No Description Provided.