nifi_toolkit

Table of Contents

1. Description
2. Setup - The basics of getting started with nifi_toolkit
   • What nifi_toolkit affects
   • Setup requirements
   • Beginning with nifi_toolkit
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

Install and configure the Apache NiFi Toolkit, a CLI for the Apache NiFi dataflow automation software.

Setup

What nifi_toolkit affects

This module will download the Apache Toolkit NiFi tarball to /var/tmp/.

The tarball will be unpacked to /opt/nifi-toolkit by default.

Setup Requirements

NiFi requires Java Runtime Environment. Nifi 1.14.0 runs on Java 8 or Java 11.

When installing on local infrastructure, consider download the distribution tarballs, validate them with the Apache distribution keys, and store it on a local repository. Adjust the configuration variables to point to your local repository. The NiFi download page also documents how to verify the integrity and authenticity of the downloaded files.

Beginning with nifi_toolkit

Add dependency modules to your puppet environment:

• puppet/archive
• puppetlabs/stdlib
• camptocamp/systemd

Usage

To download and install NiFi Toolkit, include the module. This will download nifi toolkit and unpack it under /opt/nifi-toolkit/nifi-toolkit-<version>.

include nifi_toolkit

To host the file locally, add a nifi_toolkit::download_url variable for the module.

nifi_toolkit::download_url: "http://repo.example.com/nifi/1.14.0/nifi-toolkit-1.14.0-bin.tar.gz"

Please keep nifi_toolkit::download_url, nifi_toolkit::download_checksum and nifi_toolkit::version in sync. The URL, checksum and version should match. Otherwise, Puppet will become confused.

Limitations

This module is under development, and therefore somewhat light on functionality.

Development

In the Development section, tell other users the ground rules for contributing to your project and how they should submit their work.

Reference

Table of Contents

Classes

• nifi_toolkit: Install Apache NiFi Toolkit

Classes

nifi_toolkit

Install Apache NiFi Toolkit

Examples

Defaults

include nifi_toolkit

Downloading from a different repository

class { 'nifi_toolkit':
  download_url => 'https://repo.local/nifi/nifi-toolkit-1.10.0.tar.gz',
}

Parameters

The following parameters are available in the nifi_toolkit class:

• version
• download_archive_type
• download_url
• download_checksum
• download_checksum_type
• install_root
• download_tmp_dir

version

Data type: String

The version of Apache NiFi Toolkit. This must match the version in the tarball.

Default value: '1.18.0'

download_archive_type

Data type: Enum['zip','tar.gz']

The archive type of the downloaded tarball.

Default value: 'zip'

download_url

Data type: String

Where to download the binary installation tarball from.

Default value: "https://dlcdn.apache.org/nifi/${version}/nifi-toolkit-${version}-bin.${download_archive_type}"

download_checksum

Data type: String

The expected checksum of the downloaded tarball. This is used for verifying the integrity of the downloaded tarball.

Default value: 'a72ba691feac5c6b9d95b200c2982e431a1b8e7850d36d478fc743ec0cdbb479'

download_checksum_type

Data type: String

The checksum type of the downloaded tarball. This is used for verifying the integrity of the downloaded tarball.

Default value: 'sha256'

install_root

Data type: Stdlib::Absolutepath

The root directory of the nifi toolkit installation.

Default value: '/opt/nifi-toolkit'

download_tmp_dir

Data type: Stdlib::Absolutepath

Default value: '/var/tmp'

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.5.0] - 2022-10-25

Changed

• This module now downloads NiFi as a "zip" archive instead of "tar.gz", and requires the "unzip" package to be present.
• Install NiFi toolkit version 1.18.0 by default.
• Declare support for Ubuntu 22.04 LTS (Jammy Jellyfish)
• Declare support for RHEL 9

0.4.1 - 2022-01-19

Changed

• Install NiFi toolkit version 1.15.3 by default

0.4.0 - 2021-12-20

Changed

• Install NiFi toolkit version 1.15.1 by default

0.3.0 - 2020-08-09

Added

• Add support for Ubuntu LTS 20.04

Changed

• Install NiFi toolkit version 1.14.0 by default

0.2.1 - 2020-03-17

Fixed

• Update REFERENCE.md

0.2.0 - 2020-03-17

Added

• Add a wrapper for cli.sh under /usr/local/bin/nifi-cli.
• Added acceptance testing.

Changed

• Install NiFi toolkit version 1.11.3 by default

0.1.0 - 2020-01-21

Added

• Initial release.
• Download, install and start Apache NiFi Toolkit.