You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ma...@apache.org on 2014/12/19 20:16:23 UTC
[02/10] incubator-nifi git commit: NIFI-150: Added documentation in
asciidoc format
NIFI-150: Added documentation in asciidoc format
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/a23c7f2e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/a23c7f2e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/a23c7f2e
Branch: refs/heads/develop
Commit: a23c7f2e2b6b57adf7adbf00e81d05ec1d657bb2
Parents: 578974e
Author: Mark Payne <ma...@hotmail.com>
Authored: Thu Dec 18 17:10:42 2014 -0500
Committer: Mark Payne <ma...@hotmail.com>
Committed: Thu Dec 18 17:10:42 2014 -0500
----------------------------------------------------------------------
nifi-docs/pom.xml | 38 ++
.../images/add-processor-with-tag-cloud.png | Bin 0 -> 22925 bytes
.../src/main/asciidoc/images/add-processor.png | Bin 0 -> 31524 bytes
.../src/main/asciidoc/images/addConnect.png | Bin 0 -> 1996 bytes
.../src/main/asciidoc/images/comments-tab.png | Bin 0 -> 6431 bytes
.../src/main/asciidoc/images/components.png | Bin 0 -> 8992 bytes
.../asciidoc/images/connection-settings.png | Bin 0 -> 15214 bytes
.../main/asciidoc/images/create-connection.png | Bin 0 -> 9430 bytes
.../asciidoc/images/edit-property-dropdown.png | Bin 0 -> 14291 bytes
.../asciidoc/images/edit-property-textarea.png | Bin 0 -> 17146 bytes
.../src/main/asciidoc/images/iconConnection.png | Bin 0 -> 1517 bytes
.../src/main/asciidoc/images/iconDelete.png | Bin 0 -> 670 bytes
.../src/main/asciidoc/images/iconFunnel.png | Bin 0 -> 1223 bytes
nifi-docs/src/main/asciidoc/images/iconInfo.png | Bin 0 -> 550 bytes
.../src/main/asciidoc/images/iconInputPort.png | Bin 0 -> 1842 bytes
.../src/main/asciidoc/images/iconLabel.png | Bin 0 -> 838 bytes
.../src/main/asciidoc/images/iconOutputPort.png | Bin 0 -> 1658 bytes
.../main/asciidoc/images/iconProcessGroup.png | Bin 0 -> 1422 bytes
.../src/main/asciidoc/images/iconProcessor.png | Bin 0 -> 1446 bytes
.../asciidoc/images/iconRemoteProcessGroup.png | Bin 0 -> 674 bytes
.../src/main/asciidoc/images/iconTemplate.png | Bin 0 -> 970 bytes
.../images/instantiate-template-description.png | Bin 0 -> 6508 bytes
.../asciidoc/images/instantiate-template.png | Bin 0 -> 3216 bytes
nifi-docs/src/main/asciidoc/images/new-flow.png | Bin 0 -> 53989 bytes
.../main/asciidoc/images/nifi-navigation.png | Bin 0 -> 85458 bytes
.../asciidoc/images/nifi-toolbar-components.png | Bin 0 -> 72263 bytes
.../images/processor-connection-bubble.png | Bin 0 -> 9936 bytes
.../src/main/asciidoc/images/properties-tab.png | Bin 0 -> 11847 bytes
.../src/main/asciidoc/images/scheduling-tab.png | Bin 0 -> 12288 bytes
.../src/main/asciidoc/images/settings-tab.png | Bin 0 -> 16225 bytes
.../src/main/asciidoc/images/status-bar.png | Bin 0 -> 57171 bytes
.../src/main/asciidoc/nifi-user-guide.adoc | 519 +++++++++++++++++++
pom.xml | 8 +-
33 files changed, 561 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/pom.xml
----------------------------------------------------------------------
diff --git a/nifi-docs/pom.xml b/nifi-docs/pom.xml
new file mode 100644
index 0000000..1b74533
--- /dev/null
+++ b/nifi-docs/pom.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.nifi</groupId>
+ <artifactId>nifi-parent</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>nifi-docs</artifactId>
+
+ <name>nifi-docs</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.5.0</version>
+ <executions>
+ <execution>
+ <id>output-html</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>process-asciidoc</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <backend>html</backend>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ </dependencies>
+</project>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/add-processor-with-tag-cloud.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/add-processor-with-tag-cloud.png b/nifi-docs/src/main/asciidoc/images/add-processor-with-tag-cloud.png
new file mode 100644
index 0000000..a0bbadb
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/add-processor-with-tag-cloud.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/add-processor.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/add-processor.png b/nifi-docs/src/main/asciidoc/images/add-processor.png
new file mode 100644
index 0000000..a043f38
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/add-processor.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/addConnect.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/addConnect.png b/nifi-docs/src/main/asciidoc/images/addConnect.png
new file mode 100644
index 0000000..b33a305
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/addConnect.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/comments-tab.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/comments-tab.png b/nifi-docs/src/main/asciidoc/images/comments-tab.png
new file mode 100644
index 0000000..b6ed34b
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/comments-tab.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/components.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/components.png b/nifi-docs/src/main/asciidoc/images/components.png
new file mode 100644
index 0000000..b3a9769
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/components.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/connection-settings.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/connection-settings.png b/nifi-docs/src/main/asciidoc/images/connection-settings.png
new file mode 100644
index 0000000..9aae93a
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/connection-settings.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/create-connection.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/create-connection.png b/nifi-docs/src/main/asciidoc/images/create-connection.png
new file mode 100644
index 0000000..7ca40ae
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/create-connection.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png b/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png
new file mode 100644
index 0000000..017805b
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png b/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png
new file mode 100644
index 0000000..cc8668a
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconConnection.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconConnection.png b/nifi-docs/src/main/asciidoc/images/iconConnection.png
new file mode 100644
index 0000000..4b6180b
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconConnection.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconDelete.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconDelete.png b/nifi-docs/src/main/asciidoc/images/iconDelete.png
new file mode 100644
index 0000000..dc13227
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconDelete.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconFunnel.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconFunnel.png b/nifi-docs/src/main/asciidoc/images/iconFunnel.png
new file mode 100644
index 0000000..98f9b9d
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconFunnel.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconInfo.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconInfo.png b/nifi-docs/src/main/asciidoc/images/iconInfo.png
new file mode 100644
index 0000000..f192ff5
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconInfo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconInputPort.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconInputPort.png b/nifi-docs/src/main/asciidoc/images/iconInputPort.png
new file mode 100644
index 0000000..d4efd97
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconInputPort.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconLabel.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconLabel.png b/nifi-docs/src/main/asciidoc/images/iconLabel.png
new file mode 100644
index 0000000..6ba3c13
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconLabel.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconOutputPort.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconOutputPort.png b/nifi-docs/src/main/asciidoc/images/iconOutputPort.png
new file mode 100644
index 0000000..f3d8a66
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconOutputPort.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconProcessGroup.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconProcessGroup.png b/nifi-docs/src/main/asciidoc/images/iconProcessGroup.png
new file mode 100644
index 0000000..c587341
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconProcessGroup.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconProcessor.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconProcessor.png b/nifi-docs/src/main/asciidoc/images/iconProcessor.png
new file mode 100644
index 0000000..2ca062c
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconProcessor.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconRemoteProcessGroup.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconRemoteProcessGroup.png b/nifi-docs/src/main/asciidoc/images/iconRemoteProcessGroup.png
new file mode 100644
index 0000000..5205470
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconRemoteProcessGroup.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/iconTemplate.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/iconTemplate.png b/nifi-docs/src/main/asciidoc/images/iconTemplate.png
new file mode 100644
index 0000000..66d2caa
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconTemplate.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/instantiate-template-description.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/instantiate-template-description.png b/nifi-docs/src/main/asciidoc/images/instantiate-template-description.png
new file mode 100644
index 0000000..a238148
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/instantiate-template-description.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/instantiate-template.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/instantiate-template.png b/nifi-docs/src/main/asciidoc/images/instantiate-template.png
new file mode 100644
index 0000000..435d562
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/instantiate-template.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/new-flow.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/new-flow.png b/nifi-docs/src/main/asciidoc/images/new-flow.png
new file mode 100644
index 0000000..59f64d8
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/new-flow.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/nifi-navigation.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/nifi-navigation.png b/nifi-docs/src/main/asciidoc/images/nifi-navigation.png
new file mode 100644
index 0000000..1841cba
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/nifi-navigation.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/nifi-toolbar-components.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/nifi-toolbar-components.png b/nifi-docs/src/main/asciidoc/images/nifi-toolbar-components.png
new file mode 100644
index 0000000..3fd7170
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/nifi-toolbar-components.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/processor-connection-bubble.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/processor-connection-bubble.png b/nifi-docs/src/main/asciidoc/images/processor-connection-bubble.png
new file mode 100644
index 0000000..82a161b
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/processor-connection-bubble.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/properties-tab.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/properties-tab.png b/nifi-docs/src/main/asciidoc/images/properties-tab.png
new file mode 100644
index 0000000..0e60fb9
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/properties-tab.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/scheduling-tab.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/scheduling-tab.png b/nifi-docs/src/main/asciidoc/images/scheduling-tab.png
new file mode 100644
index 0000000..20ca0f5
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/scheduling-tab.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/settings-tab.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/settings-tab.png b/nifi-docs/src/main/asciidoc/images/settings-tab.png
new file mode 100644
index 0000000..77d6bd7
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/settings-tab.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/images/status-bar.png
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/images/status-bar.png b/nifi-docs/src/main/asciidoc/images/status-bar.png
new file mode 100644
index 0000000..7030eca
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/status-bar.png differ
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/nifi-docs/src/main/asciidoc/nifi-user-guide.adoc
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/nifi-user-guide.adoc b/nifi-docs/src/main/asciidoc/nifi-user-guide.adoc
new file mode 100644
index 0000000..931819d
--- /dev/null
+++ b/nifi-docs/src/main/asciidoc/nifi-user-guide.adoc
@@ -0,0 +1,519 @@
+NiFi User Guide
+===============
+Apache_NiFi_Team
+:toc:
+:icons:
+
+
+[template="glossary", id="terminology"]
+Terminology
+-----------
+*DataFlow Manager*: A DataFlow Manager (DFM) is a NiFi user who has permissions to add, remove, and modify components of a NiFi dataflow.
+
+*FlowFile*: The FlowFile represents a single piece of data in NiFi. A FlowFile is made up of two components:
+ FlowFile Attributes and FlowFile Content.
+ Content is the data that is represented by the FlowFile. Attributes are key-value pairs that provide information or
+ context about the data.
+ All FlowFiles have the following Standard Attributes:
+
+- *uuid*: A unique identifier for the FlowFile
+- *filename*: A human-readable filename that may be used when storing the data to disk or in an external service
+- *path*: A hierarchically structured value that can be used when storing data to disk or an external service so that the data is not stored in a single directory
+
+*Processor*: The Processor is the NiFi component that is used to listen for incoming data; pull data from external sources;
+ publish data to external sources; and route, transform, or extract information from FlowFiles.
+
+*Relationship*: Each Processor has zero or more Relationships defined for it. These Relationships are named to indicate the result of processing a FlowFile.
+ After a Processor has finished processing a FlowFile, it will route (or “transfer”) the FlowFile to one of the Relationships.
+ A DataFlow Manager is then able to connect each of these Relationships to other components in order to specify where the FlowFile should
+ go next under each potential processing result.
+
+*Connection*: A DataFlow Manager creates an automated dataflow by dragging components from the Components part of the NiFi toolbar to the canvas
+ and then connecting the components together via Connections. Each connection consists of one or more Relationships.
+ For each Connection that is drawn, a DataFlow Manager can determine which Relationships should be used for the Connection.
+ This allows data to be routed in different ways based on its processing outcome. Each connection houses a FlowFile Queue.
+ When a FlowFile is transferred to a particular Relationship, it is added to the queue belonging to the associated Connection.
+
+*Funnel*: A funnel is a NiFi component that is used to combine the data from several Connections into a single Connection.
+
+*Process Group*: When a dataflow becomes complex, it often is beneficial to reason about the dataflow at a higher, more abstract level.
+ NiFi allows multiple components, such as Processors, to be grouped together into a Process Group.
+ The NiFi User Interface then makes it easy for a DataFlow Manager to connect together multiple Process Groups into a logical dataflow,
+ as well as allowing the DataFlow Manager to enter a Process Group in order to see and manipulate the components within the Process Group.
+
+*Port*: Dataflows that are constructed using one or more Process Groups need a way to connect a Process Group to other dataflow components.
+ This is achieved by using Ports. A DataFlow Manager can add any number of Input Ports and Output Ports to a Process Group and name these ports appropriately.
+
+*Remote Process Group*: Just as data is transferred into and out of a Process Group, it is sometimes necessary to transfer data from one instance of NiFi to another.
+ While NiFi provides many different mechanisms for transferring data from one system to another, Remote Process Groups are often the easiest way to accomplish
+ this if transferring data to another instance of NiFi.
+
+*Bulletin*: The NiFi User Interface provides a significant amount of monitoring and feedback about the current status of the application.
+ In addition to rolling statistics and the current status that are provided for each component, components are able to report Bulletins.
+ Whenever a component reports a Bulletin, an icon is displayed on that component (or on the Status bar near the top of the page, for System-Level Bulletins).
+ Using the mouse to hover over that icon will provide a tool-tip that shows the time and severity (Debug, Info, Warning, Error) of the bulletin,
+ as well as the message of the Bulletin.
+ Bulletins from all components can also be viewed and filtered in the Bulletins Page, available in the Management Toolbar.
+
+*Template*: Often times, a dataflow is comprised of many sub-flows that could be reused. NiFi allows DataFlow Managers to select a part of the dataflow
+ (or the entire dataflow) and create a Template. This Template is given a name can then be dragged onto the canvas just like the other components.
+ As a result, several components be combined together to make a larger building block from which to create a dataflow.
+ These templates can also be exported as XML and imported into another NiFi instance, allowing these building blocks to be shared.
+
+
+
+NiFi User Interface
+-------------------
+
+The NiFi User Interface (UI) provides mechanisms for creating automated dataflows, as well as visualizing,
+editing, monitoring, and administering those dataflows. The UI can be broken down into several different segments,
+each responsible for different functionality of the application. We will begin by looking at screenshots of the
+application and labeling the different segments of the UI. We will provide a brief explanation of the purpose of each segment.
+Then, in the following sections of this document, we will discuss each of those segments in greater detail.
+
+When the application is started, by default, the user is able to navigate to the User Interface by going to
+`http://<hostname>:8080/nifi` in a web browser. There are no permissions configured, by default, so anyone is
+able to view and modify the dataflow. For information on securing the system, see Systems Administrator guide.
+
+When a DataFlow Manager navigates to the UI for the first time, a blank canvas is provided on which a dataflow can be built:
+
+image::new-flow.png["Empty Flow"]
+
+Along the top of the of the screen is a toolbar that contains several of these segments.
+To the left is the Components Toolbar. This toolbar consists of the different components that can be dragged onto the canvas.
+
+Next to the Components Toolbar is the Actions Toolbar. This toolbar consists of buttons to manipulate the existing
+components on the graph. Following the Actions Toolbar is the Search Toolbar. This toolbar consists of a single
+Search field that allows users to easily find components on the graph. Users are able to search by component name,
+type, identifier, and configuration properties.
+
+Finally, the Management Toolbar sits to the right-hand side of the screen. This toolbar consists of buttons that are
+of use to DataFlow Managers to manage the flow as well as administrators who may use this section to manage user access
+and configure system properties, such as how many system resources should be provided to the application.
+
+image::nifi-toolbar-components.png["NiFi Components Toolbar"]
+
+Next, we have segments that provide capabilities to easily navigate around the graph. On the left-hand side is a toolbar that
+provides the ability to pan around the graph and zoom in and out. On the right-hand side is a “Birds-Eye View” of the dataflow.
+This provides a high-level view of the dataflow and allows the user to quickly and easily pan across large portions of the dataflow.
+Along the top of the screen is a trail of breadcrumbs. As users navigate into and out of Process Groups, the breadcrumbs show
+the depth in the flow and each Process Group that was entered to reach this depth. Each of the Process Groups listed in the breadcrumbs
+is a link that will take you back up to that level in the flow.
+
+image::nifi-navigation.png["NiFi Navigation"]
+
+Below the breadcrumbs lives the Status bar. The Status bar provides information about how many Processors exist in the graph in
+each state (Stopped, Running, Invalid, Disabled), how many Remote Process Groups exist on the graph in each state
+(Transmitting, Not Transmitting), the number of threads that are currently active in the flow, the amount of data that currently
+exists in the flow, and the timestamp at which all of this information was last refreshed. If there are any System-Level bulletins,
+these are shown in the Status bar as well. Additionally, if the instance of NiFi is clustered, the Status bar shows many nodes
+are in the cluster and how many are currently connected.
+
+image::status-bar.png["NiFi Status Bar"]
+
+
+
+
+
+Building a DataFlow
+-------------------
+
+A DataFlow Manager (DFM) is able to build an automated dataflow using the NiFi User Interface (UI). This is accomplished
+by dragging components from the toolbar to the canvas, configuring the components to meet specific needs, and connecting
+the components together.
+
+
+=== Adding Components to the Canvas
+
+In the User Interface section above, we outlined the different segments of the UI and pointed out a Components Toolbar.
+Here, we will look at each of the Components in that toolbar:
+
+image::components.png["Components"]
+
+image:iconProcessor.png["Processor", width=32]
+*Processor*: The Processor is the most commonly used component, as it is responsible for data ingress, egress, routing, and
+ manipulating. There are many different types of Processors. In fact, this is a very common Extension Point in NiFi,
+ meaning that many vendors may implement their own Processors to perform whatever functions are necessary for their use case.
+ When a Processor is dragged onto the graph, the user is presented with a dialog to choose which type of Processor to use:
+
+image::add-processor.png["Add Processor Dialog"]
+
+In the top-right corner, the user is able to filter the list based on the Processor Type or the Tags associated with a Processor.
+Processor developers have the ability to add Tags to their Processors. These tags are used in this dialog for filtering and are
+displayed on the left-hand side in a Tag Cloud. The more Processors that exist with a particular Tag, the larger the Tag appears
+in the Tag Cloud. Clicking a Tag in the Cloud will filter the available Processors to only those that contain that Tag. If multiple
+Tags are selected, only those Processors that contain all of those Tags are shown. For example, if we want to show only those
+Processors that allow us to ingest data via HTTP, we can select both the `http` Tag and the `ingest` Tag:
+
+image::add-processor-with-tag-cloud.png["Add Processor with Tag Cloud"]
+
+Clicking the `Add` button or double-clicking on a Processor Type will add the selected Processor to the canvas at the
+location that it was dropped.
+
+
+
+image:iconInputPort.png["Input Port", width=32]
+*Input Port*: Input Ports provide a mechanism for transferring data into a Process Group. When an Input Port is dragged
+onto the canvas, the DFM is prompted to name the Port. All Ports within a Process Group must have unique names.
+
+All components exist only within a Process Group. When a user navigates to the NiFi page, the user is placed in the
+Root Progress Group. If the Input Port is dragged onto the Root Progress Group, the Input Port provides a mechanism
+to receive data from remote instances of NiFi. In this case, the Input Port can be configured to restrict access to
+appropriate users.
+
+
+
+
+image:iconOutputPort.png["Output Port", width=32]
+*Output Port*: Output Ports provide a mechanism for transferring data from a Process Group back to destination outside
+of the Process Group. When an Output Port is dragged onto the canvas, the DFM is prompted to name the Port. All Ports
+within a Process Group must have unique names.
+
+If the Output Port is dragged onto the Root Process Group, the Output Port provides a mechanism for sending data to
+remote instances of NiFi. In this case, the Port acts as a queue. As remote instances of NiFi pull data from the port,
+that data is removed from the queues of the incoming Connections.
+
+
+
+image:iconProcessGroup.png["Process Group", width=32]
+*Process Group*: Process Groups can be used logically group a set of components so that the dataflow is easier to understand
+and maintain. When a Process Group is dragged onto the canvas, the DFM is prompted to name the Process Group. All Process
+Groups within the same parent group must have unique names.
+
+
+
+image:iconRemoteProcessGroup.png["Remote Process Group", width=32]
+*Remote Process Group*: Remote Process Groups appear and behave similar to Process Groups. However, the Remote Process Group (RPG)
+references a remote instance of NiFi. When an RPG is dragged onto the canvas, rather than being prompted for a name, the DFM
+is prompted for the URL of the remote NiFi instance. If the remote NiFi is a clustered instance, the URL that should be used
+is the URL of the remote instance's NiFi Cluster Manager (NCM). When data is transferred to a clustered instance of NiFi
+via an RPG, the RPG it will first connect to the remote instance's NCM to determine which nodes are in the cluster and
+how busy each node is. This information is then used to load balance the data that is pushed to each node. The remote NCM is
+then interrogated periodically to ensure that any nodes that are dropped from the cluster and no longer sent to, any new nodes
+will be added to the list of nodes, and to recalculate the load balancing based on each node's load.
+
+
+
+image:iconFunnel.png["Funnel", width=32]
+*Funnel*: Funnels are used to combine the data from many Connections into a single Connection. This has two advantages.
+First, if many Connections are created with the same destination, the canvas can become cluttered if those Connections
+have to span a large space. By funneling these Connections into a single Connection, that single Connection can then be
+drawn to span that large space instead. Secondly, Connections can be configured with FlowFile Prioritizers. Data from
+several Connections can be funneled into a single Connection, providing the ability to Prioritize all of the data on that
+one Connection, rather than prioritizing the data on each Connection independently.
+
+
+
+image:iconTemplate.png["Template", width=32]
+*Template*: Templates can be created by DataFlow Managers from sections of the flow, or they can be imported from other
+dataflows. These Templates provide larger building blocks for creating a complex flow quickly. When the Template is
+dragged onto the canvas, the DFM is provided a dialog to choose which Template to add to the canvas:
+
+image::instantiate-template.png["Instantiate Template Dialog"]
+
+Clicking the drop-down box shows all available Templates. Any Template that was created with a description will show an
+icon indicating that there is more information. Hovering over the icon with the mouse will show this description:
+
+image::instantiate-template-description.png["Instantiate Template Dialog"]
+
+
+
+
+image:iconLabel.png["Label"]
+*Label*: Labels are used to provide documentation to parts of a dataflow. When a Label is dropped onto the canvas,
+it is created with a default size. The Label can then be resized by dragging the handle in the bottom-right corner.
+The Label has no text when initially created. The text of the Label can be added by right-clicking on the Label and
+choosing `Configure...`
+
+
+
+
+=== Configuring a Processor
+
+Once a Processor has been dragged onto the Canvas, it is ready to configure. This is done by right-clicking on the
+Processor and clicking the `Configure...` option from the context menu. The configuration dialog is opened with four
+different tabs, each of which is discussed below. Once you have finished configuring the Processor, you can apply
+the changes by clicking the `Apply` button or cancel all changes by clicking the `Cancel` button.
+
+Note that after a Processor has been started, the context menu shown for the Processor no longer has a `Configure...`
+option but rather has a `View Configuration` option. Processor configuration cannot be changed while the Processor is
+running. You must first stop the Processor and wait for all of its active tasks to complete before configuring
+the Processor again.
+
+
+==== Settings Tab
+
+The first tab in the Processor Configuration dialog is the Settings tab:
+
+image::settings-tab.png["Settings Tab"]
+
+This tab contains several different configuration items. First, it allows the DFM to change the name of the Processor.
+The name of a Processor by default is the same as the Processor type. Next to the Processor Name is a control for
+determining whether or not the Processor is Enabled. When a Processor is added to the graph, it is enabled. If the
+Processor is disabled, it cannot be started. This is used to indicate that even when a group of Processors are started,
+such as when a DFM starts an entire Process Group, this Processor should be excluded.
+
+Below the Name configuration, the Processor's unique identifier is displayed along with the Processor's type. These
+values cannot be modified.
+
+Next are two dialogues for configuring `Penalty duration' and `Yield duration'. During the normal course of processing a
+piece of data (a FlowFile), an event may occur that indicates that the data cannot be processed at this time but the
+data may be processable at a later time. When this occurs, the Processor may choose to Penalize the FlowFile. This will
+prevent the FlowFile from being Processed for some period of time. For example, if the Processor is to push the data
+to a remote service, but the remote service already has a file with the same name as the filename that the Processor
+is specifying, the Processor may penalize the FlowFile. The `Penalty duration' allows the DFM to specify what
+how long the FlowFile should be penalized. The default value is 30 seconds.
+
+Similarly, the Processor may determine that some situation exists such that the Processor can no longer make any progress,
+regardless of the data that it is processing. For example, if a Processor is to push data to a remote service and that
+service is not responding, the Processor cannot make any progress. As a result, the Processor should `yield,' which will
+prevent the Processor from being scheduled to run for some period of time. That period of time is specified by setting
+the `Yield duration.' The default value is 1 second.
+
+The last configurable option on the left-hand side of the Settings tab is the Bulletin level. Whenever the Processor writes
+to its log, the Processor also will generate a Bulletin. This setting indicates the lowest level of Bulletin that should be
+shown in the User Interface. By default, the Bulletin level is set to WARN.
+
+The right-hand side of the dialogue provides an `Auto-terminate relationships' section. Each of the Relationships that is
+defined by the Processor is listed here, along with its description. In order for a Processor to be considered valid and
+able to run, each Relationship defined by the Processor must be either connected to a downstream component or auto-terminated.
+If a Relationship is auto-terminated, any FlowFile that is routed to that Relationship will be removed from the flow and
+its processing considered complete. Any Relationship that is already connected to a downstream component cannot be auto-terminated.
+The Relationship must first be removed from any Connection that uses it. Additionally, for any Relationship that is selected to be
+auto-terminated, the auto-termination status will be cleared if the Relationship is added to a Connection.
+
+
+
+
+==== Scheduling Tab
+
+The second tab in the Processor Configuration dialog is the Scheduling Tab:
+
+image::scheduling-tab.png["Scheduling Tab"]
+
+The first configuration option is the Scheduling Strategy. There are three options for scheduling components:
+
+- *Timer driven*: This is the default mode. The Processor will be scheduled to run on a regular interval. The interval
+ at which the Processor is run is defined by the `Run schedule' option (see below).
+- *Event driven*: When this mode is selected, the Processor will be triggered to run by FlowFiles entering the Connections
+ that have this Processor as their destination. This mode is not supported by all Processors. When this mode is
+ selected, the `Run schedule' option is not configurable, as the Processor is not triggered to run periodically but
+ rather is triggered to run as the result of an event. Additionally, this is the only mode for which the `Concurrent tasks'
+ option can be set to 0. In this case, the number of threads is limited only by the size of the Event-Driven Thread Pool that
+ the administrator has configured.
+- *CRON driven*: When using the CRON driven scheduling mode, the Processor is scheduled to run periodically, similarly to the
+ Timer driven scheduling mode. However, the CRON driven mode provides significantly more flexibility at the expensive of
+ increasing the complexity of the configuration. This value is made up of 6 fields, each separated by a space. These
+ fields represent the following fields:
++
+ . Seconds
+ . Minutes
+ . Hours
+ . Day of Month
+ . Month
+ . Day of Week
+ . Year
++
+The value for each of these fields should be a number, range, or increment.
+Range here refers to a syntax of <number>-<number>.
+For example,the Seconds field could be set to 0-30, meaning that the Processor should only be scheduled if the time is 0 to 30 seconds
+after the minute. Additionally, a value of `*` indicates that all values are valid for this field. Multiple values can also
+be entered using a `,` as a separator: `0,5,10,15,30`.
+An increment is written as <start value>/<increment>. For example, settings a value of `0/10` for the seconds fields means that valid
+values are 0, 10, 20, 30, 40, and 50. However, if we change this to `5/10`, valid values become 5, 15, 25, 35, 45, and 55.
++
+For the Month field, valid values are 1 (January) through 12 (December).
++
+For the Day of Week field, valid values are 1 (Sunday) through 7 (Saturday). Additionally, a value of `L` may be appended to one of these
+values to indicate the last occurrence of this day in the month. For example, `1L` can be used to indicate the last Monday of the month.
+
+
+Next, the Scheduling Tab provides a configuration option named `Concurrent tasks.' This controls how many threads the Processor
+will use. Said a different way, this controls how many FlowFiles should be processed by this Processor at the same time. Increasing
+this value will typically allow the Processor to handle more data in the same amount of time. However, it does this by using system
+resources that then are not usable by other Processors. This essentially provides a relative weighting of Processors -- it controls
+how much of the system's resources should be allocated to this Processor instead of other Processors. This field is available for
+most Processors. There are, however, some types of Processors that can only be scheduled with a single Concurrent task.
+
+The `Run schedule` dictates how often this Processor should be scheduled to run. The valid values for this field depend on the selected
+Scheduling Strategy (see above). If using the Event driven Scheduling Strategy, this field is not available. When using the Timer driven
+Scheduling Strategy, this value is a time duration specified by a number followed by a time unit. For example, `1 second` or `5 mins`.
+The default value of `0 sec` means that the Processor should run as often as possible as long as it has data to process. This is true
+for any time duration of 0, regardless of the time unit (i.e., `0 sec`, `0 mins`, `0 days`). For an explanation of values that are
+applicable for the CRON driven Scheduling Strategy, see the description of the CRON driven Scheduling Strategy itself.
+
+The right-hand side of the tab contains a slider for choosing the `Run duration.' This controls how long the Processor should be scheduled
+to run each time that it is triggered. On the left-hand side of the slider, it is marked `Lower latency' while the right-hand side
+is marked `Higher throughput.' When a Processor finishes running, it must update the repository in order to transfer the FlowFiles to
+the next Connection. Updating this repository is expensive, so the more work that can be done at once before updating the repository
+the more work the Processor can handle (Higher throughput). However, this means that the next Processor cannot start processing
+those FlowFiles until the previous Process updates this repository. As a result, the latency will be longer (the time required to process
+the FlowFile from beginning to end will be longer). As a result, the slider provides a spectrum from which the DFM can choose to favor
+Lower Latency or Higher Throughput.
+
+
+==== Properties Tab
+
+The Properties Tab provides a mechanism to configure Processor-specific behavior. There are no default properties. Each type of Processor
+must define which Properties make sense for its use case. Below, we see the Properties Tab for a RouteOnAttribute Processor:
+
+image::properties-tab.png["Properties Tab"]
+
+This Processor, by default, has only a single property: `Routing Strategy.' The default value is `Route on Property name.' Next to
+the name of this property is a small question-mark symbol (
+image:iconInfo.png["Question Mark"]
+). This help symbol is seen in other places throughout the application, as well, and indicates that more information is available.
+Hovering over this symbol with the mouse will provide additional details about the property and the default value, as well as
+historical values that have been set for the Property.
+
+Clicking on the value for the property will allow a DFM to change the value. Depending on the values that are allowed for the property,
+the user is either provided a drop-down from which to choose a value or is given a text area to type a value:
+
+image::edit-property-dropdown.png["Edit Property with Dropdown"]
+
+In the top-right corner of the tab is a button for adding a New Property. Clicking this button will provide the DFM with a dialog to
+enter the name and value of a new property. Not all Processors allow User-Defined properties. In this case, the Processor would become
+invalid when the properties are applied. RouteOnAttribute, for example, does allow User-Defined properties. In fact, this Processor
+will not be valid until the user has added a property.
+
+image:edit-property-textarea.png["Edit Property with Text Area"]
+
+Not that after a User-Defined property has been added, an icon will appear on the right-hand side of that row (
+image:iconDelete.png["Delete Icon"]
+). Clicking this button will remove the User-Defined property from the Processor.
+
+
+
+==== Comments Tab
+
+The last tab in the Processor configuration dialog is the Comments tab. This tab simply provides an area for users to provide
+whatever comments are appropriate for this component:
+
+image::comments-tab.png["Comments Tab"]
+
+
+=== Additional Help
+
+
+
+=== Connecting Components
+
+After the appropriate Processors have been added to the graph and configured to meet your needs, they will have to be connected
+to one another so that NiFi knows what to do with each FlowFile after it has been processed. This is accomplished by creating a
+Connection between two components. When the mouse hovers over a component, a new Connection icon (
+image:addConnect.png["Connection Bubble"]
+) will appear in the middle of the component:
+
+image:processor-connection-bubble.png["Processor with Connection Bubble"]
+
+This Connection bubble can then be dragged from this component to another component, which will provide to the user a
+`Create Connection' dialog. This dialog consists of two tabs: `Details' and `Settings'.
+
+==== Details Tab
+
+The Details Tab provides information about the source and destination components, including the component name, the
+component type, and the Process Group in which the component lives:
+
+image::create-connection.png["Create Connection"]
+
+Additionally, this tab provides the ability to choose which Relationships should be included in this Connection. At least one
+Relationship must be selected. If only one Relationship is available, it is automatically selected.
+
+*Note*: If multiple Connections are added with the same Relationship, any FlowFile that is routed to that Relationship will
+automatically be `cloned', and a copy will be sent to each of those Connections.
+
+==== Settings
+
+The Settings Tab provides the ability to configure the Connection's name, FlowFile expiration, back pressure thresholds, and
+Prioritization:
+
+image:connection-settings.png["Connection Settings"]
+
+The Connection name is optional. If not specified, the name shown for the Connection will be names of the Relationships
+that are active for the Connection.
+
+File expiration is a concept by which data that cannot be processed in a timely fashion can be automatically destroyed.
+This is useful, for example, when the volume of data is expected to exceed the volume that can be sent to a remote site.
+In this case, the expiration can be used in conjunction with Prioritizers to ensure that the highest priority data is
+processed first and then anything that cannot be processed within one hour, for example, can be dropped. The default
+value of `0 sec` indicates that the data will never expire.
+
+NiFi provides two different configuration elements for back pressure. These thresholds indicate how much data should be
+allowed to exist in the queue before the component that is the source of the Connection is no longer scheduled to run.
+This allows the system to avoid being overrun with data.
+
+
+
+
+=== Processor Validation
+
+
+
+
+
+
+
+== Command and Control of DataFlow
+
+=== Starting a Component
+
+=== Stopping a Component
+
+=== Enabling a Component
+
+=== Disabling a Component
+
+
+
+
+
+
+
+== Templates
+
+=== Creating a Template
+
+=== Instantiating a Template
+
+=== Managing Templates
+==== Importing a Template
+==== Exporting a Template
+==== Removing a Template
+
+
+
+
+
+
+== Monitoring of DataFlow
+
+=== Anatomy of a Processor
+
+=== Anatomy of a Process Group
+
+=== Anatomy of a Remote Process Group
+
+=== Status Page
+
+=== Historical Statics of a Component
+
+
+
+
+
+
+
+== Data Provenance
+
+=== Searching for Events
+
+=== Details of an Event
+
+=== Viewing FlowFile Content
+
+=== Replaying a FlowFile
+
+=== Viewing FlowFile Lineage
+==== Find Parents
+==== Expanding an Event
+
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a23c7f2e/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 3dc1bdd..9cccbf4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -12,8 +12,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache</groupId>
@@ -69,7 +68,8 @@
<module>nifi-mock</module>
<module>nar-bundles</module>
<module>assembly</module>
- </modules>
+ <module>nifi-docs</module>
+ </modules>
<scm>
<connection>scm:git:git://git.apache.org/incubator-nifi.git</connection>
<developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-nifi.git</developerConnection>
@@ -958,4 +958,4 @@
</plugin>
</plugins>
</build>
-</project>
+</project>
\ No newline at end of file