NiFi cluster

NifiCluster describes the desired state of the NiFi cluster we want to setup through the operator.

apiVersion: nifi.konpyutaika.com/v1
kind: NifiCluster
metadata:
  name: simplenifi
spec:
  service:
    headlessEnabled: true
    annotations:
      tyty: ytyt
    labels:
      tete: titi  
  pod:
    annotations:
      toto: tata
    labels:
      titi: tutu
  zkAddress: 'zookeepercluster-client.zookeeper:2181'
  zkPath: '/simplenifi'
  clusterImage: 'apache/nifi:1.11.3'
  oneNifiNodePerNode: false
  nodeConfigGroups:
    default_group:
      isNode: true
      podMetadata:
        annotations:
          node-annotation: "node-annotation-value"
        labels:
          node-label: "node-label-value"
      externalVolumeConfigs:
        - name: example-volume
          mountPath: "/opt/nifi/example"
          secret:
            secretName: "raw-controller"
      storageConfigs:
        - mountPath: '/opt/nifi/nifi-current/logs'
          name: logs
          # Metadata to attach to the PVC that gets created
          metadata:
            labels:
              my-label: my-value
            annotations:
              my-annotation: my-value
          pvcSpec:
            accessModes:
              - ReadWriteOnce
            storageClassName: 'standard'
            resources:
              requests:
                storage: 10Gi
      serviceAccountName: 'default'
      resourcesRequirements:
        limits:
          cpu: '2'
          memory: 3Gi
        requests:
          cpu: '1'
          memory: 1Gi
  nodes:
    - id: 1
      nodeConfigGroup: 'default_group'
    - id: 2
      nodeConfigGroup: 'default_group'
  propagateLabels: true
  nifiClusterTaskSpec:
    retryDurationMinutes: 10
  listenersConfig:
    internalListeners:
      - type: 'http'
        name: 'http'
        containerPort: 8080
      - type: 'cluster'
        name: 'cluster'
        containerPort: 6007
      - type: 's2s'
        name: 's2s'
        containerPort: 10000
  externalServices:
    - name: 'clusterip'
      spec:
        type: ClusterIP
        portConfigs:
          - port: 8080
            internalListenerName: 'http'
      metadata:
        annotations:
          toto: tata
        labels:
          titi: tutu

NifiCluster

Field	Type	Description	Required	Default
metadata	ObjectMetadata	is metadata that all persisted resources must have, which includes all objects users must create.	No	nil
spec	NifiClusterSpec	defines the desired state of NifiCluster.	No	nil
status	NifiClusterStatus	defines the observed state of NifiCluster.	No	nil

NifiClusterSpec

Field	Type	Description	Required	Default
clientType	Enum=basic	defines if the operator will use basic or tls authentication to query the NiFi cluster.	No	tls
type	Enum=internal	defines if the cluster is internal (i.e manager by the operator) or external.	No	internal
nodeURITemplate	string	used to dynamically compute node uri.	if external type	-
nifiURI	stringused access through a LB uri.	if external type	-
rootProcessGroupId	string	contains the uuid of the root process group for this cluster.	if external type	-
secretRef	[ ]SecretReference	reference the secret containing the informations required to authentiticate to the cluster.	if external type	-
proxyUrl	string	defines the proxy required to query the NiFi cluster.	if external type	-
service	ServicePolicy	defines the policy for services owned by NiFiKop operator.	No	-
pod	PodPolicy	defines the policy for pod owned by NiFiKop operator.	No	-
zkAddress	string	specifies the ZooKeeper connection string in the form hostname:port where host and port are those of a Zookeeper server.	No	""
zkPath	string	specifies the Zookeeper chroot path as part of its Zookeeper connection string which puts its data under same path in the global ZooKeeper namespace.	Yes	"/"
initContainerImage	string	can override the default image used into the init container to check if ZoooKeeper server is reachable.	Yes	"bash"
initContainers	[ ]string	defines additional initContainers configurations.	No	[ ]
clusterImage	string	can specify the whole nificluster image in one place.	No	""
oneNifiNodePerNode	boolean	if set to true every nifi node is started on a new node, if there is not enough node to do that it will stay in pending state. If set to false the operator also tries to schedule the nifi node to a unique node but if the node number is insufficient the nifi node will be scheduled to a node where a nifi node is already running.	No	nil
propagateLabels	boolean	whether the labels defined on the NifiCluster metadata will be propagated to resources created by the operator or not.	Yes	false
managedAdminUsers	[ ]ManagedUser	contains the list of users that will be added to the managed admin group (with all rights).	No	[]
managedReaderUsers	[ ]ManagedUser	contains the list of users that will be added to the managed admin group (with all rights).	No	[]
readOnlyConfig	ReadOnlyConfig	specifies the read-only type Nifi config cluster wide, all theses will be merged with node specified readOnly configurations, so it can be overwritten per node.	No	nil
nodeUserIdentityTemplate	string	specifies the template to be used when naming the node user identity (e.g. node-%d-mysuffix)	Yes	"node-%d-<cluster-name>"
nodeConfigGroups	map[string]NodeConfig	specifies multiple node configs with unique name	No	nil
nodes	[ ]Node	specifies the list of cluster nodes, all node requires an image, unique id, and storageConfigs settings	Yes	nil
disruptionBudget	DisruptionBudget	defines the configuration for PodDisruptionBudget.	No	nil
ldapConfiguration	LdapConfiguration	specifies the configuration if you want to use LDAP.	No	nil
singleUserConfiguration	SingleUserConfiguration	specifies the configuration if you want to use SingleUser.	No	nil
nifiClusterTaskSpec	NifiClusterTaskSpec	specifies the configuration of the nifi cluster Tasks.	No	nil
listenersConfig	ListenersConfig	specifies nifi's listener specifig configs.	No	-
sidecarConfigs	[ ]Container	Defines additional sidecar configurations. [Check documentation for more informations]
externalServices	[ ]ExternalServiceConfigs	specifies settings required to access nifi externally.	No	-
topologySpreadConstraints	[ ]TopologySpreadConstraint	specifies any TopologySpreadConstraint objects to be applied to all nodes.	No	nil
nifiControllerTemplate	string	NifiControllerTemplate specifies the template to be used when naming the node controller (e.g. %s-mysuffix) Warning: once defined don't change this value either the operator will no longer be able to manage the cluster	Yes	"%s-controller"
controllerUserIdentity	string	ControllerUserIdentity specifies what to call the static admin user's identity Warning: once defined don't change this value either the operator will no longer be able to manage the cluster	Yes	false

