Modified: nifi/site/trunk/docs/nifi-registry-docs/html/user-guide.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/html/user-guide.html?rev=1859662&r1=1859661&r2=1859662&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-registry-docs/html/user-guide.html (original) +++ nifi/site/trunk/docs/nifi-registry-docs/html/user-guide.html Tue May 21 16:47:35 2019 @@ -500,6 +500,13 @@ body.book #toc,body.book #preamble,body. <li><a href="user-guide.html#other-group-level-actions">Other Group Level Actions</a></li> </ul> </li> +<li><a href="user-guide.html#manage-bundles">Manage Bundles</a> +<ul class="sectlevel2"> +<li><a href="user-guide.html#upload-bundle">Upload Bundle</a></li> +<li><a href="user-guide.html#download-bundle">Download Bundle</a></li> +<li><a href="user-guide.html#additional-actions">Additional Actions</a></li> +</ul> +</li> </ul> </div> </div> @@ -589,10 +596,13 @@ The minimum recommended screen size is 1 <p><strong>Flow</strong>: A process group level NiFi dataflow that has been placed under version control and saved to the Registry.</p> </div> <div class="paragraph"> -<p><strong>Bucket</strong>: A container that stores and organizes flows.</p> +<p><strong>Bundle</strong>: A binary artifact containing one or more extensions that can be run in NiFi or MiNiFi.</p> </div> <div class="paragraph"> -<p><strong>Policy</strong>: Defines a user or group’s ability to import, view, commit changes and/or delete flows.</p> +<p><strong>Bucket</strong>: A container that stores and organizes versioned items, such as flows and bundles.</p> +</div> +<div class="paragraph"> +<p><strong>Policy</strong>: Defines a user or group’s ability to perform a given action.</p> </div> </div> </div> @@ -1400,10 +1410,114 @@ Groups cannot contain other groups. </div> </div> </div> +<div class="sect1"> +<h2 id="manage-bundles"><a class="anchor" href="user-guide.html#manage-bundles"></a>Manage Bundles</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Bundles can be managed through the REST API.</p> +</div> +<div class="sect2"> +<h3 id="upload-bundle"><a class="anchor" href="user-guide.html#upload-bundle"></a>Upload Bundle</h3> +<div class="paragraph"> +<p>A bundle can be uploaded to a bucket by making a <code>POST</code> request to the following REST end-point:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>/nifi-registry-api/buckets/<bucketId>/bundles/<bundleType></pre> +</div> +</div> +<div class="paragraph"> +<p>Replace <code>bucketId</code> with the id of the bucket where the bundle is being uploaded to and <code>bundleType</code> with the type of bundle being uploaded. Currently, the only supported bundle type is a <a href="https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#nars";>NiFi Archive (NAR)</a> which can be specified as <code>nifi-nar</code>.</p> +</div> +<div class="paragraph"> +<p>The <code>Content-Type</code> of the request is expected to be <code>multipart/form-data</code>. An example of using <code>curl</code> to upload <code>my-processors-1.0.0.nar</code> would be the following:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>curl -v -F file=@/path/to/my-processors-1.0.0.nar http://localhost:18080/nifi-registry-api/buckets/de8e08c9-592d-4e10-affe-b3752698f1d9/bundles/nifi-nar</pre> +</div> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +In order to upload a NAR to NiFi Registry, it must contain the file <em>META-INF/docs/extension-manifest.xml</em> which is produced by the NAR Maven plugin, starting with version 1.3.0. +</td> +</tr> +</table> +</div> +</div> +<div class="sect2"> +<h3 id="download-bundle"><a class="anchor" href="user-guide.html#download-bundle"></a>Download Bundle</h3> +<div class="paragraph"> +<p>There are two ways to download a bundle.</p> +</div> +<div class="sect3"> +<h4 id="bundle-coordinates"><a class="anchor" href="user-guide.html#bundle-coordinates"></a>Bundle Coordinates</h4> +<div class="paragraph"> +<p>A bundle can be downloaded by using the combination of the bucket name and bundle coordinates, where bundle coordinates are the group, artifact, and version of the bundle.</p> +</div> +<div class="paragraph"> +<p>To download a bundle by its coordinates, a <code>GET</code> request can be made to the following end-point:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>/nifi-registry-api/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>Content-Type</code> of the response is <code>application/octet-stream</code>.</p> +</div> +<div class="paragraph"> +<p>An example of using <code>curl</code> to download <code>my-processors-1.0.0.nar</code> from the <code>Test</code> bucket would be the following:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>curl http://localhost:18080/nifi-registry-api/extension-repository/Test/com.test/my-processors/1.0.0/content > my-processors-1.0.0.nar</pre> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="bundle-id"><a class="anchor" href="user-guide.html#bundle-id"></a>Bundle Id</h4> +<div class="paragraph"> +<p>A bundle can be downloaded by using the combination of its unique id and version. The unique id is an id assigned to the bundle when the first version of the bundle is uploaded to NiFi Registry. This id is returned in the response of a successful upload.</p> +</div> +<div class="paragraph"> +<p>To download a bundle by its id and version, a <code>GET</code> request can be made to the following end-point:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>/nifi-registry-api/bundles/{bundleId}/versions/{version}/content</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>Content-Type</code> of the response is <code>application/octet-stream</code>.</p> +</div> +<div class="paragraph"> +<p>An example of using <code>curl</code> to download <code>my-processors-1.0.0.nar</code> by id and version would be the following:</p> +</div> +<div class="literalblock"> +<div class="content"> +<pre>curl http://localhost:18080/nifi-registry-api/bundles/3db78035-e3ba-4cbf-820e-022f292bd68c/versions/1.0.0/content > my-processors-1.0.0.nar</pre> +</div> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="additional-actions"><a class="anchor" href="user-guide.html#additional-actions"></a>Additional Actions</h3> +<div class="paragraph"> +<p>For additional actions that can be performed related to bundles, please consult the <a href="rest-api.html">REST API documentation</a>.</p> +</div> +</div> +</div> +</div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2018-09-22 09:25:14 -04:00 +Last updated 2019-05-16 16:37:59 -04:00 </div> </div> </body>
Added: nifi/site/trunk/docs/nifi-registry-docs/images/registry-favicon.png URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/images/registry-favicon.png?rev=1859662&view=auto ============================================================================== Binary file - no diff available. Propchange: nifi/site/trunk/docs/nifi-registry-docs/images/registry-favicon.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Modified: nifi/site/trunk/docs/nifi-registry-docs/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/index.html?rev=1859662&r1=1859661&r2=1859662&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-registry-docs/index.html (original) +++ nifi/site/trunk/docs/nifi-registry-docs/index.html Tue May 21 16:47:35 2019 @@ -6,7 +6,7 @@ <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <link rel="shortcut icon" href="http://localhost:18080/nifi/images/nifi16.ico"/> + <link rel="shortcut icon" href="images/registry-favicon.png"/> <title>NiFi Registry Documentation</title> <script type="text/javascript" src="js/jquery.min.js"></script> <script type="text/javascript" src="js/application.js"></script> @@ -42,8 +42,8 @@ <div class="header">General</div> <div id="general-links" class="component-links"> <ul> - <li class="component-item"><a class="document-link admin-guide" href="html/getting-started.html" target="component-usage">Getting Started</a></li> - <li class="component-item"><a class="document-link admin-guide" href="html/user-guide.html" target="component-usage">User Guide</a></li> + <li class="component-item"><a class="document-link getting-started" href="html/getting-started.html" target="component-usage">Getting Started</a></li> + <li class="component-item"><a class="document-link user-guide" href="html/user-guide.html" target="component-usage">User Guide</a></li> <li class="component-item"><a class="document-link admin-guide" href="html/administration-guide.html" target="component-usage">Admin Guide</a></li> </ul> <span class="no-matching no-components hidden">No matching guides</span> @@ -53,7 +53,7 @@ <div class="header">Developer</div> <div id="developer-links" class="component-links"> <ul> - <li class="component-item"><a class="document-link rest-api" href="rest-api/index.html" target="component-usage">Rest Api</a></li> + <li class="component-item"><a class="document-link rest-api" href="rest-api/rest-api.html" target="component-usage">REST API</a></li> </ul> <span class="no-matching no-components hidden">No matching developer guides</span> </div>
