[
https://issues.apache.org/jira/browse/NIFI-3701?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15968179#comment-15968179
]
Mark Bean commented on NIFI-3701:
---------------------------------
Here is a first pass at items that need attention in the documentation. Some
are extremely minor, others more significant. Most comments apply to the Admin
Guide, and a couple to the User Guide.
ADMIN GUIDE
Update table showing mapping of legacy roles to policies to more closely align
with policy nomenclature in the UI:
Policy "view the dataflow" and "modify the dataflow" should read "access the
controller/view" and "access the controller/modify", or "view the controller"
and "modify the controller". The point being replace "dataflow" with
"controller".
Policy "view policies" should read "view all policies". Same for 'modify'.
Policy "send proxy user requests" should read "proxy user requests"
Are any of the following policies applied during the migration from legacy
roles? If so, they should be added to the table.
view system diagnostics
access counters
authorizations.xml in Cluster
There is a note indicating "In a cluster, all nodes must have the same
authorization.xml...". This is also true of users.xml.
Also, this same note mentions an empty authorizations.xml will inherit from the
cluster. This is true only if neither 'Initial Admin Identity' nor 'Legacy
Authorized Users File' property is set. These will generate non-empty
authorizations.xml and users.xml prior thus preventing inheritance from the
Cluster.
Component Level Access Policies
Table indicates policy "retrieve data via site-to-site"; should be "receive
data via site-to-site"
Templates
Mention the new use of templates. Specifically, the nifi.templates.directory is
for backward compatibility only; templates are now stored in the flow.xml.gz.
Also, mention that the template directory can be used to [bulk] import
templates into the flow.xml.gz automatically on NiFi startup.
List/Empty Queue in Cluster
A user requires 'view the data' policy for List Queue and 'modify the data' for
Delete Queue. This is documented. What is not is that all Nodes of a Cluster
must also be part of those policies.
USER GUIDE
Configure Site-to-Site does not clearly reference modifying the Policy of an
Input Port to allow access. It implies the 0.x method of adding accesses
through the "configure" option of the Input Port. It also mentions Access
Control, and states that the first time a client establishes a connection, the
client will be forbidden and a request for an account for that client will
automatically be generated. And, it mentions the client is required to have
NiFi Role. There are numerous items here which are now obsolete.
Backpressure sections should mention the default limits imposed on every new
connection.
> Documentation improvements for 1.x
> ----------------------------------
>
> Key: NIFI-3701
> URL: https://issues.apache.org/jira/browse/NIFI-3701
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Reporter: Mark Bean
> Priority: Minor
>
> This ticket is intended to track various documentation enhancement requests
> particularly as they apply to 1.x as compared to 0.x. Additional details will
> be added as separate updates.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
