You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2018/11/01 17:32:21 UTC
svn commit: r1845503 [1/2] - in /nifi/site/trunk/minifi:
minifi-java-agent-quick-start.html system-admin-guide.html
Author: aldrin
Date: Thu Nov 1 17:32:21 2018
New Revision: 1845503
URL: http://svn.apache.org/viewvc?rev=1845503&view=rev
Log:
Updating MiNiFi docs
Modified:
nifi/site/trunk/minifi/minifi-java-agent-quick-start.html
nifi/site/trunk/minifi/system-admin-guide.html
Modified: nifi/site/trunk/minifi/minifi-java-agent-quick-start.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/minifi-java-agent-quick-start.html?rev=1845503&r1=1845502&r2=1845503&view=diff
==============================================================================
--- nifi/site/trunk/minifi/minifi-java-agent-quick-start.html (original)
+++ nifi/site/trunk/minifi/minifi-java-agent-quick-start.html Thu Nov 1 17:32:21 2018
@@ -142,10 +142,11 @@
<p><strong>Note:</strong> You can also specify a custom name for your MiNiFi installation, by specifying that name during your install command. For example, to install MiNiFi as a service and named dataflow, enter:</p>
<pre><code>bin/minifi.sh install dataflow
</code></pre>
-<p>Once you have downloaded and installed MiNiFi, you need to start MiNiF. You can start NiFi in the foreground, background, or as a service.</p>
+<p>Once you have downloaded and installed MiNiFi, you need to start MiNiFi. You can start NiFi in the foreground, background, or as a service.</p>
<p>To launch MiNiFi in the foreground:</p>
<ol>
-<li>From a terminal window, navigate to the MiNiFi installation directory.Enter:</li>
+<li>From a terminal window, navigate to the MiNiFi installation directory.</li>
+<li>Enter:</li>
</ol>
<pre><code>bin/minifi.sh run
</code></pre>
@@ -163,7 +164,7 @@
<pre><code>sudo service minifi start
</code></pre>
<h2>For Windows Users</h2>
-<p>For Windows users, navigate to the folder where MiNiFi was installed. Navigate to the /bin subdirectory and double-click the run-minifi.bat file.</p>
+<p>For Windows users, navigate to the folder where MiNiFi was installed. Navigate to the <code>/bin</code> subdirectory and double-click the <em>run-minifi.bat</em> file.</p>
<p>This launches MiNiFi and leaves it running in the foreground. To shut down NiFi, select the window that was launched and hold the Ctrl key while pressing C.</p>
<h1>Working with dataflows</h1>
<p>When you are working with a MiNiFi dataflow, you should design it, add any additional configuration your environment or use case requires, and then deploy your dataflow. MiNiFi is not designed to accommodate substantial mid-dataflow configuration.</p>
@@ -179,13 +180,13 @@
<pre><code>config.sh transform input_file output_file
</code></pre>
<ol start="6">
-<li>Move your new .yml file to minifi/conf.</li>
-<li>Rename your .yml file config.yml.<br>
-<strong>Note:</strong> You can use one template at a time, per MiNiFi instance.</li>
-</ol>
-<p><strong>Result:</strong> Once you have your config.yml file in the minifi/conf directory, launch that instance of MiNiFi and your dataflow begins automatically.</p>
-<p>##Using Processors Not Packaged with MiNiFi<br>
-MiNiFi is able to use following processors out of the box:</p>
+<li>Move your new .yml file to <code>minifi/conf</code>.</li>
+<li>Rename your .yml file <em>config.yml</em>.</li>
+</ol>
+<p><strong>Note:</strong> You can use one template at a time, per MiNiFi instance.</p>
+<p><strong>Result:</strong> Once you have your <em>config.yml</em> file in the <code>minifi/conf</code> directory, launch that instance of MiNiFi and your dataflow begins automatically.</p>
+<h2>Using Processors Not Packaged with MiNiFi</h2>
+<p>MiNiFi is able to use following processors out of the box:</p>
<ul>
<li>UpdateAttribute</li>
<li>AttributesToJSON</li>
@@ -252,10 +253,10 @@ MiNiFi is able to use following processo
<li>ValidateXml</li>
</ul>
<p>MiNiFi is able to use the StandardSSLContextService out of the box.</p>
-<p>If you want to create a dataflow with a processor not shipped with MiNiFi, you can do so.</p>
+<p>If you want to create a dataflow with a processor not shipped with MiNiFi, you can do so by following these steps:</p>
<ol>
<li>Set up your dataflow as described above.</li>
-<li>Copy the desired NAR file into the MiNiFi lib directory.</li>
+<li>Copy the desired NAR file into the MiNiFi <code>lib</code> directory.</li>
<li>Restart your MiNiFi instance.</li>
</ol>
<p><strong>Note:</strong> The following processors are also a part of the default distribution but require adding a NAR for a Controller Service not packaged by default. The processors are grouped by the NAR that is required.</p>
@@ -283,11 +284,11 @@ MiNiFi is able to use following processo
</ul>
<h1>Securing your Dataflow</h1>
<p>You can secure your MiNiFi dataflow using keystore or trust store SSL protocols, however, this information is not automatically generated. You will need to generate your security configuration information yourself.</p>
-<p>To run a MiNiFi dataflow securely, modify the Security Properties section of your config.yml file.</p>
+<p>To run a MiNiFi dataflow securely:</p>
<ol>
<li>Create your dataflow template as discussed above.</li>
-<li>Move it to minifi.conf and rename config.yml.</li>
-<li>Manually modify the Security Properties section of config.yml. For example:</li>
+<li>Move it to <code>minifi/conf</code> and rename <em>config.yml</em>.</li>
+<li>Manually modify the Security Properties section of <em>config.yml</em>. For example:</li>
</ol>
<pre><code>Security Properties:
keystore:
@@ -306,62 +307,64 @@ provider: BC
<h1>Managing MiNiFi</h1>
<p>You can also perform some management tasks using MiNiFi.</p>
<h2>Monitoring Status</h2>
-<p>You can use the minifi.sh flowStatus option to monitor a range of aspects of your MiNiFi operational and dataflow status. You can use the flowStatus option to get information dataflow component health and functionality, a MiNiFi instance, or system diagnostics.</p>
+<p>You can use the <code>minifi.sh flowStatus</code> option to monitor a range of aspects of your MiNiFi operational and dataflow status. You can use the <code>flowStatus</code> option to get information about dataflow component health and functionality, a MiNiFi instance, or system diagnostics.</p>
<p>FlowStatus accepts the following flags and options:</p>
<ul>
-<li>processors
+<li><code>processor</code>
<ul>
-<li>health</li>
-<li>bulletins</li>
-<li>status</li>
+<li><code>health</code></li>
+<li><code>bulletins</code></li>
+<li><code>status</code></li>
</ul></li>
-<li>connections
+<li><code>connection</code>
<ul>
-<li>health</li>
-<li>stats</li>
+<li><code>health</code></li>
+<li><code>stats</code></li>
</ul></li>
-<li>remoteProcessGroups
+<li><code>remoteProcessGroup</code>
<ul>
-<li>health</li>
-<li>bulletins</li>
-<li>status</li>
-<li>authorizationIssues</li>
-<li>inputPorts</li>
+<li><code>health</code></li>
+<li><code>bulletins</code></li>
+<li><code>status</code></li>
+<li><code>authorizationIssues</code></li>
+<li><code>inputPorts</code></li>
</ul></li>
-<li>controllerServices
+<li><code>controllerServices</code>
<ul>
-<li>health</li>
-<li>bulletins</li>
+<li><code>health</code></li>
+<li><code>bulletins</code></li>
</ul></li>
-<li>provenancereporting
+<li><code>provenancereporting</code>
<ul>
-<li>health</li>
-<li>bulletins</li>
+<li><code>health</code></li>
+<li><code>bulletins</code></li>
</ul></li>
-<li>instance
+<li><code>instance</code>
<ul>
-<li>health</li>
-<li>bulletins</li>
-<li>status</li>
+<li><code>health</code></li>
+<li><code>bulletins</code></li>
+<li><code>status</code></li>
</ul></li>
-<li>systemdiagnostics
+<li><code>systemdiagnostics</code>
<ul>
-<li>heap</li>
-<li>processorstats</li>
-<li>contentrepositoryusage</li>
-<li>flowfilerepositoryusage</li>
-<li>garbagecollection</li>
+<li><code>heap</code></li>
+<li><code>processorstats</code></li>
+<li><code>contentrepositoryusage</code></li>
+<li><code>flowfilerepositoryusage</code></li>
+<li><code>garbagecollection</code></li>
</ul></li>
</ul>
-<p>For example, this query gets the health, stats, and bulletins for the TailFile processors:</p>
+<p>For example, this query gets the health, stats, and bulletins for the TailFile processor:</p>
+<pre><code>minifi.sh flowStatus processor:TailFile:health,stats,bulletins
+</code></pre>
<p><strong>Note:</strong> Currently, the script only accepts one high level option at a time.</p>
<p><strong>Note:</strong> Any connections, remote process groups or processors names that contain ":", ";" or "," will cause parsing errors when querying.</p>
-<p>For details on the flowStatus option, see the <em>FlowStatus Query Option</em> section of the <a href="http://nifi.apache.org/minifi/system-admin-guide.html">Administration Guide</a>.</p>
+<p>For details on the <code>flowStatus</code> option, see the "FlowStatus Query Option" section of the <a href="http://nifi.apache.org/minifi/system-admin-guide.html">Administration Guide</a>.</p>
<h2>Loading a New Dataflow</h2>
<p>You can load a new dataflow for a MiNiFi instance to run:</p>
<ol>
-<li>Create a new config.yml file with the new dataflow.</li>
-<li>Replace the existing config.yml in minifi/conf with the new file.</li>
+<li>Create a new <em>config.yml</em> file with the new dataflow.</li>
+<li>Replace the existing <em>config.yml</em> in <code>minifi/conf</code> with the new file.</li>
<li>Restart MiNiFi.</li>
</ol>
<h2>Stopping MiNiFi</h2>