This is an automated email from the ASF dual-hosted git repository.
jgresock pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 422134c55d NIFI-10501 Update User Guide and Registry Quick Start Guide
for Management Controller Services, Registry Client and Replay last event
updates
422134c55d is described below
commit 422134c55d83114fcdae7aa37af2e2ad027ec40a
Author: Andrew Lim <[email protected]>
AuthorDate: Sun Oct 2 20:37:51 2022 -0400
NIFI-10501 Update User Guide and Registry Quick Start Guide for Management
Controller Services, Registry Client and Replay last event updates
This closes #6471.
Signed-off-by: Joe Gresock <[email protected]>
---
.../images/add-parameter-provider-window.png | Bin 0 -> 59304 bytes
.../main/asciidoc/images/add-registry-client.png | Bin 24284 -> 19439 bytes
.../configure-parameter-provider-properties.png | Bin 0 -> 51577 bytes
.../configure-parameter-provider-settings.png | Bin 0 -> 51665 bytes
.../configure-registry-client-properties.png | Bin 0 -> 29050 bytes
.../images/configure-registry-client-settings.png | Bin 0 -> 33754 bytes
.../asciidoc/images/controller-services-tab.png | Bin 113179 -> 93331 bytes
nifi-docs/src/main/asciidoc/images/iconFetch.png | Bin 0 -> 747 bytes
.../main/asciidoc/images/nifi-processor-menu.png | Bin 63227 -> 71631 bytes
.../images/parameter-provider-edit-buttons.png | Bin 0 -> 15950 bytes
.../parameter-provider-tasks-info-buttons.png | Bin 0 -> 13352 bytes
.../asciidoc/images/parameter-providers-tab.png | Bin 0 -> 57406 bytes
.../main/asciidoc/images/registry-client-added.png | Bin 72844 -> 54903 bytes
.../main/asciidoc/images/registry-clients-tab.png | Bin 71646 -> 57563 bytes
.../main/asciidoc/images/reporting-tasks-tab.png | Bin 90093 -> 70152 bytes
.../main/asciidoc/images/settings-general-tab.png | Bin 28994 -> 24008 bytes
nifi-docs/src/main/asciidoc/user-guide.adoc | 69 ++++++++++++++++++---
.../src/main/asciidoc/getting-started.adoc | 15 ++++-
.../main/asciidoc/images/add-registry-client.png | Bin 0 -> 19439 bytes
.../configure-registry-client-properties.png | Bin 0 -> 29112 bytes
.../src/main/asciidoc/images/iconEdit.png | Bin 0 -> 652 bytes
.../src/main/asciidoc/images/local_registry.png | Bin 70503 -> 54395 bytes
.../main/asciidoc/images/registry-client-added.png | Bin 0 -> 54903 bytes
23 files changed, 72 insertions(+), 12 deletions(-)
diff --git
a/nifi-docs/src/main/asciidoc/images/add-parameter-provider-window.png
b/nifi-docs/src/main/asciidoc/images/add-parameter-provider-window.png
new file mode 100644
index 0000000000..881f0700f1
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/add-parameter-provider-window.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/add-registry-client.png
b/nifi-docs/src/main/asciidoc/images/add-registry-client.png
index d6b9760d74..67eb8c8620 100644
Binary files a/nifi-docs/src/main/asciidoc/images/add-registry-client.png and
b/nifi-docs/src/main/asciidoc/images/add-registry-client.png differ
diff --git
a/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-properties.png
b/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-properties.png
new file mode 100644
index 0000000000..cba128b103
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-properties.png
differ
diff --git
a/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-settings.png
b/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-settings.png
new file mode 100644
index 0000000000..df0f443912
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/configure-parameter-provider-settings.png
differ
diff --git
a/nifi-docs/src/main/asciidoc/images/configure-registry-client-properties.png
b/nifi-docs/src/main/asciidoc/images/configure-registry-client-properties.png
new file mode 100644
index 0000000000..35c3a6c104
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/configure-registry-client-properties.png
differ
diff --git
a/nifi-docs/src/main/asciidoc/images/configure-registry-client-settings.png
b/nifi-docs/src/main/asciidoc/images/configure-registry-client-settings.png
new file mode 100644
index 0000000000..7737e4a4af
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/configure-registry-client-settings.png
differ
diff --git a/nifi-docs/src/main/asciidoc/images/controller-services-tab.png
b/nifi-docs/src/main/asciidoc/images/controller-services-tab.png
index 64bf59f5df..851c3c91d1 100644
Binary files a/nifi-docs/src/main/asciidoc/images/controller-services-tab.png
and b/nifi-docs/src/main/asciidoc/images/controller-services-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/iconFetch.png
b/nifi-docs/src/main/asciidoc/images/iconFetch.png
new file mode 100644
index 0000000000..b166e16194
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/iconFetch.png
differ
diff --git a/nifi-docs/src/main/asciidoc/images/nifi-processor-menu.png
b/nifi-docs/src/main/asciidoc/images/nifi-processor-menu.png
index 2e54fcd4a3..01996d35f9 100644
Binary files a/nifi-docs/src/main/asciidoc/images/nifi-processor-menu.png and
b/nifi-docs/src/main/asciidoc/images/nifi-processor-menu.png differ
diff --git
a/nifi-docs/src/main/asciidoc/images/parameter-provider-edit-buttons.png
b/nifi-docs/src/main/asciidoc/images/parameter-provider-edit-buttons.png
new file mode 100644
index 0000000000..2ef01c72e3
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/parameter-provider-edit-buttons.png differ
diff --git
a/nifi-docs/src/main/asciidoc/images/parameter-provider-tasks-info-buttons.png
b/nifi-docs/src/main/asciidoc/images/parameter-provider-tasks-info-buttons.png
new file mode 100644
index 0000000000..93f561cfba
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/parameter-provider-tasks-info-buttons.png
differ
diff --git a/nifi-docs/src/main/asciidoc/images/parameter-providers-tab.png
b/nifi-docs/src/main/asciidoc/images/parameter-providers-tab.png
new file mode 100644
index 0000000000..0c233ba4a3
Binary files /dev/null and
b/nifi-docs/src/main/asciidoc/images/parameter-providers-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/registry-client-added.png
b/nifi-docs/src/main/asciidoc/images/registry-client-added.png
index 15300ac6e6..39c9e191f8 100644
Binary files a/nifi-docs/src/main/asciidoc/images/registry-client-added.png and
b/nifi-docs/src/main/asciidoc/images/registry-client-added.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/registry-clients-tab.png
b/nifi-docs/src/main/asciidoc/images/registry-clients-tab.png
index c81b45dcf5..72d314af10 100644
Binary files a/nifi-docs/src/main/asciidoc/images/registry-clients-tab.png and
b/nifi-docs/src/main/asciidoc/images/registry-clients-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/reporting-tasks-tab.png
b/nifi-docs/src/main/asciidoc/images/reporting-tasks-tab.png
index 5c295327a4..7517aafd04 100644
Binary files a/nifi-docs/src/main/asciidoc/images/reporting-tasks-tab.png and
b/nifi-docs/src/main/asciidoc/images/reporting-tasks-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/settings-general-tab.png
b/nifi-docs/src/main/asciidoc/images/settings-general-tab.png
index 6e0a720c52..a5ef06ded6 100644
Binary files a/nifi-docs/src/main/asciidoc/images/settings-general-tab.png and
b/nifi-docs/src/main/asciidoc/images/settings-general-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/user-guide.adoc
b/nifi-docs/src/main/asciidoc/user-guide.adoc
index 33a0a975f1..959522ed8b 100644
--- a/nifi-docs/src/main/asciidoc/user-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/user-guide.adoc
@@ -191,7 +191,7 @@ The available global access policies are:
|======================
|Policy |Privilege
|view the UI |Allows users to view the UI
-|access the controller |Allows users to view and modify the controller
including reporting tasks, Controller Services, and nodes in the cluster
+|access the controller |Allows users to view and modify the controller
including Management Controller Services, Reporting Tasks, Registry Clients,
Parameter Providers and nodes in the cluster
|query provenance |Allows users to submit a provenance search and request
even lineage
|access restricted components |Allows users to create/modify restricted
components assuming other permissions are sufficient. The restricted
components may indicate which specific permissions are required. Permissions
can be granted for specific restrictions or be granted regardless
@@ -885,7 +885,7 @@ The values of properties in the flow, including sensitive
properties, can be par
- A sensitive property can only reference a Sensitive Parameter
- A non-sensitive property can only reference a Non-Sensitive Parameter
- Properties that reference Controller Services can not use Parameters
- - Parameters cannot be referenced in Reporting Tasks or in controller-level
Controller Services
+ - Parameters cannot be referenced in Reporting Tasks or in Management
Controller Services
The UI indicates whether a Parameter can be used for a property value.
@@ -1063,6 +1063,45 @@ Sensitive properties may only reference sensitive
Parameters. This is important
The value of a sensitive property must be set to a single Parameter reference.
For example, values of `+#{password}123+` and `+#{password}#{suffix}+` are not
allowed. Sending `+#{password}123+` would lead to exposing part of the
sensitive property's value. This is in contrast to a non-sensitive property,
where a value such as `+#{path}/child/file.txt+` is valid.
+
+==== Parameter Providers
+
+Parameter Providers allow parameters to be stored in sources external to NiFi
(e.g. HashiCorp Vault). The parameters of a Parameter Provider can be fetched
and applied to all referencing Parameter Contexts.
+
+To add a Parameter Provider, select Controller Settings from the Global Menu.
+
+image:controller-settings-selection.png["Global Menu - Controller Settings"]
+
+This displays the NiFi Settings window. Select the Parameter Providers tab and
click the `+` button in the upper-right corner to create a new Parameter
Provider.
+
+image:parameter-providers-tab.png["Parameter Providers Tab"]
+
+The Add Parameter Provider window opens. This window is similar to the Add
Processor window. It provides a list of the available Parameter Providers on
the right and a tag cloud, showing the most common category tags used for
Parameter Providers, on the left. The DFM may click any tag in the tag cloud in
order to narrow down the list of Parameter Providers to those that fit the
categories desired. The DFM may also use the Filter field at the top-right of
the window to search for the desi [...]
+
+image:add-parameter-provider-window.png["Add Parameter Provider Window"]
+
+Once a Parameter Provider has been added, the DFM may configure it by clicking
the "Edit" button in the far-right column. Other buttons in this column include
"Fetch Parameters", "Remove" and "Access Policies".
+
+image:parameter-provider-edit-buttons.png["Parameter Providers Edit Buttons"]
+
+You can obtain information about Parameter Providers by clicking the "View
Details", "Usage", and "Alerts" buttons in the left-hand column.
+
+image:parameter-provider-tasks-info-buttons.png["Parameter Providers
Information Buttons"]
+
+When the DFM clicks the "Edit" button, a Configure Parameter Provider 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 Parameter Provider a unique name (if desired). It also
lists the UUID, Type, and Bundle information for the provider and displays a
list of other components (e.g. parameter contexts) that reference the parameter
provider. The DFM may hov [...]
+
+image:configure-parameter-provider-settings.png["Configure Parameter Provider
Settings"]
+
+The Properties tab lists the various properties that may be configured for the
parameter provider. The DFM may hover the mouse over the question mark icons to
see more information about each property.
+
+image:configure-parameter-provider-properties.png["Configure Parameter
Provider Properties"]
+
+The Comments tab is just an open-text field, where the DFM may include
comments about the provider. After configuring the Parameter Provider, click
"Apply" to save the configuration and close the window, or click "Cancel" to
discard the changes and close the window.
+
+When you want to fetch parameters from the Parameter Provider, click the
"Fetch" button (image:iconFetch.png["Fetch Button"]).
+
+
+
[[accessing-parameters]]
==== Accessing Parameters
User privileges to Parameters are managed via access policies on the following
levels:
@@ -1240,18 +1279,18 @@ IMPORTANT: Controller Services defined on the
controller level are limited to re
NOTE: If your NiFi instance is secured, your ability to view and add
Controller Services is dependent on the 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. Access privileges can be assigned on a global or
Controller Service-specific basis (see <<UI-with-multi-tenant-authorization>>
for more information).
-[[Controller_Services_for_Reporting_Tasks]]
-==== Adding Controller Services for Reporting Tasks
+[[Management_Controller_Services]]
+==== Adding Management Controller Services
-To add a Controller Service for a reporting task, select Controller Settings
from the Global Menu.
+To add a Management Controller Service, select Controller Settings from the
Global Menu.
image:controller-settings-selection.png["Global Menu - Controller Settings"]
-This displays the NiFi Settings window. The window has four tabs: General,
Reporting Task Controller Services, Reporting Tasks and Registry Clients. The
General tab provides settings for the overall maximum thread counts of the
instance.
+This displays the NiFi Settings window. The window has five tabs: General,
Management Controller Services, Reporting Tasks, Registry Clients and Parameter
Providers. The General tab 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 Reporting Task Controller Services tab.
From this tab, the DFM may click the `+` button in the upper-right corner to
create a new Controller Service.
+To the right of the General tab is the Management 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"]
@@ -2333,18 +2372,28 @@ To connect NiFi to a Registry, select Controller
Settings from the Global Menu.
image::controller-settings-selection.png["Global Menu - Controller Settings"]
-This displays the NiFi Settings window. Select the Registry Clients tab and
click the `+` button in the upper-right corner to register a new Registry
client.
+This displays the NiFi Settings window. Select the Registry Clients tab and
click the `+` button in the upper-right corner to register a new Registry
Client.
image::registry-clients-tab.png["Registry Clients Tab"]
-In the Add Registry Client window, provide a name and URL.
+In the Add Registry Client window, provide a name, select type and add a
description (if desired).
image::add-registry-client.png["Add Registry Client Dialog"]
-Click "Add" to complete the registration.
+Click "Add".
image::registry-client-added.png["Registry Client Added"]
+Once a Registry Client has been added, the DFM may configure it by clicking
the "Edit" button (image:iconEdit.png["Edit Button"]) in the far-right column.
When the DFM clicks the "Edit" button, an Edit Registry Client window opens. It
has two tabs: Settings and Properties. The Settings tab provides a place for
the DFM to edit the Registry Client name. It also lists the UUID, Type, and
provides an open-text field to edit or add a Description.
+
+image::configure-registry-client-settings.png["Registry Client Settings"]
+
+The Properties tab lists the various properties that may be configured for the
client. The DFM may hover the mouse over the question mark icons to see more
information about each property.
+
+image:configure-registry-client-properties.png["Configure Registry Client
Properties"]
+
+After configuring a Registry Client, click "Update" to save the configuration
and close the window, or click "Cancel" to discard the changes and close the
window.
+
NOTE: Versioned flows are stored and organized in registry buckets. Bucket
Policies and Special Privileges configured by the registry administrator
determine which buckets a user can import versioned flows from and which
buckets a user can save versioned flows to. Information on Bucket Policies and
Special Privileges can be found in the NiFi Registry User Guide
(link:https://nifi.apache.org/docs/nifi-registry-docs/html/user-guide.html[https://nifi.apache.org/docs/nifi-registry-docs/html/
[...]
[[version_states]]
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/getting-started.adoc
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/getting-started.adoc
index 6eb3ab3915..06778d5649 100644
---
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/getting-started.adoc
+++
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/getting-started.adoc
@@ -89,10 +89,21 @@ Start a NiFi instance if one isn't already running and
bring up the UI. Go to
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`^]:
+Select the Registry Clients tab and add a new Registry Client giving it a name
and selecting a type:
-image::local_registry.png["Local Registry Client"]
+image::add-registry-client.png["Add Registry Client Dialog"]
+
+Click "Add".
+
+image::registry-client-added.png["Registry Client Added"]
+
+Once a Registry Client has been added, configure it by clicking the "Edit"
button (image:iconEdit.png["Edit Button"]) in the far-right column. In the Edit
Registry Client window, select the Properties tab and enter a URL of
link:http://localhost:18080[`http://localhost:18080`^]:
+image::configure-registry-client-properties.png["Configure Registry Client
Properties"]
+
+Click "Update" to save the configuration and close the window:
+
+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*.
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/add-registry-client.png
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/add-registry-client.png
new file mode 100644
index 0000000000..67eb8c8620
Binary files /dev/null and
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/add-registry-client.png
differ
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/configure-registry-client-properties.png
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/configure-registry-client-properties.png
new file mode 100644
index 0000000000..0091e76a4f
Binary files /dev/null and
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/configure-registry-client-properties.png
differ
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/iconEdit.png
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/iconEdit.png
new file mode 100644
index 0000000000..e95712f01f
Binary files /dev/null and
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/iconEdit.png
differ
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/local_registry.png
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/local_registry.png
index 047dd71026..ebbb5a47d8 100644
Binary files
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/local_registry.png
and
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/local_registry.png
differ
diff --git
a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/registry-client-added.png
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/registry-client-added.png
new file mode 100644
index 0000000000..39c9e191f8
Binary files /dev/null and
b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/registry-client-added.png
differ
