index.adoc

Usage guide

This section will help you to use various aspects of the Stackable Operator for Apache NiFi. For a general introduction into the operator follow the getting_started/index.adoc guide. Below is a general overview of some configuration aspects, have a look at the sub pages for details.

The cluster is configured via a YAML manifest file. This custom resource specifies the amount of replicas for each role group or role specific configuration like resource requests. The following listing shows an example configuration:

apiVersion: nifi.stackable.tech/v1alpha1
kind: NifiCluster
metadata:
  name: simple-nifi
spec:
  image:
    productVersion: 1.21.0
  clusterConfig:
    zookeeperConfigMapName: simple-nifi-znode  # (1)
    authentication:  # (2)
      - authenticationClass: simple-nifi-admin-user
    extraVolumes:  # (3)
      - name: nifi-client-certs
        secret:
          secretName: nifi-client-certs
    listenerClass: external-unstable
    sensitiveProperties:
      keySecret: nifi-sensitive-property-key
      autoGenerate: true
  nodes:
  roleGroups:
    default:
      config:
        resources:  # (4)
          cpu:
            min: "500m"
            max: "4"
          memory:
            limit: '2Gi'
        replicas: 3

1. The ZooKeeper instance to use.

2. How users should authenticate themselves.

3. Extra volumes with files that can be referenced in custom workflows.

4. CPU and memory configuration can be set per role group.

Not shown are the common settings for starting and stopping the cluster and distributing Pods. Additionally you can set any NiFi setting using overrides. You can also configure log aggregation.