NifiClusterStatus

Field	Type	Description	Required	Default
nodesState	map[string]NodeState	Store the state of each nifi node.	No	-
State	ClusterState	Store the state of each nifi node.	Yes	-
rootProcessGroupId	string	contains the uuid of the root process group for this cluster.	No	-

ServicePolicy

Field	Type	Description	Required	Default
headlessEnabled	boolean	specifies if the cluster should use headlessService for Nifi or individual services using service per nodes may come an handy case of service mesh.	Yes	false
serviceTemplate	string	specifies the template to be used when naming the service.	Yes	If headlessEnabled = true ? "%s-headless" = "%s-all-node"
annotations	map[string]string	Annotations specifies the annotations to attach to services the NiFiKop operator creates	No	-
labels	map[string]string	Labels specifies the labels to attach to services the NiFiKop operator creates	No	-

PodPolicy

Field	Type	Description	Required	Default
annotations	map[string]string	Annotations specifies the annotations to attach to pods the NiFiKop operator creates	No	-
labels	map[string]string	Labels specifies the Labels to attach to pods the NiFiKop operator creates	No	-
hostAliases	[ ]HostAlias	A list of host aliases to include in every pod's /etc/hosts configuration in the scenario where DNS is not available.	No	[ ]
readinessProbe	Probe	The readiness probe that the Pod is configured with. If not provided, a default will be used.	No	nil
livenessProbe	Probe	The liveness probe that the Pod is configured with. If not provided, a default will be used.	No	nil

ManagedUsers

Field	Type	Description	Required	Default
identity	string	identity field is use to define the user identity on NiFi cluster side, it use full when the user's name doesn't suite with Kubernetes resource name.	No	-
name	string	name field is use to name the NifiUser resource, if not identity is provided it will be used to name the user on NiFi cluster side.	Yes	-

DisruptionBudget

Field	Type	Description	Required	Default
create	bool	if set to true, will create a podDisruptionBudget.	No	-
budget	string	the budget to set for the PDB, can either be static number or a percentage.	Yes	-

LdapConfiguration

Field	Type	Description	Required	Default
enabled	boolean	if set to true, we will enable ldap usage into nifi.properties configuration.	No	false
url	string	space-separated list of URLs of the LDAP servers (i.e. ldap://${hostname}:${port}).	No	""
searchBase	string	base DN for searching for users (i.e. CN=Users,DC=example,DC=com).	No	""
searchFilter	string	Filter for searching for users against the 'User Search Base'. (i.e. sAMAccountName=0). The user specified name is inserted into '0'.	No	""

SingleUserConfiguration

Field	Type	Description	Required	Default
enabled	boolean	specifies whether or not the cluster should use single user authentication for Nifi	No	false
authorizerEnabled	boolean	specifies if the cluster should use use the single-user-authorizer instead of the managed-authorizer (if enabled, the creation of users and user groups will not work in NiFi, and the single user will have no rights by default.)	No	true
secretRef	SecretReference	references the secret containing the informations required to authentiticate to the cluster	No	nil
secretKeys	UserSecretKeys	references the keys from the secret containing the user name and password.	No	{username:"username", password:"password"}

NifiClusterTaskSpec

Field	Type	Description	Required	Default
retryDurationMinutes	int	describes the time the operator waits before going back and retrying a cluster task, which can be: scale up, scale down, rolling upgrade..	Yes	5

ClusterState

Name	Value	Description
NifiClusterInitializing	ClusterInitializing	states that the cluster is still in initializing stage
NifiClusterInitialized	ClusterInitialized	states that the cluster is initialized
NifiClusterReconciling	ClusterReconciling	states that the cluster is still in reconciling stage
NifiClusterRollingUpgrading	ClusterRollingUpgrading	states that the cluster is rolling upgrading
NifiClusterRunning	ClusterRunning	states that the cluster is in running state
NifiClusterNoNodes	NifiClusterNoNodes	states that the cluster has no nodes

UserSecretKeys

Field	Type	Description	Required	Default
username	string	specifies he name of the secret key to retrieve the user name.	No	username
password	string	specifies he name of the secret key to retrieve the user password.	No	password