Customizable install with Helm

Prerequisites

• Perform any necessary plateform-specific setup
• Install a Helm client with a version higher than 3

Introduction

This Helm chart install NiFiKop the Nifi Kubernetes operator to create/configure/manage NiFi clusters in a Kubernetes Namespace.

It will use Custom Ressources Definition CRDs:

• nificlusters.nifi.konpyutaika.com,
• nifiusers.nifi.konpyutaika.com,
• nifiusergroups.nifi.konpyutaika.com,
• nifiregistryclients.nifi.konpyutaika.com,
• nifiparametercontexts.nifi.konpyutaika.com,
• nifidataflows.nifi.konpyutaika.com,
• nifinodegroupautoscalers.nifi.konpyutaika.com,

Configuration

The following tables lists the configurable parameters of the NiFi Operator Helm chart and their default values.

Parameter	Description	Default
image.repository	Image	ghcr.io/konpyutaika/docker-images/nifikop
image.tag	Image tag	v1.3.1-release
image.pullPolicy	Image pull policy	Always
image.imagePullSecrets.enabled	Enable tue use of secret for docker image	false
image.imagePullSecrets.name	Name of the secret to connect to docker registry	-
certManager.enabled	Enable cert-manager integration	true
rbacEnable	If true, create & use RBAC resources	true
labels	Labels to add to all deployed resources	{}
annotations	Annotations to add to all deployed resources	{}
resources	Pod resource requests & limits	{}
metrics.enabled	deploy service for metrics	false
metrics.port	Set port for operator metrics	8081
logLevel	Log level to output	Info
logEncoding	Log encoding to use. Either json or console	json
certManager.clusterScoped	If true setup cluster scoped resources	false
namespaces	List of namespaces where Operator watches for custom resources. Make sure the operator ServiceAccount is granted get permissions on this Node resource when using limited RBACs.	"" i.e. all namespaces
nodeSelector	Node selector configuration for operator pod	{}
affinity	Node affinity configuration for operator pod	{}
tolerations	Toleration configuration for operator pod	{}
serviceAccount.create	Whether the SA creation is delegated to the chart or not	true
serviceAccount.name	Name of the SA used for NiFiKop deployment	release name
webhook.enabled	Enable webhook migration	true

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install nifikop \
      konpyutaika/nifikop \
      -f values.yaml

Installing the Chart

Skip CRDs

In the case where you don't want to deploy the crds using helm (--skip-crds) you need to deploy manually the crds beforehand:

kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nificlusters.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifiusers.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifiusergroups.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifidataflows.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifiparametercontexts.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifiregistryclients.yaml
kubectl apply -f https://raw.githubusercontent.com/konpyutaika/nifikop/master/config/crd/bases/nifi.konpyutaika.com_nifinodegroupautoscalers.yaml

Conversion webhook

In case you keep the conversions webhook enabled (to handle the conversion of resources from v1alpha1 to v1) you will need to add the following settings to your yaml definition of CRDs:

...
annotations:
    cert-manager.io/inject-ca-from: ${namespace}/${certificate_name}
...
spec:
  ...
  conversion:
    strategy: Webhook
    webhook:
      clientConfig:
        service:
          namespace: ${namespace}
          name: ${webhook_service_name}
          path: /convert
      conversionReviewVersions:
        - v1
        - v1alpha1
  ...

Where:

• namespace: is the namespace in which you will deploy your helm chart.
• certificate_name: is ${helm release name}-webhook-cert
• webhook_service_name: is ${helm release name}-webhook-cert

dry run

helm install nifikop konpyutaika/nifikop \
    --dry-run \
    --set logLevel=Debug \
    --set namespaces={"nifikop"}

release name

helm install <release name> konpyutaika/nifikop

set parameters

helm install nifikop konpyutaika/nifikop --set namespaces={"nifikop"}

the --replace flag allow you to reuses a charts release name

Listing deployed charts

helm list

Get Status for the helm deployment

helm status nifikop

Uninstaling the Charts

If you want to delete the operator from your Kubernetes cluster, the operator deployment should be deleted.

helm del nifikop

The command removes all the Kubernetes components associated with the chart and deletes the helm release.

tip

The CRD created by the chart are not removed by default and should be manually cleaned up (if required)

Manually delete the CRD:

kubectl delete crd nificlusters.nifi.konpyutaika.com
kubectl delete crd nifiusers.nifi.konpyutaika.com
kubectl delete crd nifiusergroups.nifi.konpyutaika.com
kubectl delete crd nifiregistryclients.nifi.konpyutaika.com
kubectl delete crd nifiparametercontexts.nifi.konpyutaika.com
kubectl delete crd nifidataflows.nifi.konpyutaika.com

warning

If you delete the CRD then It will delete ALL Clusters that has been created using this CRD!!! Please never delete a CRD without very good care

Helm always keeps records of what releases happened. Need to see the deleted releases ?

helm list --deleted

Need to see all of the releases (deleted and currently deployed, as well as releases that failed) ?

helm list --all

Because Helm keeps records of deleted releases, a release name cannot be re-used. (If you really need to re-use a release name, you can use the --replace flag, but it will simply re-use the existing release and replace its resources.)

Note that because releases are preserved in this way, you can rollback a deleted resource, and have it re-activate.

To purge a release

helm delete --purge nifikop

Troubleshooting

Install of the CRD

By default, the chart will install the CRDs, but this installation is global for the whole cluster, and you may want to not modify the already deployed CRDs.

In this case there is a parameter to say to not install the CRDs:

$ helm install --name nifikop ./helm/nifikop --set namespaces={"nifikop"} --skip-crds