blob: 6eb3ab3915203dfc7902c9fdb0526003a71616bc [file] [log] [blame]
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
= Getting Started with Apache NiFi Registry
Apache NiFi Team <>
== Who is This Guide For?
This guide is written for users who have basic experience with NiFi but have little familiarity with the NiFi Registry. This guide is not intended to be an exhaustive instruction manual or a reference guide. The link:user-guide.html[NiFi Registry User Guide] and link:[NiFi User Guide^] provide a great deal more information about using the Registry and integrating it with NiFi. This guide, in comparison, is intended to provide users with just the information needed in order to understand how to configure NiFi Registry, connect with NiFi and start using versioned NiFi dataflows.
== Terminology Used in This Guide
In order to talk about NiFi Registry, there are a few key terms that readers should be familiar with:
*Flow*: A process group level NiFi dataflow that has been placed under version control and saved to the Registry.
*Bucket*: A container that stores and organizes flows.
== Downloading and Installing NiFi Registry
NiFi Registry can be downloaded from the link:[NiFi Registry Page^]. There are two packaging options available: a tarball and a zip file. Supported operating systems include Linux, Unix and Mac OS X.
For users who are not running OS X, after downloading NiFi Registry simply extract the archive to the location that you wish to run the application from. The registry is unsecured by default.
For information on how to configure an instance of NiFi Registry (for example, to implement security or change the port that NiFi Registry is running on), see the link:administration-guide.html[System Administrator's Guide].
== Starting NiFi Registry
Once NiFi Registry has been downloaded and installed as described above, it can be started by using the mechanism appropriate for your operating system.
=== For Linux/Unix/Mac OS X users
Use a Terminal window to navigate to the directory where NiFi Registry was installed. To run NiFi Registry in the foreground, run `bin/ run`. This will leave the application running until the user presses Ctrl-C. At that time, it will initiate shutdown of the application.
To run NiFi Registry in the background, instead run `bin/ start`. This will initiate the application to begin running. To check the status and see if NiFi Registry is currently running, execute the command `bin/ status`.
NiFi Registry can be shutdown by executing the command `bin/ stop`.
=== Installing as a Service
To install the application as a service, navigate to the installation directory in a Terminal window and execute the command `bin/ install` to install the service with the default name `nifi-registry`. To specify a custom name for the service, execute the command with an optional second argument that is the name of the service. For example, to install NiFi Registry as a service with the name `flow-registry`, use the command `bin/ install flow-registry`.
Once installed, the service can be started and stopped using the appropriate commands, such as `sudo service nifi-registry start` and `sudo service nifi-registry stop`. Additionally, the running status can be checked via `sudo service nifi-registry status`.
== I Started NiFi Registry. Now What?
Now that NiFi Registry has been started, we can bring up the User Interface (UI). To get started, open a web browser and navigate to
link:http://localhost:18080/nifi-registry[`http://localhost:18080/nifi-registry`^]. The port can be changed by editing the `` file in the NiFi Registry _conf_ directory, but the default port is `18080`.
This will bring up the Registry UI, which at this point is empty as there are no flow resources available to share yet:
image:empty_registry.png["Empty Registry"]
=== Create a Bucket
A bucket is needed in our registry to store and organize NiFi dataflows. To create one, select the Settings icon (image:iconSettings.png["Settings Icon"])in the top right corner of the screen. In the Buckets window, select the "New Bucket" button.
image::new_test_bucket.png["New Bucket"]
Enter the bucket name "Test" and select the "Create" button.
image::test_bucket_dialog.png["Test Bucket Dialog"]
The "Test" bucket is created:
image:test_bucket.png["Test Bucket"]
There are no permissions configured by default, so anyone is able to view, create and modify buckets in this instance. For information on securing the system, see the link:administration-guide.html[System Administrator's Guide].
=== Connect NiFi to the Registry
Now it is time to tell NiFi about the local registry instance.
Start a NiFi instance if one isn't already running and bring up the UI. Go to controller settings from the top-right menu:
image::controller-settings-selection.png["Global Menu - Controller Settings"]
Select the Registry Clients tab and add a new Registry Client giving it a name and the URL of link:http://localhost:18080[`http://localhost:18080`^]:
image::local_registry.png["Local Registry Client"]
=== Start Version Control on a Process Group
With NiFi connected to a NiFi Registry, dataflows can be version controlled on the *process group level*.
Right-click on a process group and select "Version->Start version control" from the context menu:
image::ABCD_process_group_menu.png["ABCD Process Group Menu"]
The local registry instance and "Test" bucket are chosen by default to store your flow since they are the only registry connected and bucket available. Enter a flow name, flow description, comments and select "Save":
image::save_ABCD_flow_dialog.png["Initial Save of ABCD Flow"]
As indicated by the Version State icon (image:iconUpToDate.png["Up To Date Icon"]) in the top left corner of the component, the process group is now saved as a versioned flow in the registry.
image::ABCD_flow_saved.png["ABCD Flow Saved"]
Go back to the Registry UI and return to the main page to see
the versioned flow you just saved (a refresh may be required):
image::ABCD_flow_in_test_bucket.png["ABCD Flow in Test Bucket"]
=== Save Changes to a Versioned Flow
Changes made to the versioned process group can be reviewed, reverted or saved.
For example, if changes are made to the ABCD flow, the Version State changes to "Locally modified" (image:iconLocallyModified.png["Locally Modified Icon"]). The right-click menu will now show the options "Commit local changes", "Show local changes" or "Revert local changes":
image::changed_flow_options.png["Changed Flow Options"]
Select "Show local changes" to see the details of the changes made:
image::ABCD_flow_changes.png["Show ABCD Flow Changes"]
Select "Commit local changes", enter comments and select "Save" to save the changes:
image::ABCD_save_flow_version_2.png["Save ABCD Version 2"]
Version 2 of the flow is saved:
image::ABCD_version_2.png["ABCD Version 2"]
=== Import a Versioned Flow
With a flow existing in the registry, we can use it to illustrate how to import a versioned process group.
In NiFi, select Process Group from the Components toolbar and drag it onto the canvas:
image::drag_process_group.png["Drag Process Group"]
Instead of entering a name, click the Import link:
image::import_flow_from_registry.png["Import Flow From Registry"]
Choose the version of the flow you want imported and select "Import":
image:import_ABCD_version_2.png["Import ABCD Version 2"]
A second identical PG is now added:
image::two_ABCD_flows.png["Two ABCD Flow on Canvas"]
== Where To Go For More Information
In addition to this Getting Started Guide, more information about NiFi Registry and related features in NiFi can be found in the following guides:
- link:user-guide.html[Apache NiFi Registry User Guide] - This guide provides information on how to navigate the Registry UI and explains in detail how to manage flows/policies/special privileges and configure users/groups when the Registry is secured.
- link:administration-guide.html[Apache NiFi Registry System Administrator's Guide] - A guide for setting up and administering Apache NiFi Registry. Topics covered include: system requirements, security configuration, user authentication, authorization, proxy configuration and details about the different system-level settings.
- link:[Apache NiFi User Guide^] - A fairly extensive guide that is often used more as a Reference Guide, as it provides information on each of the different components available in NiFi and explains how to use the different features provided by the application. It includes the section link:["Versioning a Dataflow"] which covers the integration of NiFi with NiFi Registry. Topics covered include: connecting to a registry, version states, importing a versioned flow and managing local changes.
- link:[Contributor's Guide^] - A guide for explaining how to contribute work back to the Apache NiFi community so that others can make use of it.
In addition to the guides provided here, you can browse the different
link:[NiFi Mailing Lists^] or send an e-mail to one of the mailing lists at[] or[].
Many of the members of the NiFi community are also available on Twitter and actively monitor for tweets that mention @apachenifi.