[NIFI-2966] Add policy resource descriptors to Admin Guide listing of policies

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.0.0
• Fix Version/s: 1.7.0
• Component/s: Documentation & Website
• Labels: authorization beginner documentation policy
• Assignee: Andrew M. Lim
• Reporter: Andy LoPresto
• Created: 29/Oct/16 04:02
• Updated: 17/May/18 15:38
• Resolved: 17/May/18 15:38

Description

While ideally a user/admin would never have to examine the $NIFI_HOME/conf/users.xml or $NIFI_HOME/conf/authorizations.xml files, in my development and debugging, I have had to on more than one occasion. It would be helpful to list the actual policy resource descriptor (e.g. /provenance, /flow, /tenants) in the table in the Admin Guide listing these policies. When the provenance policy was missing for both of my defined users, I could not add it through the UI, so I had to manually edit the authorizations.xml file, but I did not know the resource descriptor a priori, so I had to search the code base for it.

I envision simply adding an additional column to the table and adding the descriptor, including a placeholder if necessary (e.g. /data/process-groups/root-process-group-id).

Issue Links

• links to: GitHub Pull Request #2710