[GitHub] nifi pull request #3124: NIFI-5767 Added NiFi Toolkit Guide to docs

[pvillard31]

Github user pvillard31 commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/3124#discussion_r230322139
  
    --- Diff: nifi-docs/src/main/asciidoc/toolkit-guide.adoc ---
    @@ -0,0 +1,1257 @@
    +//
    +// Licensed to the Apache Software Foundation (ASF) under one or more
    +// contributor license agreements.  See the NOTICE file distributed with
    +// this work for additional information regarding copyright ownership.
    +// The ASF licenses this file to You under the Apache License, Version 2.0
    +// (the "License"); you may not use this file except in compliance with
    +// the License.  You may obtain a copy of the License at
    +//
    +//     http://www.apache.org/licenses/LICENSE-2.0
    +//
    +// Unless required by applicable law or agreed to in writing, software
    +// distributed under the License is distributed on an "AS IS" BASIS,
    +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    +// See the License for the specific language governing permissions and
    +// limitations under the License.
    +//
    += Apache NiFi Toolkit Guide
    +Apache NiFi Team <d...@nifi.apache.org>
    +:homepage: http://nifi.apache.org
    +:linkattrs:
    +
    +== Overview
    +The NiFi Toolkit contains several command line utilities to setup and 
support NiFi in standalone and clustered environments.  The utilities include:
    +
    +* CLI -- The `cli` tool enables administrators to interact with NiFi and 
NiFi Registry instances to automate tasks such as deploying versioned flows and 
managing process groups and cluster nodes.
    +* Encrypt Config -- The `encrypt-config` tool encrypts the sensitive keys 
in the _nifi.properties_ file to facilitate the setup of a secure NiFi instance.
    +* File Manager -- The `file-manager` tool enables administrators to 
backup, install or restore a NiFi installation from backup.
    +* Flow Analyzer -- The `flow-analyzer` tool produces a report that helps 
administrators understand the max amount of data which can be stored in 
backpressure for a given flow.
    +* Node Manager -- The `node-manager` tool enables administrators to 
perform status checks on nodes as well as the ability to connect, disconnect, 
or remove nodes from the cluster.
    +* Notify -- The `notify` tool enables administrators to send bulletins to 
the NiFi UI.
    +* S2S -- The `s2s` tool enables administrators to send data into or out of 
NiFi flows over site-to-site.
    +* TLS Toolkit -- The `tls-toolkit` utility generates the required 
keystores, truststore, and relevant configuration files to facilitate the setup 
of a secure NiFi instance.
    +* ZooKeeper Migrator -- The `zk-migrator` tool enables administrators to:
    +** move ZooKeeper information from one ZooKeeper cluster to another
    +** migrate ZooKeeper node ownership
    +
    +The utilities are executed with scripts found in the `bin` folder of your 
NiFi Toolkit installation.
    +
    +NOTE: The NiFi Toolkit is downloaded separately from NiFi (see the 
link:https://nifi.apache.org/download.html[Apache NiFi downloads page^]).
    +
    +=== Prerequisites for Running in a Secure Environment
    +For secured nodes and clusters, two policies should be configured in 
advance:
    +
    +* Access the controller – A user that will have access to these 
utilities should be authorized in NiFi by creating an “access the 
controller” policy (`/controller`) with both view and modify rights
    +* Proxy user request – If not previously set, node’s identity (the DN 
value of the node’s certificate) should be authorized to proxy requests on 
behalf of a user
    +
    +When executing either the Notify or Node Manager tools in a secured 
environment the `proxyDN` flag option should be used in order to properly 
identify the user that was authorized to execute these commands. In non-secure 
environments, or if running the status operation on the Node Manager tool, the 
flag is ignored.
    +
    +== NiFi CLI
    +This tool offers a CLI focused on interacting with NiFi and NiFi Registry 
in order to automate tasks, such as deploying flows from a NIFi Registy to a 
NiFi instance or managing process groups and cluster nodes.
    +
    +=== Usage
    +The CLI toolkit can be executed in standalone mode to execute a single 
command, or interactive mode to enter an interactive shell.
    +
    +To execute a single command:
    +
    + ./bin/cli.sh <command> <args>
    +
    +To launch the interactive shell:
    +
    + ./bin/cli.sh
    +
    +To show help:
    +
    + cli.sh -h
    --- End diff --
    
    ```suggestion
     ./bin/cli.sh -h
    ```


---