nifi_registry

Table of Contents

1. Description
2. Setup - The basics of getting started with nifi_registry
   • What nifi_registry affects
   • Setup requirements
   • Beginning with nifi_registry
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 Registry which manages shared resources for Apache NiFi.

Setup

What nifi_registry affects

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

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

Setup Requirements

NiFi Registry requires Java Runtime Environment. Nifi Registry 0.5.0 runs on Java 8, newer than 1.8.0_45.

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 Registry download page also documents how to verify the integrity and authenticity of the downloaded files.

Beginning with nifi_registry

Add dependency modules to your puppet environment:

• camptocamp/systemd
• puppet/archive
• puppetlabs/java (optional, you can install java yourself)
• puppetlabs/stdlib

Usage

To download and install NiFi Registry, include the module. This will download nifi registry, unpack it under /opt/nifi-registry/nifi-registry-<version>, and start the service with default configuration and storage locations.

include nifi_registry

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

nifi_registry::download_url: "http://my-local-repo.example.com/apache/nifi-registry/0.5.0/nifi-registry-0.5.0-bin.tar.gz"

Please keep nifi_registry::download_url, nifi_registry::download_checksum and nifi_registry::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.

Configuration is not managed yet. This can be managed outside the module with file resources.

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

Public Classes

• nifi_registry: Manage Apache Nifi Registry

Private Classes

• nifi_registry::config: Manage configuration for Apache Nifi Registry
• nifi_registry::install: Install Apache Nifi Registry
• nifi_registry::service: Manage the Apache Nifi Registry service

Classes

nifi_registry

Install, configure and run Apache Nifi Registry

Examples

Defaults

include nifi_registry

Downloading from a different repository

class { 'nifi_registry':
  version                => 'x.y.z',
  download_url           => 'https://my.local.repo.example.com/apache/nifi-registry/nifi-registry-x.y.z.tar.gz',
  download_checksum      => 'abcde...',
}

Parameters

The following parameters are available in the nifi_registry class:

• version
• user
• group
• download_url
• download_checksum
• download_checksum_type
• install_root
• download_tmp_dir

version

Data type: String

The version of Apache Nifi Registry. This must match the version in the tarball. This is used for managing files, directories and paths in the service.

Default value: '1.15.1'

user

Data type: String

The user owning the nifi registry installation files, and running the service.

Default value: 'nifiregistry'

group

Data type: String

The group owning the nifi registry installation files, and running the service.

Default value: 'nifiregistry'

download_url

Data type: String

Where to download the binary installation tarball from.

Default value: 'https://dlcdn.apache.org/nifi/1.15.1/nifi-registry-1.15.1-bin.tar.gz'

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: '862e6071a39fe94485a90a69637dccf594d319d8f98739a63828bb2d74af840e'

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 registry installation.

Default value: '/opt/nifi-registry'

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.4.0] - 2021-12-20

Changed

• Install NiFi registry version 1.15.1 by default

0.3.0 - 2021-09-09

Changed

• Install NiFi registry version 1.14.0 by default

Added

• Support OS family Red Hat 7,8
• Add support for Debian 10
• Add support for Ubuntu 20.04

0.2.2 - 2020-07-09

Fixed

• Fix syntax error in module metadata (#1)

0.2.1 - 2020-03-17

Fixed

• Update REFERENCE.md

0.2.0 - 2020-03-17

Added

• Add acceptance tests

Changed

• Update module with PDK 1.17.0

0.1.0 - 2020-01-21

Added

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