Modified: nifi/site/trunk/minifi/getting-started.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/getting-started.html?rev=1828794&r1=1828793&r2=1828794&view=diff ============================================================================== --- nifi/site/trunk/minifi/getting-started.html (original) +++ nifi/site/trunk/minifi/getting-started.html Tue Apr 10 07:50:11 2018 @@ -20,113 +20,112 @@ </head> <body> <div class="sticky contain-to-grid"> - <nav class="top-bar" data-topbar role="navigation"> - <ul class="title-area"> - <li class="name"> - <h1> - <a href="index.html"> - <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> - </a> - </h1> - </li> - <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> - <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> - </ul> - - <section class="top-bar-section"> - <!-- Right Nav Section --> - <ul class="right"> - <li class="has-dropdown"> - <a href="#">Project</a> - <ul class="dropdown"> - <li><a href="index.html">Home</a></li> - <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> - <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Documentation</a> - <ul class="dropdown"> - <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> - <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> - <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> - <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> - <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Downloads</a> - <ul class="dropdown"> - <li><a href="download.html">Download MiNiFi Components</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Community</a> - <ul class="dropdown"> - <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> - <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> - <li><a href="../people.html">People</a></li> + <nav class="top-bar" data-topbar role="navigation"> + <ul class="title-area"> + <li class="name"> + <h1> + <a href="index.html"> + <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> + </a> + </h1> + </li> + <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> + <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> + </ul> + + <section class="top-bar-section"> + <!-- Right Nav Section --> + <ul class="right"> + <li class="has-dropdown"> + <a href="#">Project</a> + <ul class="dropdown"> + <li><a href="index.html">Home</a></li> + <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Documentation</a> + <ul class="dropdown"> + <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> + <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> + <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> + <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> + <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Downloads</a> + <ul class="dropdown"> + <li><a href="download.html">Download MiNiFi Components</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Community</a> + <ul class="dropdown"> + <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> + <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> + <li><a href="../people.html">People</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Development</a> + <ul class="dropdown"> + <li><a href="../release-guide.html">Release Guide</a></li> + <li><a href="../licensing-guide.html">Licensing Guide</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">ASF Links</a> + <ul class="dropdown"> + <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> + <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> + </ul> + </li> + <li> + <a href="../index.html">Apache NiFi</a> + </li> </ul> - </li> - <li class="has-dropdown"> - <a href="#">Development</a> - <ul class="dropdown"> - <li><a href="../release-guide.html">Release Guide</a></li> - <li><a href="../licensing-guide.html">Licensing Guide</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">ASF Links</a> - <ul class="dropdown"> - <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> - <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> - </ul> - </li> - <li> - <a href="../index.html">Apache NiFi</a> - </li> - </ul> - </section> - </nav> -</div> - - + </section> + </nav> + </div> <div class="row"> <div class="large-12 columns"> <div class="large-space"></div> - <h1 id="getting-started-with-minifi">Getting started with MiNiFi</h1> +<h1>Getting started with MiNiFi</h1> <p>This page explains how to configure and deploy MiNiFi agents.</p> -<p>The Java agent is able to run most of <a href="http://nifi.apache.org/docs.html";>NiFi's available processors</a>, but is a larger binary distribution (49MB) and consumes greater system resources (24MB max JVM heapsize by default). If you need maximum flexibility to make routing and processing decisions at your data's point of origin, the Java agent is a good fit.</p> +<p>The Java agent is able to run most of <a href="http://nifi.apache.org/docs.html";>NiFi's available processors</a>, but is a larger binary distribution (49MB) and consumes greater system resources (24MB max JVM heapsize by default). If you need maximum flexibility to make routing and processing decisions at your data's point of origin, the Java agent is a good fit.</p> <p>The C++ agent is a smaller binary (3.2MB), consumes low system memory (about 5MB at idle) but has <a href="https://github.com/apache/nifi-minifi-cpp#caveats";>a limited subset of processors</a>. If your primary concern is gathering and pushing data to downstream consumers and minimizing system impact, the C++ agent is a good fit.</p> <ol> -<li><p>Install the appropriate OS level dependencies:</p> -<h4 id="minifi-java-">MiNiFi Java:</h4> +<li>Install the appropriate OS level dependencies:</li> +</ol> +<h4>MiNiFi Java:</h4> <ul> <li>Java 1.8+</li> </ul> -<h4 id="minifi-c-">MiNiFi C++:</h4> -<h6 id="rhel-centos-">RHEL/CentOS:</h6> +<h4>MiNiFi C++:</h4> +<h6>RHEL/CentOS:</h6> <ul> <li>yum install -y epel-release</li> <li>yum install -y leveldb</li> </ul> -<h6 id="debian-ubuntu-">Debian/Ubuntu:</h6> +<h6>Debian/Ubuntu:</h6> <ul> <li>apt install -y libleveldb-dev</li> <li>apt install -y libxml2</li> </ul> -</li> +<ol start="2"> <li>Download the relevant compressed binary from the <a href="download.html">Downloads</a> page</li> <li>Copy and decompress the binary to your target deployment environment</li> <li>Set the MINIFI_HOME environment variable to your decompressed binary directory</li> @@ -135,33 +134,34 @@ <p><em>flowStatus</em> and <em>dump</em> are available only for MiNiFi Java.</p> <p>For MiNiFi Java, the agent logs to $MINIFI_HOME/logs/minifi-app.log.</p> <p>For MiNiFi C++, the agent logs to $MINIFI_HOME/minifi-app.log.txt</p> -<h1 id="configuring-minifi-agent-flows">Configuring MiNiFi Agent Flows</h1> +<h1>Configuring MiNiFi Agent Flows</h1> <p>Agents execute the flow defined in $MINIFI_HOME/conf/config.yml. The shipped config.yml file has an "empty" flow.</p> -<p>While it's possible to create and modify config.yml programmatically or by hand, the more common scenario is to:</p> +<p>While it's possible to create and modify config.yml programmatically or by hand, the more common scenario is to:</p> <ol> -<li>Use NiFi's web interface to define a flow</li> +<li>Use NiFi's web interface to define a flow</li> <li>Save the flow as a template and download its XML file</li> <li>Use the <a href="minifi-toolkit.html">Converter Toolkit</a> to convert the template XML to an equivalent config.yml</li> <li>Put the config.yml file in $MINIFI_HOME/conf and start the agent.</li> </ol> -<h1 id="pushing-data-from-minifi-to-nifi">Pushing Data From MiNiFi to NiFi</h1> +<h1>Pushing Data From MiNiFi to NiFi</h1> <p>What follows is an illustrated walkthrough of configuring MiNiFi and NiFi to generate and collect log data.</p> -<p>If you're new to NiFi, watch the <a href="http://nifi.apache.org/videos.html";>NiFi introductory video series</a> before proceeding. If you don't already have NiFi, you can download it from <a href="http://nifi.apache.org/download.html";>here</a>.</p> -<h2 id="configuring-nifi-to-receive-data">Configuring NiFi to Receive Data</h2> +<p>If you're new to NiFi, watch the <a href="http://nifi.apache.org/videos.html";>NiFi introductory video series</a> before proceeding. If you don't already have NiFi, you can download it from <a href="http://nifi.apache.org/download.html";>here</a>.</p> +<h2>Configuring NiFi to Receive Data</h2> <p>First, check that $NIFI_HOME/conf/nifi.properties has a Site to Site input socket port specified:</p> <pre><code># Site to Site properties nifi.remote.input.host= nifi.remote.input.secure=false nifi.remote.input.socket.port=1026 nifi.remote.input.http.enabled=true -nifi.remote.input.http.transaction.ttl=30 sec</code></pre> +nifi.remote.input.http.transaction.ttl=30 sec +</code></pre> <p>Restart NiFi so changes take effect.</p> -<p>On NiFi's web UI, place an Input Port "From MiNiFi" and connect it to a downstream processor: +<p>On NiFi's web UI, place an Input Port "From MiNiFi" and connect it to a downstream processor:<br> <img src="../assets/images/minifi/nifi-receive.png" alt=""></p> -<h2 id="creating-the-minifi-flow">Creating the MiNiFi Flow</h2> +<h2>Creating the MiNiFi Flow</h2> <p>Create a new process group, and double click on it to enter it. Working inside this new processor group will let us create a clean template that includes flow components meant to run in MiNiFi.</p> <p>Inside the process group, create a Remote Process Group (RPG) and give it the URL of your NiFi instance. The RPG will connect to NiFi and discover the input port created earlier.</p> -<p>Create a TailFile processor and connect it to the RPG, selecting the "From MiNiFi" input port. +<p>Create a TailFile processor and connect it to the RPG, selecting the "From MiNiFi" input port.<br> <img src="../assets/images/minifi/minifi-flow.png" alt=""></p> <p>Now create a template, download it as an XML file, and download the <a href="download.html">Converter ToolKit</a>.</p> <p>From the toolkit directory:</p> @@ -171,50 +171,53 @@ Java home: /usr/lib/jvm/jre-1.8.0-openjd MiNiFi Toolkit home: /minifi-toolkit-0.0.1 -No validation errors found in template.</code></pre> +No validation errors found in template. +</code></pre> <p>Open the config.yml file and add Port and Host to a Properties section at the end of the Input Ports section (at the end of the file):</p> <pre><code>Remote Processing Groups: - name: http://localhost:8080/nifi url: http://localhost:8080/nifi - comment: '' + comment: '' timeout: 30 sec yield period: 10 sec Input Ports: - id: AUTOGENERATED_NIFI_PORT_ID_HERE name: MiNiFi-input - comment: '' + comment: '' max concurrent tasks: 1 use compression: false - Properties: # Deviates from spec and will later be removed when this is autonegotiated - Port: 1026 - Host Name: localhost</code></pre> + Properties: # Deviates from spec and will later be removed when this is autonegotiated + Port: 1026 + Host Name: localhost +</code></pre> <p>Copy the generated config.yml file into $MINIFI/conf/config.yml, and start MiNiFi:</p> <pre><code>[user@host nifi-minifi-cpp-0.1.0]# ./bin/minifi.sh start -Starting MiNiFi with PID 463 and pid file /nifi-minifi-cpp-0.1.0/bin/.minifi.pid</code></pre> -<p>After a few seconds, you should see NiFi receiving data on the input port: +Starting MiNiFi with PID 463 and pid file /nifi-minifi-cpp-0.1.0/bin/.minifi.pid +</code></pre> +<p>After a few seconds, you should see NiFi receiving data on the input port:<br> <img src="../assets/images/minifi/nifi-received.png" alt=""></p> <p>If you do not see data in the queue, it may have already been consumed by the downstream processor (PutFile in this case). If no data is arriving on the input port at all, check the MiNiFi log files, and confirm that the file being tailed exists and is not empty.</p> - </div> </div> <div class="row"> - <div class="large-12 columns footer"> - <a href="https://www.apache.org";> - <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200"> - </a> - <div id="copyright"> - <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a - href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the - Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software - Foundation.</p> + <div class="large-12 columns footer"> + <a href="https://www.apache.org";> + <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200" style="margin:0px 10px" /> + </a> + <a href="http://www.apache.org/events/current-event.html";> + <img src="http://www.apache.org/events/current-event-234x60.png"; style="margin:0px 10px" /> + </a> + <div id="copyright"> + <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a + href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the + Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software + Foundation.</p> + </div> + </div> </div> - </div> -</div> - <script src="../assets/js/jquery.min.js"></script> <script src="../assets/js/foundation.js"></script> <script src="../assets/js/app.js"></script> </body> </html> -
Modified: nifi/site/trunk/minifi/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/index.html?rev=1828794&r1=1828793&r2=1828794&view=diff ============================================================================== --- nifi/site/trunk/minifi/index.html (original) +++ nifi/site/trunk/minifi/index.html Tue Apr 10 07:50:11 2018 @@ -20,87 +20,85 @@ </head> <body> <div class="sticky contain-to-grid"> - <nav class="top-bar" data-topbar role="navigation"> - <ul class="title-area"> - <li class="name"> - <h1> - <a href="index.html"> - <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> - </a> - </h1> - </li> - <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> - <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> - </ul> - - <section class="top-bar-section"> - <!-- Right Nav Section --> - <ul class="right"> - <li class="has-dropdown"> - <a href="#">Project</a> - <ul class="dropdown"> - <li><a href="index.html">Home</a></li> - <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> - <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Documentation</a> - <ul class="dropdown"> - <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> - <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> - <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> - <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> - <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Downloads</a> - <ul class="dropdown"> - <li><a href="download.html">Download MiNiFi Components</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Community</a> - <ul class="dropdown"> - <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> - <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> - <li><a href="../people.html">People</a></li> + <nav class="top-bar" data-topbar role="navigation"> + <ul class="title-area"> + <li class="name"> + <h1> + <a href="index.html"> + <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> + </a> + </h1> + </li> + <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> + <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> + </ul> + + <section class="top-bar-section"> + <!-- Right Nav Section --> + <ul class="right"> + <li class="has-dropdown"> + <a href="#">Project</a> + <ul class="dropdown"> + <li><a href="index.html">Home</a></li> + <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Documentation</a> + <ul class="dropdown"> + <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> + <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> + <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> + <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> + <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Downloads</a> + <ul class="dropdown"> + <li><a href="download.html">Download MiNiFi Components</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Community</a> + <ul class="dropdown"> + <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> + <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> + <li><a href="../people.html">People</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Development</a> + <ul class="dropdown"> + <li><a href="../release-guide.html">Release Guide</a></li> + <li><a href="../licensing-guide.html">Licensing Guide</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">ASF Links</a> + <ul class="dropdown"> + <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> + <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> + </ul> + </li> + <li> + <a href="../index.html">Apache NiFi</a> + </li> </ul> - </li> - <li class="has-dropdown"> - <a href="#">Development</a> - <ul class="dropdown"> - <li><a href="../release-guide.html">Release Guide</a></li> - <li><a href="../licensing-guide.html">Licensing Guide</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">ASF Links</a> - <ul class="dropdown"> - <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> - <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> - </ul> - </li> - <li> - <a href="../index.html">Apache NiFi</a> - </li> - </ul> - </section> - </nav> -</div> - - + </section> + </nav> + </div> <div class="large-space"></div> @@ -148,22 +146,23 @@ </div> <div class="row"> - <div class="large-12 columns footer"> - <a href="https://www.apache.org";> - <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200"> - </a> - <div id="copyright"> - <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a - href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the - Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software - Foundation.</p> + <div class="large-12 columns footer"> + <a href="https://www.apache.org";> + <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200" style="margin:0px 10px" /> + </a> + <a href="http://www.apache.org/events/current-event.html";> + <img src="http://www.apache.org/events/current-event-234x60.png"; style="margin:0px 10px" /> + </a> + <div id="copyright"> + <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a + href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the + Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software + Foundation.</p> + </div> + </div> </div> - </div> -</div> - <script src="../assets/js/jquery.min.js"></script> <script src="../assets/js/foundation.js"></script> <script src="../assets/js/app.js"></script> </body> </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=1828794&r1=1828793&r2=1828794&view=diff ============================================================================== --- nifi/site/trunk/minifi/minifi-java-agent-quick-start.html (original) +++ nifi/site/trunk/minifi/minifi-java-agent-quick-start.html Tue Apr 10 07:50:11 2018 @@ -20,92 +20,90 @@ </head> <body> <div class="sticky contain-to-grid"> - <nav class="top-bar" data-topbar role="navigation"> - <ul class="title-area"> - <li class="name"> - <h1> - <a href="index.html"> - <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> - </a> - </h1> - </li> - <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> - <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> - </ul> - - <section class="top-bar-section"> - <!-- Right Nav Section --> - <ul class="right"> - <li class="has-dropdown"> - <a href="#">Project</a> - <ul class="dropdown"> - <li><a href="index.html">Home</a></li> - <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> - <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Documentation</a> - <ul class="dropdown"> - <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> - <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> - <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> - <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> - <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Downloads</a> - <ul class="dropdown"> - <li><a href="download.html">Download MiNiFi Components</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Community</a> - <ul class="dropdown"> - <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> - <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> - <li><a href="../people.html">People</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Development</a> - <ul class="dropdown"> - <li><a href="../release-guide.html">Release Guide</a></li> - <li><a href="../licensing-guide.html">Licensing Guide</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> + <nav class="top-bar" data-topbar role="navigation"> + <ul class="title-area"> + <li class="name"> + <h1> + <a href="index.html"> + <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> + </a> + </h1> + </li> + <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> + <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> + </ul> + + <section class="top-bar-section"> + <!-- Right Nav Section --> + <ul class="right"> + <li class="has-dropdown"> + <a href="#">Project</a> + <ul class="dropdown"> + <li><a href="index.html">Home</a></li> + <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Documentation</a> + <ul class="dropdown"> + <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> + <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> + <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> + <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> + <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Downloads</a> + <ul class="dropdown"> + <li><a href="download.html">Download MiNiFi Components</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Community</a> + <ul class="dropdown"> + <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> + <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> + <li><a href="../people.html">People</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Development</a> + <ul class="dropdown"> + <li><a href="../release-guide.html">Release Guide</a></li> + <li><a href="../licensing-guide.html">Licensing Guide</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">ASF Links</a> + <ul class="dropdown"> + <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> + <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> + </ul> + </li> + <li> + <a href="../index.html">Apache NiFi</a> + </li> </ul> - </li> - <li class="has-dropdown"> - <a href="#">ASF Links</a> - <ul class="dropdown"> - <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> - <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> - </ul> - </li> - <li> - <a href="../index.html">Apache NiFi</a> - </li> - </ul> - </section> - </nav> -</div> - - + </section> + </nav> + </div> <div class="row"> <div class="large-12 columns"> <div class="large-space"></div> - <!-- +<!-- 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. @@ -119,11 +117,10 @@ See the License for the specific language governing permissions and limitations under the License. --> - -<h1 id="minifi-java-agent-quick-start-guide">MiNiFi Java Agent Quick Start Guide</h1> -<p><a href="d...@nifi.apache.org">Apache NiFi Team</a></p> +<h1>MiNiFi Java Agent Quick Start Guide</h1> +<p><a href="d...@nifi.apache.org>">Apache NiFi Team</a></p> <p><a href="http://nifi.apache.org";>NiFi Homepage</a></p> -<h1 id="overview">Overview</h1> +<h1>Overview</h1> <p>Apache NiFi MiNiFi is an Apache NiFi project, designed to collect data at its source. MiNiFi was developed with the following objectives in mind:</p> <ul> <li>Small and lightweight footprint</li> @@ -131,7 +128,7 @@ <li>Data provenance generation</li> <li>NiFi integration for follow-on dataflow management and chain of custody information</li> </ul> -<h1 id="before-you-begin">Before You Begin</h1> +<h1>Before You Begin</h1> <p>MiNiFi Java Agent is supported on the following operating systems:</p> <ul> <li>Red Hat Enterprise Linux / CentOS 6 (64-bit)</li> @@ -142,9 +139,9 @@ <li>SUSE Linux Enterprise Server (SLES) 11 SP3 (64-bit)</li> </ul> <p>You can download the MiNiFi Java Agent and the MiNiFi Toolkit from the <a href="http://nifi.apache.org/minifi/download.html";>MiNiFi download page</a>.</p> -<h1 id="installing-and-starting-minifi">Installing and Starting MiNiFi</h1> +<h1>Installing and Starting MiNiFi</h1> <p>You have several options for installing and starting MiNiFi.</p> -<h2 id="for-linux-and-mac-os-x-users">For Linux and Mac OS X Users</h2> +<h2>For Linux and Mac OS X Users</h2> <p>To install MiNiFi:</p> <ol> <li><a href="http://nifi.apache.org/minifi/download.html";>Download</a> MiNiFi.</li> @@ -153,33 +150,40 @@ <p>You can also install MiNiFi as a service:</p> <ol> <li>Navigate to the MiNiFi installation directory.</li> -<li>Enter:<pre><code>bin/minifi.sh install</code></pre> -<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:</li> +<li>Enter:</li> </ol> -<pre><code>bin/minifi.sh install dataflow</code></pre> +<pre><code>bin/minifi.sh install +</code></pre> +<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>To launch MiNiFi in the foreground:</p> <ol> <li>From a terminal window, navigate to the MiNiFi installation directory.Enter:</li> </ol> -<pre><code>bin/minifi.sh run</code></pre> +<pre><code>bin/minifi.sh run +</code></pre> <p>To launch MiNiFi in the background:</p> <ol> <li>From a terminal window, navigate to the MiNiFi installation directory.</li> -<li>Enter:<pre><code>bin/minifi.sh start</code></pre> -</li> +<li>Enter:</li> </ol> +<pre><code>bin/minifi.sh start +</code></pre> <p>To launch MiNiFi as a service:</p> <ol> -<li>From a terminal window, enter:<pre><code>sudo service minifi start</code></pre> -<h2 id="for-windows-users">For Windows Users</h2> -For Windows users, navigate to the folder where MiNiFi was installed. Navigate to the /bin subdirectory and double-click the run-minifi.bat file.</li> +<li>From a terminal window, enter:</li> </ol> +<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>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 id="working-with-dataflows">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> -<h2 id="setting-up-your-dataflow">Setting up Your Dataflow</h2> -<p>Before you begin, you should be aware that the following NiFi components are not supported in MiNiFi dataflows:</p> +<p>#Working with dataflows<br> +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> +<p>##Setting up Your Dataflow<br> +Before you begin, you should be aware that the following NiFi components are not supported in MiNiFi dataflows:</p> <ul> <li>Controller services</li> <li>Funnels</li> @@ -193,15 +197,18 @@ For Windows users, navigate to the folde <li>Create a dataflow.</li> <li>Convert your dataflow into a template.</li> <li>Download your template as an .xml file. For more information on working with templates, see the <a href="https://nifi.apache.org/docs/nifi-docs/html/user-guide.html#templates";>Templates</a> section in the <em>User Guide</em>.</li> -<li>From the MiNiFi Toolkit, run the following command to turn your .xml file into a .yml file:<pre><code>config.sh transform input_file output_file</code></pre> -</li> +<li>From the MiNiFi Toolkit, run the following command to turn your .xml file into a .yml file:</li> +</ol> +<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. +<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> -<h2 id="using-processors-not-packaged-with-minifi">Using Processors Not Packaged with MiNiFi</h2> -<p>MiNiFi is able to use following processors out of the box:</p> +<p>##Using Processors Not Packaged with MiNiFi<br> +MiNiFi is able to use following processors out of the box:</p> <ul> <li>UpdateAttribute</li> <li>AttributesToJSON</li> @@ -276,28 +283,28 @@ For Windows users, navigate to the folde </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> <ul> -<li>nifi-dbcp-service-nar<ul> +<li>nifi-dbcp-service-nar +<ul> <li>ConvertJSONToSQL</li> <li>PutSQL</li> <li>GenerateTableFetch</li> <li>ListDatabaseTable</li> <li>QueryDatabaseTable</li> <li>ExecuteSQL</li> -</ul> -</li> -<li>nifi-distributed-cache-services-nar<ul> +</ul></li> +<li>nifi-distributed-cache-services-nar +<ul> <li>DetectDuplicate</li> <li>FetchDistributedMapCache</li> <li>PutDistributedMapCache</li> -</ul> -</li> -<li>nifi-http-context-map-nar<ul> +</ul></li> +<li>nifi-http-context-map-nar +<ul> <li>HandleHttpRequest</li> <li>HandleHttpResponse</li> +</ul></li> </ul> -</li> -</ul> -<h1 id="securing-your-dataflow">Securing your Dataflow</h1> +<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> <ol> @@ -317,102 +324,105 @@ ssl protocol: TLS Sensitive Props: key: algorithm: PBEWITHMD5AND256BITAES-CBC-OPENSSL -provider: BC</code></pre> -<h1 id="managing-minifi">Managing MiNiFi</h1> +provider: BC +</code></pre> +<h1>Managing MiNiFi</h1> <p>You can also perform some management tasks using MiNiFi.</p> -<h2 id="monitoring-status">Monitoring Status</h2> +<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>FlowStatus accepts the following flags and options:</p> <ul> -<li>processors<ul> +<li>processors +<ul> <li>health</li> <li>bulletins</li> <li>status</li> -</ul> -</li> -<li>connections<ul> +</ul></li> +<li>connections +<ul> <li>health</li> <li>stats</li> -</ul> -</li> -<li>remoteProcessGroups<ul> +</ul></li> +<li>remoteProcessGroups +<ul> <li>health</li> <li>bulletins</li> <li>status</li> <li>authorizationIssues</li> <li>inputPorts</li> -</ul> -</li> -<li>controllerServices<ul> +</ul></li> +<li>controllerServices +<ul> <li>health</li> <li>bulletins</li> -</ul> -</li> -<li>provenancereporting<ul> +</ul></li> +<li>provenancereporting +<ul> <li>health</li> <li>bulletins</li> -</ul> -</li> -<li>instance<ul> +</ul></li> +<li>instance +<ul> <li>health</li> <li>bulletins</li> <li>status</li> -</ul> -</li> -<li>systemdiagnostics<ul> +</ul></li> +<li>systemdiagnostics +<ul> <li>heap</li> <li>processorstats</li> <li>contentrepositoryusage</li> <li>flowfilerepositoryusage</li> <li>garbagecollection</li> -</ul> -</li> +</ul></li> </ul> <p>For example, this query gets the health, stats, and bulletins for the TailFile processors:</p> <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> -<h2 id="loading-a-new-dataflow">Loading a New Dataflow</h2> +<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>Restart MiNiFi.</li> </ol> -<h2 id="stopping-minifi">Stopping MiNiFi</h2> +<h2>Stopping MiNiFi</h2> <p>You can stop MiNiFi at any time.</p> <p>Stopping MiNiFi:</p> <ol> <li>From a terminal window, navigate to the MiNiFi installation directory.</li> -<li>Enter:<pre><code>bin/minifi.sh stop</code></pre> -</li> +<li>Enter:</li> </ol> +<pre><code>bin/minifi.sh stop +</code></pre> <p>Stopping MiNiFi as a service:</p> <ol> -<li>From a terminal window, enter:<pre><code>sudo service minifi stop</code></pre> -</li> +<li>From a terminal window, enter:</li> </ol> - +<pre><code>sudo service minifi stop +</code></pre> </div> </div> <div class="row"> - <div class="large-12 columns footer"> - <a href="https://www.apache.org";> - <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200"> - </a> - <div id="copyright"> - <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a - href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the - Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software - Foundation.</p> + <div class="large-12 columns footer"> + <a href="https://www.apache.org";> + <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200" style="margin:0px 10px" /> + </a> + <a href="http://www.apache.org/events/current-event.html";> + <img src="http://www.apache.org/events/current-event-234x60.png"; style="margin:0px 10px" /> + </a> + <div id="copyright"> + <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a + href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the + Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software + Foundation.</p> + </div> + </div> </div> - </div> -</div> - <script src="../assets/js/jquery.min.js"></script> <script src="../assets/js/foundation.js"></script> <script src="../assets/js/app.js"></script> </body> </html> - Modified: nifi/site/trunk/minifi/minifi-toolkit.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/minifi-toolkit.html?rev=1828794&r1=1828793&r2=1828794&view=diff ============================================================================== --- nifi/site/trunk/minifi/minifi-toolkit.html (original) +++ nifi/site/trunk/minifi/minifi-toolkit.html Tue Apr 10 07:50:11 2018 @@ -20,92 +20,90 @@ </head> <body> <div class="sticky contain-to-grid"> - <nav class="top-bar" data-topbar role="navigation"> - <ul class="title-area"> - <li class="name"> - <h1> - <a href="index.html"> - <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> - </a> - </h1> - </li> - <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> - <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> - </ul> - - <section class="top-bar-section"> - <!-- Right Nav Section --> - <ul class="right"> - <li class="has-dropdown"> - <a href="#">Project</a> - <ul class="dropdown"> - <li><a href="index.html">Home</a></li> - <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> - <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Documentation</a> - <ul class="dropdown"> - <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> - <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> - <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> - <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> - <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Downloads</a> - <ul class="dropdown"> - <li><a href="download.html">Download MiNiFi Components</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">Community</a> - <ul class="dropdown"> - <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> - <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> - <li><a href="../people.html">People</a></li> + <nav class="top-bar" data-topbar role="navigation"> + <ul class="title-area"> + <li class="name"> + <h1> + <a href="index.html"> + <img id="logo-top-bar" src="../assets/images/minifi-drop-white.svg" alt="MiNiFi"/> + </a> + </h1> + </li> + <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> + <li class="toggle-topbar menu-icon"><a href="#"><span></span></a></li> + </ul> + + <section class="top-bar-section"> + <!-- Right Nav Section --> + <ul class="right"> + <li class="has-dropdown"> + <a href="#">Project</a> + <ul class="dropdown"> + <li><a href="index.html">Home</a></li> + <li><a href="https://blogs.apache.org/nifi/";><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link external-link"></i>License</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Documentation</a> + <ul class="dropdown"> + <li><a href="getting-started.html"><i class="fa"></i>Getting Started</a></li> + <li><a href="minifi-java-agent-quick-start.html"><i class="fa"></i>MiNiFi Java Quick Start Guide</a></li> + <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> + <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> + <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Downloads</a> + <ul class="dropdown"> + <li><a href="download.html">Download MiNiFi Components</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i class="fa fa-external-link external-link"></i>Release Notes</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Community</a> + <ul class="dropdown"> + <li><a href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";><i class="fa fa-external-link external-link"></i>Contributor Guide</a></li> + <li><a href="../mailing_lists.html">Mailing Lists & Chat</a></li> + <li><a href="../people.html">People</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">Development</a> + <ul class="dropdown"> + <li><a href="../release-guide.html">Release Guide</a></li> + <li><a href="../licensing-guide.html">Licensing Guide</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> + <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> + <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> + </ul> + </li> + <li class="has-dropdown"> + <a href="#">ASF Links</a> + <ul class="dropdown"> + <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> + <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> + </ul> + </li> + <li> + <a href="../index.html">Apache NiFi</a> + </li> </ul> - </li> - <li class="has-dropdown"> - <a href="#">Development</a> - <ul class="dropdown"> - <li><a href="../release-guide.html">Release Guide</a></li> - <li><a href="../licensing-guide.html">Licensing Guide</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa fa-external-link external-link"></i>Source - Java Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi";><i class="fa fa-external-link external-link"></i>Source - GitHub - Java Agent</a></li> - <li><a href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa fa-external-link external-link"></i>Source - C++ Agent</a></li> - <li><a href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link external-link"></i>Source - GitHub - C++ Agent</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa fa-external-link external-link"></i>MiNiFi Java Issues</a></li> - <li><a href="https://issues.apache.org/jira/browse/MINIFICPP";><i class="fa fa-external-link external-link"></i>MiNiFi C++ Issues</a></li> - </ul> - </li> - <li class="has-dropdown"> - <a href="#">ASF Links</a> - <ul class="dropdown"> - <li><a href="https://www.apache.org";><i class="fa fa-external-link external-link"></i>Apache Software Foundation</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html";><i class="fa fa-external-link external-link"></i>Sponsorship</a></li> - <li><a href="https://www.apache.org/security/";><i class="fa fa-external-link external-link"></i>Security</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html";><i class="fa fa-external-link external-link"></i>Thanks</a></li> - </ul> - </li> - <li> - <a href="../index.html">Apache NiFi</a> - </li> - </ul> - </section> - </nav> -</div> - - + </section> + </nav> + </div> <div class="row"> <div class="large-12 columns"> <div class="large-space"></div> - <p><!-- +<!-- 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. @@ -118,10 +116,10 @@ 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. ---></p> -<h1 id="apache-nifi-minifi-toolkit">Apache NiFi - MiNiFi - Toolkit</h1> +--> +# Apache NiFi - MiNiFi - Toolkit <p>MiNiFi is a child project effort of Apache NiFi. The MiNiFi toolkit aids in creating MiNiFi configuration files from exported NiFi templates.</p> -<h2 id="table-of-contents">Table of Contents</h2> +<h2>Table of Contents</h2> <ul> <li><a href="#requirements">Requirements</a></li> <li><a href="#getting-started">Getting Started</a></li> @@ -130,24 +128,21 @@ <li><a href="#license">License</a></li> <li><a href="#export-control">Export Control</a></li> </ul> -<h2 id="requirements">Requirements</h2> +<h2>Requirements</h2> <ul> <li>JRE 1.8</li> </ul> -<h2 id="getting-started">Getting Started</h2> -<p>The latest version of the MiNiFi Toolkit Converter can be found at <a href="https://nifi.apache.org/minifi/download.html";>https://nifi.apache.org/minifi/download.html</a> under the <code>MiNiFi Toolkit Binaries</code> section.</p> +<h2>Getting Started</h2> +<p>The latest version of the MiNiFi Toolkit Converter can be found at https://nifi.apache.org/minifi/download.html under the <code>MiNiFi Toolkit Binaries</code> section.</p> <p>After downloading the binary and extracting it, to run the MiNiFi Toolkit Converter:</p> <ul> <li><p>Change directory to the location where you installed MiNiFi Toolkit and run it and view usage information</p> <ul> -<li><p>Linux / OS X</p> -<pre><code>$ ./config.sh</code></pre> -</li> -<li><p>Windows - execute bin/config.bat</p> -</li> -</ul> -</li> +<li><p>Linux / OS X<br> +$ ./config.sh</p></li> +<li><p>Windows<br> +execute bin/config.bat</p></li> +</ul></li> <li><p>Usage Information</p> <pre><code>Usage: @@ -155,75 +150,75 @@ java org.apache.nifi.minifi.toolkit.conf Valid commands include: transform: Transform template xml into MiNiFi config YAML -validate: Validate config YAML</code></pre> -</li> +validate: Validate config YAML +</code></pre></li> </ul> <p>Note: Currently MiNiFi does not support external Input Ports or Output Ports. Any templates that contain these will fail transformation.</p> -<h2 id="getting-help">Getting Help</h2> -<p>If you have questions, you can reach out to our mailing list: d...@nifi.apache.org -(<a href="https://mail-archives.apache.org/mod_mbox/nifi-dev";>archive</a>). -We're also often available in IRC: #nifi on +<h2>Getting Help</h2> +<p>If you have questions, you can reach out to our mailing list: d...@nifi.apache.org<br> +(<a href="https://mail-archives.apache.org/mod_mbox/nifi-dev";>archive</a>).<br> +We're also often available in IRC: #nifi on<br> <a href="https://webchat.freenode.net/?channels=#nifi";>irc.freenode.net</a>.</p> -<h2 id="documentation">Documentation</h2> -<p>See <a href="https://nifi.apache.org/minifi";>https://nifi.apache.org/minifi</a> and <a href="https://cwiki.apache.org/confluence/display/NIFI/MiNiFi";>https://cwiki.apache.org/confluence/display/NIFI/MiNiFi</a> for the latest documentation.</p> -<h2 id="license">License</h2> -<p>Except as otherwise noted this software is licensed under the +<h2>Documentation</h2> +<p>See https://nifi.apache.org/minifi and https://cwiki.apache.org/confluence/display/NIFI/MiNiFi for the latest documentation.</p> +<h2>License</h2> +<p>Except as otherwise noted this software is licensed under the<br> <a href="https://www.apache.org/licenses/LICENSE-2.0.html";>Apache License, Version 2.0</a></p> -<p>Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. +<p>Licensed under the Apache License, Version 2.0 (the "License");<br> +you may not use this file except in compliance with the License.<br> You may obtain a copy of the License at</p> -<p> <a href="https://www.apache.org/licenses/LICENSE-2.0";>https://www.apache.org/licenses/LICENSE-2.0</a></p> -<p>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 +<p>https://www.apache.org/licenses/LICENSE-2.0</p> +<p>Unless required by applicable law or agreed to in writing, software<br> +distributed under the License is distributed on an "AS IS" BASIS,<br> +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br> +See the License for the specific language governing permissions and<br> limitations under the License.</p> -<h2 id="export-control">Export Control</h2> -<p>This distribution includes cryptographic software. The country in which you -currently reside may have restrictions on the import, possession, use, and/or -re-export to another country, of encryption software. BEFORE using any -encryption software, please check your country's laws, regulations and -policies concerning the import, possession, or use, and re-export of encryption -software, to see if this is permitted. See <a href="http://www.wassenaar.org/";>http://www.wassenaar.org/</a> for more +<h2>Export Control</h2> +<p>This distribution includes cryptographic software. The country in which you<br> +currently reside may have restrictions on the import, possession, use, and/or<br> +re-export to another country, of encryption software. BEFORE using any<br> +encryption software, please check your country's laws, regulations and<br> +policies concerning the import, possession, or use, and re-export of encryption<br> +software, to see if this is permitted. See <a href="http://www.wassenaar.org/";>http://www.wassenaar.org/</a> for more<br> information.</p> -<p>The U.S. Government Department of Commerce, Bureau of Industry and Security -(BIS), has classified this software as Export Commodity Control Number (ECCN) -5D002.C.1, which includes information security software using or performing -cryptographic functions with asymmetric algorithms. The form and manner of this -Apache Software Foundation distribution makes it eligible for export under the -License Exception ENC Technology Software Unrestricted (TSU) exception (see the -BIS Export Administration Regulations, Section 740.13) for both object code and +<p>The U.S. Government Department of Commerce, Bureau of Industry and Security<br> +(BIS), has classified this software as Export Commodity Control Number (ECCN)<br> +5D002.C.1, which includes information security software using or performing<br> +cryptographic functions with asymmetric algorithms. The form and manner of this<br> +Apache Software Foundation distribution makes it eligible for export under the<br> +License Exception ENC Technology Software Unrestricted (TSU) exception (see the<br> +BIS Export Administration Regulations, Section 740.13) for both object code and<br> source code.</p> <p>The following provides more details on the included cryptographic software:</p> -<p>Apache NiFi - MiNiFi uses BouncyCastle, Jasypt, JCraft Inc., and the built-in -java cryptography libraries for SSL, SSH, and the protection -of sensitive configuration parameters. See -<a href="https://bouncycastle.org/about.html";>https://bouncycastle.org/about.html</a> -<a href="http://www.jasypt.org/faq.html";>http://www.jasypt.org/faq.html</a> -<a href="http://jcraft.com/c-info.html";>http://jcraft.com/c-info.html</a> -<a href="https://www.oracle.com/us/products/export/export-regulations-345813.html";>https://www.oracle.com/us/products/export/export-regulations-345813.html</a> +<p>Apache NiFi - MiNiFi uses BouncyCastle, Jasypt, JCraft Inc., and the built-in<br> +java cryptography libraries for SSL, SSH, and the protection<br> +of sensitive configuration parameters. See<br> +https://bouncycastle.org/about.html<br> +http://www.jasypt.org/faq.html<br> +http://jcraft.com/c-info.html<br> +https://www.oracle.com/us/products/export/export-regulations-345813.html<br> for more details on each of these libraries cryptography features.</p> - </div> </div> <div class="row"> - <div class="large-12 columns footer"> - <a href="https://www.apache.org";> - <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200"> - </a> - <div id="copyright"> - <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a - href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the - Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software - Foundation.</p> + <div class="large-12 columns footer"> + <a href="https://www.apache.org";> + <img id="asf-logo" alt="Apache Software Foundation" src="../assets/images/asf_logo.png" width="200" style="margin:0px 10px" /> + </a> + <a href="http://www.apache.org/events/current-event.html";> + <img src="http://www.apache.org/events/current-event-234x60.png"; style="margin:0px 10px" /> + </a> + <div id="copyright"> + <p>Copyright © 2017 The Apache Software Foundation, Licensed under the <a + href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.<br/>Apache, the + Apache feather logo, NiFi, Apache NiFi and the project logo are trademarks of The Apache Software + Foundation.</p> + </div> + </div> </div> - </div> -</div> - <script src="../assets/js/jquery.min.js"></script> <script src="../assets/js/foundation.js"></script> <script src="../assets/js/app.js"></script> </body> </html> -
![http://www.apache.org/events/current-event-234x60.png"](http://www.apache.org/events/current-event-234x60.png"){kind=link}