Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-7319

Provide prescriptive documentation for common tasks

    XMLWordPrintableJSON

    Details

      Description

      There are a number of common tasks which community members frequently have trouble understanding and performing. Assisting users with these tasks requires a high level of knowledge, dedicated time and effort, and is often 1:1 rather than scalable.

      Existing NiFi documentation is descriptive (i.e. a compendium of reference material) but rarely prescriptive (i.e. step-by-step guides to performing these tasks). I propose adding another document which collects these walkthrough instructions for representative tasks.

      Each section should include:

      • A brief description of the scenario
      • A brief description of why a user would undertake this action
      • A baseline starting point to ensure consistency
      • The expected outcome after completing these steps
      • Possible errors encountered or common mistakes called out
      • Detailed sequential actions to take
        • Exact terminal commands or UI/API actions to take
        • An explanation of each step
        • Screenshots when possible
        • Output/expected result for each step

      Example topics:

      1. Configuring TLS for a standalone NiFi instance
      2. Configuring TLS for a NiFi cluster
      3. Configuring LDAP authentication & authorization for NiFi
      4. Configuring Kerberos authentication & authorization for NiFi
      5. Building a flow which uses the Wait/Notify processors
      6. Building a flow which uses the *Record processors
      7. Converting a legacy flow which used individual flowfile processing to use the *Record processors
      8. Deploying NiFi on Kubernetes via Docker containers
      9. Configuring TLS for NiFi Registry (and integrating with TLS NiFi)
      10. Configuring LDAP authentication & authorization for NiFi Registry

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                alopresto Andy LoPresto
                Reporter:
                alopresto Andy LoPresto
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 9.5h
                  9.5h