[
https://issues.apache.org/jira/browse/NIFI-2410?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15425579#comment-15425579
]
Sarah Olson commented on NIFI-2410:
-----------------------------------
I've updated the User Guide to reflect the new behavior regarding controller
services. Full text (in asciidoc) is pasted below. In general, I've made the
following changes:
1. Broke the Controller Services and Reporting Tasks section into two new
sections: Controller Service, Reporting Tasks.
2. Added two sub-sections to the Controller Services section: Adding Controller
Services for Reporting Tasks, Adding Controller Services for Dataflows.
3. Added a new introduction to the Controller Services section.
4. Modified the Adding Controller Services for Reporting Tasks section.
5. Added text to the Adding Controller Services for Dataflows section.
Full text of relevant sections:
[[Controller_Services]]
=== Controller Services
Controller Services are available for reporting tasks, processors, and other
services to utilize for
configuration or task execution. You can use the NiFi UI to add Controller
Services for either reporting
tasks or dataflows.
Your ability to view and add Controller Services is dependent on the roles and
privileges assigned to you. If you
do not have access to one or more Controller Services, you are not able to see
or access it in the UI. Roles and
privileges can be assigned on a global or Controller Service-specific basis.
Controller Services are not reporting task or dataflow specific. You have
access to the full set of available Controller
Services whether you are adding it for a reporting task or a dataflow.
[[Controller_Services_for_Reporting_Tasks]]
==== Adding Controller Settings for Reporting Tasks
To add a Controller Service for a reporting task, select Controller Settings
from the Global Menu.
This displays the NiFi Settings window.
The NiFi Settings window has three tabs across the top: General, Controller
Services, and Reporting Tasks. The General tab is
for settings that pertain to general information about the NiFi instance. For
example, here, the DFM can provide a unique name for
the overall dataflow, as well as comments that describe the flow. Be aware that
this information is visible to any other NiFi instance
that connects remotely to this instance (using Remote Process Groups, a.k.a.,
Site-to-Site).
The General tab also provides settings for the overall maximum thread counts of
the instance.
image:settings-general-tab.png["Controller Settings General Tab"]
To the right of the General tab is the Controller Services tab. From this tab,
the DFM may click the "+" button in the upper-right
corner to create a new Controller Service.
image:controller-services-tab.png["Controller Services Tab"]
The Add Controller Service window opens. This window is similar to the Add
Processor window. It provides a list of the
available Controller Services on the right and a tag cloud, showing the most
common category tags used for Controller
Services, on the left. The DFM may click any tag in the tag cloud in order to
narrow down the list of Controller Services
to those that fit the categories desired. The DFM may also use the Filter field
at the top of the window to search
for the desired Controller Service. Upon selecting a Controller Service from
the list, the DFM can see a description of
the the service below. Select the desired controller service and click Add, or
simply double-click the name of the service
to add it.
image:add-controller-service-window.png["Add Controller Service Window"]
Once you have added a Controller Service, you can configure it by clicking the
Edit button in the
far-right column. Other buttons in this column include Remove and Access
Policies.
image:controller-services-edit-buttons.png["Controller Services Buttons"]
You can obtain information about Controller Services by clicking the Details,
Usage, and Alerts buttons in the left-hand column.
image:controller-services-information-buttons.png["Controller Services
Information Buttons"]
When the DFM clicks the Edit button, a Configure Controller Service window
opens. It has three tabs: Settings, Properties,
and Comments. This window is similar to the Configure Processor window. The
Settings tab provides a place for the DFM
to give the Controller Service a unique name (if desired). It also lists the
UUID for the service and provides a list
of other components (processors or other controller services) that reference
the service.
image:configure-controller-service-settings.png["Configure Controller Service
Settings"]
The Properties tab lists the various properties that apply to the particular
controller service. As with configuring
processors, the DFM may hover the over the question mark icons to see more
information about each property.
image:configure-controller-service-properties.png["Configure Controller Service
Properties"]
The Comments tab is just an open-text field, where the DFM may include comments
about the service. After configuring
a Controller Service, click the Apply button to apply the configuration and
close the window, or click the Cancel
button to cancel the changes and close the window.
Note that after a Controller Service has been configured, it must be enabled in
order to run. Do this using the
Enable button in the far-right column of the Controller Services tab of the
Controller Settings window. Then,
in order to modify an existing/running controller service, the DFM needs to
stop/disable it (as well as all referencing processors, reporting tasks, and
controller services). Rather than having to hunt down each component that is
referenced by that controller service, the DFM has the ability to stop/disable
them when disabling the controller service in question. Likewise, when enabling
a controller service, the DFM has the option to start/enable all referencing
processors, reporting tasks, and controller services.
[[Controller_Services_for_Dataflows]]
==== Adding Controller Services for Dataflows
To add a Controller Service for a dataflow, you can either right click a
Process Group and select Configure, or click
Configure from the Operate Palette. When you click Configure from the Operate
Palette with nothing selected on your
canvas, you add a Controller Service for your root Process Group. That
Controller Service is then available to all
nested Process Groups in your dataflow. When you select a Process Group on the
canvas and then click Configure from
either the Operate Palette or the Process Group context menu, you add a
Controller Service only for use with the selected
Process Group.
In either case, use the following steps to add a Controller Service:
. Click Configure, either from the Operate Palette, or from the Process Group
context menu.
. From the Process Group Configuration page, select the Controller Services tab.
. Click the Add button to display the Add Controller Service dialog.
. Select the Controller Service you want to add, and click Add.
. Perform any necessary Controller Service configuration tasks by clicking the
View Details icon (
image:iconViewDetails.png["View Details"]
) in the left-hand column.
[[Reporting_Tasks]]
=== Reporting Tasks
The Reporting Tasks tab behaves similarly to the Controller Services tab. The
DFM has the option to add Reporting Tasks and configure them in the same way as
Controller Services.
image:reporting-tasks-tab.png["Reporting Tasks Tab"]
Once a Reporting Task has been added, the DFM may configure it by clicking the
Edit (pencil icon) in the far-right column. Other buttons in this column
include the Start button, Remove button, and Usage button, which links to the
documentation for the particular Reporting Task.
image:reporting-tasks-edit-buttons2.png["Reporting Tasks Buttons"]
When the DFM clicks the Edit button, a Configure Reporting Task window opens.
It has three tabs: Settings, Properties, and Comments. This window is also
similar to the Configure Processor window. The Settings tab provides a place
for the DFM to give the Reporting Task a unique name (if desired). It also
lists a UUID for the Reporting Task and provides settings for the task's
Scheduling Strategy and Run Schedule (similar to the same settings in a
processor). The DFM may hover the mouse over the question mark icons to see
more information about each setting.
image:configure-reporting-task-settings.png["Configure Reporting Task Settings"]
The Properties tab for a Reporting Task lists the properties that may be
configured for the task. The DFM may hover the mouse over the question mark
icons to see more information about each property.
image:configure-reporting-task-properties.png["Configure Reporting Task
Properties"]
The Comments tab is just an open-text field, where the DFM may include comments
about the task. After configuring the Reporting Task, click the Apply button to
apply the configuration and close the window, or click Cancel to cancel the
changes and close the window.
When you want to run the Reporting Task, click the Start button in the
far-right column of the Reporting Tasks tab.
> Document controller service display
> -----------------------------------
>
> Key: NIFI-2410
> URL: https://issues.apache.org/jira/browse/NIFI-2410
> Project: Apache NiFi
> Issue Type: Task
> Components: Core Framework
> Affects Versions: 1.0.0
> Reporter: Haimo Liu
> Assignee: Sarah Olson
> Priority: Critical
> Fix For: 1.0.0
>
> Attachments: Screen Shot 2016-07-26 at 10.36.08 PM.png, Screen Shot
> 2016-07-26 at 10.57.19 PM.png, Screen Shot 2016-07-26 at 11.05.42 PM.png
>
>
> NIFI 1.0 snapshot, 7/26 build, didn't turn on internal authorization/policy
> management, running in a clustered mode (3-node).
> Group level CS display seems inconsistent
> 1. hamburger menu -> Controller Settings -> Controller Services, can see one
> CS (no matter which PG i am in, can always see this single CS,
> "DBCPConnectionPool", see attached image) this CS is only referenceable by
> Reporting Tasks, NOT by any processors
> 2. Select a PG where I have the GenerateTableFetch processor, click the
> "Configuration" icon in "Operate panel", can see five different controller
> services here, these are all PG level CS. Select nothing (click the canvas),
> click the "Configuration" icon in "Operate panel", can see two different
> controller services here, these are root level CS
> in NIFI 1.0, we need to document the difference between CS that are
> referenceable by processors. vs that are only referenceable by reporting tasks
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
