http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/Import-API-Options.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/Import-API-Options.html b/1.0.0-alpha/Import-API-Options.html new file mode 100644 index 0000000..61a865d --- /dev/null +++ b/1.0.0-alpha/Import-API-Options.html @@ -0,0 +1,258 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/Import-API-Options.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas РImport API Options</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Import API Options</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h2><a name="Import_API_Options"></a>Import API Options</h2> +<p>Import API options are specified as <i>options</i> JSON. Since the API accepts multi-part form data, it is possible to sepecify multipls input streams within the CURL call.</p></div> +<div class="section"> +<h4><a name="Examples_Using_CURL_Calls"></a>Examples Using CURL Calls</h4> +<div class="source"><pre class="prettyprint"> +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" + -H "Cache-Control: no-cache" + -F [email protected] + -F [email protected] + "http://localhost:21000/api/atlas/admin/import" + +</pre></div> +<p>To use the defaults, set the contents of <i>importOptions.json</i> to:</p> +<div class="source"><pre class="prettyprint"> +{ + "options": { + } +} + +</pre></div></div> +<div class="section"> +<h4><a name="Options"></a>Options</h4> +<p>Following options are supported for Import process:</p> +<p></p> +<ul> +<li>Specify transforms during import operation.</li> +<li>Resume import by specifying starting entity guid.</li> +<li>Optionally import type definition.</li></ul></div> +<div class="section"> +<h5><a name="Transforms"></a>Transforms</h5> +<p>During the import process, the attribute value of the incoming entity can be changed.</p> +<p>This is possible by specifying entity type and at attribute to be modified and then the manner in which it needs to be modified.</p> +<p>Right now these are the transforms that can be applied:</p> +<ul> +<li><i>lowercase</i> Converts the attribute value to lower case.</li> +<li><i>replace</i> This performs a string find and replace operation. It takes two parameters, the first is the string to search for and the next one is the string to replace it with.</li></ul> +<p>Example:</p> +<p>The example below applies couple of transforms to the the <i>qualifiedName</i> attribute of hive_table. It converts the value to lower case, then searches for 'cl1', if found, replaces it with 'cl2'.</p> +<p>To use the option, set the contents of <i>importOptions.json</i> to:</p> +<div class="source"><pre class="prettyprint"> +{ + "options": { + "transforms": "{ \"hive_table\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] }, \"hive_db\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] } }" + } +} + +</pre></div> +<p>Please refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/ATLAS-1825";>ATLAS-1825</a> for details scenarios when this option could be used.</p></div> +<div class="section"> +<h5><a name="Start_Guid_or_Start_Index"></a>Start Guid or Start Index</h5> +<p>When an import operation is in progress and the server goes down, it would be possible to resume import from the last successfully imported entity. This would allow the import to resume from where it left off.</p> +<p>Server-side logging is improved to display the detail of the last successfully imported entity, this includes the index within the import list and the entity's guid. Either can be used specify the point to resume import.</p> +<p>To use the option, set the contents of <i>importOptions.json</i> to:</p> +<div class="source"><pre class="prettyprint"> +{ + + "options": { + "startGuid": "bd97c78e-3fa5-4f9c-9f48-3683ca3d1fb1" + } +} + +</pre></div> +<p>To use <i>startPosition</i>, use the following in the <i>importOptions.json</i>:</p> +<div class="source"><pre class="prettyprint"> +{ + + "options": { + "startPosition": "332" + } +} + +</pre></div> +<p>Steps to use the behavior:</p> +<ul> +<li>Start an import (using the CURL) that is fairly long, say about 1000+ entities.</li> +<li>While the import is in progress, stop atlas server (using atlas_stop.py).</li> +<li>From the log file located at <i>/var/log/atlas/application.log</i> get the last successfully imported entity GUID or index position.</li> +<li>Update the <i>importOptions.json</i> with the guid.</li> +<li>Restart import.</li></ul></div> +<div class="section"> +<h5><a name="Optional_Importing_Type_Definition"></a>Optional Importing Type Definition</h5> +<p>The output of Export has <i>atlas-typedef.json</i> that contains the type definitions for the entities exported.</p> +<p>By default (that is if no options is specified), the type definitions are imported and applied to the system being imported to. The entity import is performed after this.</p> +<p>In some cases, you would not want to modify the type definitions. Import may be better off failing than the types be modified.</p> +<p>This option allows for optionally importing of type definition. The option is set to <i>true</i> by default, which means that type definition is imported. With this option set to <i>false</i>, type definitions preseneraent in the source will not be imported. In case of mismatch between the entities being imported the types present in the system where the import is being performed, the operation will fail.</p> +<p>Table below enumerates the conditions that get addressed as part of type definition import:</p> +<p></p> +<table border="0" class="table table-striped"> +<tr class="a"> +<th>Condition</th> +<th>Action</th></tr> +<tr class="b"> +<td>Incoming type does not exist in target system</td> +<td>Type is created.</td></tr> +<tr class="a"> +<td>Type to be imported and type in target system are same</td> +<td>No change</td></tr> +<tr class="b"> +<td>Type to be imported and type in target system differ by some attributes</td> +<td>Target system type is updated to the attributes present in the source. It is possible that the target system will have attributes in addition to the one present in the source. In that case, the target system's type attributes will be an union of the attributes. Attributes in target system will not be deleted to match the source. If the type of the attribute differ, import process will be aborted and exception logged.</td></tr></table>To use the option, set the contents of <i>importOptions.json</i> to: +<div class="source"><pre class="prettyprint"> +{ + + "options": { + "updateTypeDefinition": true + } +} + +</pre></div></div> +<div class="section"> +<h5><a name="Specifying_File_to_be_Imported_From_Server_Location"></a>Specifying File to be Imported From Server Location</h5> +<p>In scenario where the file to be imported is present at a location on the server, the <i>importfile</i> API can be used. It behaves like the Import API.</p> +<p>To use the option, set the contents of <i>importOptions.json</i> to:</p> +<div class="source"><pre class="prettyprint"> +{ + + "options": { + "fileName": "/root/fileToBeImported.zip" + } +} + +</pre></div> +<p><i>CURL</i></p> +<div class="source"><pre class="prettyprint"> +curl -g -X POST -u adminuser:password -H "Content-Type: application/json" + -H "Cache-Control: no-cache" + -d [email protected] + "http://localhost:21000/api/atlas/admin/importfile" + +</pre></div></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright ̩ 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/Import-API.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/Import-API.html b/1.0.0-alpha/Import-API.html new file mode 100644 index 0000000..36e0f69 --- /dev/null +++ b/1.0.0-alpha/Import-API.html @@ -0,0 +1,284 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/Import-API.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Import API</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Import API</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h2><a name="Import_API"></a>Import API</h2> +<p>The general approach is:</p> +<ul> +<li>Consumer makes a ZIP file available for import operation. See details below for the 2 flavors of the API.</li> +<li>The API if successful, will return the results of the operation.</li> +<li>Error will be returned on failure of the call.</li></ul></div> +<div class="section"> +<h4><a name="Import_ZIP_File_Using_POST"></a>Import ZIP File Using POST</h4> +<p></p> +<table border="0" class="table table-striped"> +<tr class="a"> +<th>Title</th> +<th>Import API</th></tr> +<tr class="b"> +<td><i>Example</i></td> +<td>See Examples sections below.</td></tr> +<tr class="a"> +<td><i>Description</i></td> +<td>Provide the contents of the file to be imported in the request body.</td></tr> +<tr class="b"> +<td><i>URL</i></td> +<td><i>api/atlas/admin/import</i></td></tr> +<tr class="a"> +<td><i>Method</i></td> +<td><i>POST</i></td></tr> +<tr class="b"> +<td><i>URL Parameters</i></td> +<td><i>None</i></td></tr> +<tr class="a"> +<td><i>Data Parameters</i></td> +<td><i>None</i></td></tr> +<tr class="b"> +<td><i>Success Response</i></td> +<td><i>AtlasImporResult</i> is returned as JSON. See details below.</td></tr> +<tr class="a"> +<td><i>Error Response</i></td> +<td>Errors that are handled within the system will be returned as <i>AtlasBaseException</i>.</td></tr></table></div> +<div class="section"> +<h4><a name="Import_ZIP_File_Available_on_Server"></a>Import ZIP File Available on Server</h4> +<p></p> +<table border="0" class="table table-striped"> +<tr class="a"> +<th>Title</th> +<th>Import API</th></tr> +<tr class="b"> +<td><i>Example</i></td> +<td>See Examples sections below.</td></tr> +<tr class="a"> +<td><i>Description</i></td> +<td>Provide the path of the file to be imported.</td></tr> +<tr class="b"> +<td><i>URL</i></td> +<td><i>api/atlas/admin/importfile</i></td></tr> +<tr class="a"> +<td><i>Method</i></td> +<td><i>POST</i></td></tr> +<tr class="b"> +<td><i>URL Parameters</i></td> +<td><i>None</i></td></tr> +<tr class="a"> +<td><i>Data Parameters</i></td> +<td><i>None</i></td></tr> +<tr class="b"> +<td><i>Success Response</i></td> +<td><i>AtlasImporResult</i> is returned as JSON. See details below.</td></tr> +<tr class="a"> +<td><i>Error Response</i></td> +<td>Errors that are handled within the system will be returned as <i>AtlasBaseException</i>.</td></tr> +<tr class="b"> +<td><i>Notes</i></td> +<td>The file to be imported needs to be present on the server at the location specified by the <i>FILENAME</i> parameter.</td></tr></table><b><i>Method Signature for Import</i></b> +<div class="source"><pre class="prettyprint"> +@POST +@Path("/import") +@Produces("application/json; charset=UTF-8") +@Consumes("multipart/form-data") + +</pre></div> +<p><b><i>Method Signature for Import File</i></b></p> +<div class="source"><pre class="prettyprint"> +@POST +@Path("/importfile") +@Produces("application/json; charset=UTF-8") +@Consumes("application/json") + +</pre></div> +<p><b><i>Import Options</i></b> Please see <b><i><a href="./Import-API-Options.html">here</a></i></b> for the available options during import process.</p> +<p><b><i>AtlasImportResult Response</i></b> The API will return the results of the import operation in the format defined by the <i>AtlasImportResult</i>:</p> +<ul> +<li><i>AtlasImportParameters</i>: This contains a collection of name value pair of the options that are applied during the import operation.</li> +<li><i>Metrics</i>: Operation metrics. These include details on the number of types imported, number of entities imported, etc.</li> +<li><i>Processed Entities</i>: Contains list of GUIDs for the entities that were processed.</li> +<li><i>Operation Status</i>: Overall status of the operation. Values are <i>SUCCESS</i>, PARTIAL_SUCCESS, <i>FAIL</i>.</li></ul></div> +<div class="section"> +<h4><a name="Examples_Using_CURL_Calls"></a>Examples Using CURL Calls</h4> +<p>The call below performs Import of <i>QuickStart</i> database using POST.</p> +<div class="source"><pre class="prettyprint"> +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" + -H "Cache-Control: no-cache" + -F [email protected] + -F [email protected] + "http://localhost:21000/api/atlas/admin/import" + +</pre></div> +<p>The <i>request</i> parameter is optional. If import has to be run without any options use:</p> +<div class="source"><pre class="prettyprint"> +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" + -H "Cache-Control: no-cache" + -F [email protected] + "http://localhost:21000/api/atlas/admin/import" + +</pre></div> +<p>The call below performs Import of <i>QuickStart</i> database using a ZIP file available on server.</p> +<div class="source"><pre class="prettyprint"> +curl -X POST -u adminuser:password -H "Cache-Control: no-cache" -d ./importOptions.json +"http://localhost:21000/api/atlas/admin/importFile" > quickStartDB-import-result.json + +</pre></div> +<p>Below is the <i>AtlasImportResult</i> JSON for an import that contains <i>hive</i>db_.</p> +<p>The <i>processedEntities</i> contains the <i>guids</i> of all the entities imported.</p> +<p>The <i>metrics</i> contain a breakdown of the types and entities imported along with the operation performed on them viz. <i>created</i> or <i>updated</i>.</p> +<div class="source"><pre class="prettyprint"> +{ + "request": { + "options": {} + }, + "userName": "admin", + "clientIpAddress": "10.0.2.2", + "hostName": "10.0.2.15", + "timeStamp": 1491285622823, + "metrics": { + "duration": 9143, + "typedef:enum": 0, + "typedef:struct": 0, + "entity:hive_column:created": 461, + "entity:hive_storagedesc:created": 20, + "entity:hive_process:created": 12, + "entity:hive_db:created": 5, + "entity:hive_table:created": 20, + "entity:hdfs_path:created": 2, + "typedef:entitydef": 0, + "typedef:classification": 3 + }, + "processedEntities": [ + "2c4aa713-030b-4fb3-98b1-1cab23d9ac81", + "e4aa71ed-70fd-4fa7-9dfb-8250a573e293", + + ... + + "ea0f9bdb-1dfc-4e48-9848-a006129929f9", + "b5e2cb41-3e7d-4468-84e1-d87c320e75f9" + ], + "operationStatus": "SUCCESS" +} + +</pre></div></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright é 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/Import-Export-API.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/Import-Export-API.html b/1.0.0-alpha/Import-Export-API.html new file mode 100644 index 0000000..469fba2 --- /dev/null +++ b/1.0.0-alpha/Import-Export-API.html @@ -0,0 +1,159 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/Import-Export-API.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Export & Import REST APIs</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Export & Import REST APIs</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h2><a name="Export_.26_Import_REST_APIs"></a>Export & Import REST APIs</h2></div> +<div class="section"> +<h4><a name="Background"></a>Background</h4> +<p>The Import-Export APIs for Atlas facilitate transfer of data to and from a cluster that has Atlas provisioned.</p> +<p>The APIs when integrated with backup and/or disaster recovery process will ensure participation of Atlas.</p></div> +<div class="section"> +<h4><a name="Introduction"></a>Introduction</h4> +<p>There are 2 broad categories viz. Export & Import. The details of the APIs are discussed below.</p> +<p>The APIs are available only to <i>admin</i> user.</p> +<p>Only a single import or export operation can be performed at a given time. The operations have a potential for generating large amount. They can also put pressure on resources. This restriction tries to alleviate this problem.</p> +<p>For Import-Export APIs relating to HDFS path, can be found <a href="./Import-Export-HDFS-Path.html">here</a>.</p> +<p>For additional information please refer to the following:</p> +<ul> +<li><a class="externalLink" href="https://issues.apache.org/jira/browse/ATLAS-1503";>ATLAS-1503</a> Original Import-Export API requirements.</li> +<li><a class="externalLink" href="https://issues.apache.org/jira/browse/ATLAS-1618";>ATLAS-1618</a> Export API Scope Specification.</li></ul></div> +<div class="section"> +<h4><a name="Errors"></a>Errors</h4> +<p>If an import or export operation is initiated while another is in progress, the consumer will receive this error:</p> +<div class="source"><pre class="prettyprint"> +"ATLAS5005E": "Another import or export is in progress. Please try again." + +</pre></div> +<p>Unhandled errors will be returned as Internal error code 500.</p></div> +<div class="section"> +<h3><a name="REST_API_Reference"></a>REST API Reference</h3> +<p></p> +<ul> +<li><b><i><a href="./Export-API.html">Export</a></i></b></li> +<li><b><i><a href="./Export-HDFS-API.html">Export HDFS</a></i></b></li> +<li><b><i><a href="./Import-API.html">Import</a></i></b></li> +<li><b><i><a href="./Import-API-Options.html">Import Options</a></i></b></li></ul></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright é 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/InstallationSteps.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/InstallationSteps.html b/1.0.0-alpha/InstallationSteps.html new file mode 100644 index 0000000..e0ea4af --- /dev/null +++ b/1.0.0-alpha/InstallationSteps.html @@ -0,0 +1,415 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/InstallationSteps.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Building & Installing Apache Atlas</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Building & Installing Apache Atlas</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h3><a name="Building_.26_Installing_Apache_Atlas"></a>Building & Installing Apache Atlas</h3></div> +<div class="section"> +<h4><a name="Building_Atlas"></a>Building Atlas</h4> +<div class="source"><pre class="prettyprint"> +git clone https://git-wip-us.apache.org/repos/asf/atlas.git atlas +cd atlas +export MAVEN_OPTS="-Xms2g -Xmx2g" +mvn clean -DskipTests install +</pre></div></div> +<div class="section"> +<h4><a name="Packaging_Atlas"></a>Packaging Atlas</h4> +<p>To create Apache Atlas package for deployment in an environment having functional HBase and Solr instances, build with the following command:</p> +<div class="source"><pre class="prettyprint"> +mvn clean -DskipTests package -Pdist +</pre></div> +<p></p> +<ul> +<li>NOTES: +<ul> +<li>Remove option '-DskipTests' to run unit and integration tests</li> +<li>To build a distribution without minified js,css file, build with skipMinify profile. By default js and css files are minified.</li></ul></li></ul> +<p>Above will build Atlas for an environment having functional HBase and Solr instances. Atlas needs to be setup with the following to run in this environment:</p> +<ul> +<li>Configure atlas.graph.storage.hostname (see "Graph persistence engine - HBase" in the <a href="./Configuration.html">Configuration</a> section).</li> +<li>Configure atlas.graph.index.search.solr.zookeeper-url (see "Graph Search Index - Solr" in the <a href="./Configuration.html">Configuration</a> section).</li> +<li>Set HBASE_CONF_DIR to point to a valid HBase config directory (see "Graph persistence engine - HBase" in the <a href="./Configuration.html">Configuration</a> section).</li> +<li>Create the SOLR indices (see "Graph Search Index - Solr" in the <a href="./Configuration.html">Configuration</a> section).</li></ul></div> +<div class="section"> +<h4><a name="Packaging_Atlas_with_Embedded_HBase_.26_Solr"></a>Packaging Atlas with Embedded HBase & Solr</h4> +<p>To create Apache Atlas package that includes HBase and Solr, build with the embedded-hbase-solr profile as shown below:</p> +<div class="source"><pre class="prettyprint"> +mvn clean -DskipTests package -Pdist,embedded-hbase-solr +</pre></div> +<p>Using the embedded-hbase-solr profile will configure Atlas so that an HBase instance and a Solr instance will be started and stopped along with the Atlas server by default.</p></div> +<div class="section"> +<h4><a name="Apache_Atlas_Package"></a>Apache Atlas Package</h4> +<p>Build will create following files, which are used to install Apache Atlas.</p> +<div class="source"><pre class="prettyprint"> +distro/target/apache-atlas-${project.version}-bin.tar.gz +distro/target/apache-atlas-${project.version}-hive-hook.gz +distro/target/apache-atlas-${project.version}-hbase-hook.tar.gz +distro/target/apache-atlas-${project.version}-sqoop-hook.tar.gz +distro/target/apache-atlas-${project.version}-storm-hook.tar.gz +distro/target/apache-atlas-${project.version}-falcon-hook.tar.gz +distro/target/apache-atlas-${project.version}-sources.tar.gz +</pre></div></div> +<div class="section"> +<h4><a name="Installing_.26_Running_Atlas"></a>Installing & Running Atlas</h4></div> +<div class="section"> +<h5><a name="Installing_Atlas"></a>Installing Atlas</h5> +<div class="source"><pre class="prettyprint"> +tar -xzvf apache-atlas-${project.version}-bin.tar.gz + +cd atlas-${project.version} +</pre></div></div> +<div class="section"> +<h5><a name="Configuring_Atlas"></a>Configuring Atlas</h5> +<p>By default config directory used by Atlas is {package dir}/conf. To override this set environment variable ATLAS_CONF to the path of the conf dir.</p> +<p>Environment variables needed to run Atlas can be set in atlas-env.sh file in the conf directory. This file will be sourced by Atlas scripts before any commands are executed. The following environment variables are available to set.</p> +<div class="source"><pre class="prettyprint"> +# The java implementation to use. If JAVA_HOME is not found we expect java and jar to be in path +#export JAVA_HOME= + +# any additional java opts you want to set. This will apply to both client and server operations +#export ATLAS_OPTS= + +# any additional java opts that you want to set for client only +#export ATLAS_CLIENT_OPTS= + +# java heap size we want to set for the client. Default is 1024MB +#export ATLAS_CLIENT_HEAP= + +# any additional opts you want to set for atlas service. +#export ATLAS_SERVER_OPTS= + +# java heap size we want to set for the atlas server. Default is 1024MB +#export ATLAS_SERVER_HEAP= + +# What is is considered as atlas home dir. Default is the base location of the installed software +#export ATLAS_HOME_DIR= + +# Where log files are stored. Defatult is logs directory under the base install location +#export ATLAS_LOG_DIR= + +# Where pid files are stored. Defatult is logs directory under the base install location +#export ATLAS_PID_DIR= + +# Where do you want to expand the war file. By Default it is in /server/webapp dir under the base install dir. +#export ATLAS_EXPANDED_WEBAPP_DIR= +</pre></div> +<p><b>Settings to support large number of metadata objects</b></p> +<p>If you plan to store large number of metadata objects, it is recommended that you use values tuned for better GC performance of the JVM.</p> +<p>The following values are common server side options:</p> +<div class="source"><pre class="prettyprint"> +export ATLAS_SERVER_OPTS="-server -XX:SoftRefLRUPolicyMSPerMB=0 -XX:+CMSClassUnloadingEnabled -XX:+UseConcMarkSweepGC -XX:+CMSParallelRemarkEnabled -XX:+PrintTenuringDistribution -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=dumps/atlas_server.hprof -Xloggc:logs/gc-worker.log -verbose:gc -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=1m -XX:+PrintGCDetails -XX:+PrintHeapAtGC -XX:+PrintGCTimeStamps" +</pre></div> +<p>The <tt>-XX:SoftRefLRUPolicyMSPerMB</tt> option was found to be particularly helpful to regulate GC performance for query heavy workloads with many concurrent users.</p> +<p>The following values are recommended for JDK 8:</p> +<div class="source"><pre class="prettyprint"> +export ATLAS_SERVER_HEAP="-Xms15360m -Xmx15360m -XX:MaxNewSize=5120m -XX:MetaspaceSize=100M -XX:MaxMetaspaceSize=512m" +</pre></div> +<p><b>NOTE for Mac OS users</b> If you are using a Mac OS, you will need to configure the ATLAS_SERVER_OPTS (explained above).</p> +<p>In {package dir}/conf/atlas-env.sh uncomment the following line</p> +<div class="source"><pre class="prettyprint"> +#export ATLAS_SERVER_OPTS= +</pre></div> +<p>and change it to look as below</p> +<div class="source"><pre class="prettyprint"> +export ATLAS_SERVER_OPTS="-Djava.awt.headless=true -Djava.security.krb5.realm= -Djava.security.krb5.kdc=" +</pre></div> +<p><b>HBase as the Storage Backend for the Graph Repository</b></p> +<p>By default, Atlas uses <a href="./JanusGraph.html">JanusGraph</a> as the graph repository and is the only graph repository implementation available currently. The HBase versions currently supported are 1.1.x. For configuring ATLAS graph persistence on HBase, please see "Graph persistence engine - HBase" in the <a href="./Configuration.html">Configuration</a> section for more details.</p> +<p>HBase tables used by Atlas can be set using the following configurations:</p> +<div class="source"><pre class="prettyprint"> +atlas.graph.storage.hbase.table=atlas +atlas.audit.hbase.tablename=apache_atlas_entity_audit +</pre></div> +<p><b>Configuring SOLR as the Indexing Backend for the Graph Repository</b></p> +<p>By default, Atlas uses <a href="./JanusGraph.html">JanusGraph</a> as the graph repository and is the only graph repository implementation available currently. For configuring <a href="./JanusGraph.html">JanusGraph</a> to work with Solr, please follow the instructions below</p> +<p></p> +<ul> +<li>Install solr if not already running. The version of SOLR supported is 5.5.1. Could be installed from <a class="externalLink" href="http://archive.apache.org/dist/lucene/solr/5.5.1/solr-5.5.1.tgz";>http://archive.apache.org/dist/lucene/solr/5.5.1/solr-5.5.1.tgz</a></li></ul> +<p></p> +<ul> +<li>Start solr in cloud mode.</li></ul>SolrCloud mode uses a ZooKeeper Service as a highly available, central location for cluster management. For a small cluster, running with an existing ZooKeeper quorum should be fine. For larger clusters, you would want to run separate multiple ZooKeeper quorum with atleast 3 servers. Note: Atlas currently supports solr in "cloud" mode only. "http" mode is not supported. For more information, refer solr documentation - <a class="externalLink" href="https://cwiki.apache.org/confluence/display/solr/SolrCloud";>https://cwiki.apache.org/confluence/display/solr/SolrCloud</a> +<p></p> +<ul> +<li>For e.g., to bring up a Solr node listening on port 8983 on a machine, you can use the command:</li></ul> +<div class="source"><pre class="prettyprint"> + $SOLR_HOME/bin/solr start -c -z <zookeeper_host:port> -p 8983 + +</pre></div> +<p></p> +<ul> +<li>Run the following commands from SOLR_BIN (e.g. $SOLR_HOME/bin) directory to create collections in Solr corresponding to the indexes that Atlas uses. In the case that the ATLAS and SOLR instance are on 2 different hosts, first copy the required configuration files from ATLAS_HOME/conf/solr on the ATLAS instance host to the Solr instance host. SOLR_CONF in the below mentioned commands refer to the directory where the solr configuration files have been copied to on Solr host:</li></ul> +<div class="source"><pre class="prettyprint"> + $SOLR_BIN/solr create -c vertex_index -d SOLR_CONF -shards #numShards -replicationFactor #replicationFactor + $SOLR_BIN/solr create -c edge_index -d SOLR_CONF -shards #numShards -replicationFactor #replicationFactor + $SOLR_BIN/solr create -c fulltext_index -d SOLR_CONF -shards #numShards -replicationFactor #replicationFactor +</pre></div> +<p>Note: If numShards and replicationFactor are not specified, they default to 1 which suffices if you are trying out solr with ATLAS on a single node instance. Otherwise specify numShards according to the number of hosts that are in the Solr cluster and the maxShardsPerNode configuration. The number of shards cannot exceed the total number of Solr nodes in your !SolrCloud cluster.</p> +<p>The number of replicas (replicationFactor) can be set according to the redundancy required.</p> +<p>Also note that solr will automatically be called to create the indexes when the Atlas server is started if the SOLR_BIN and SOLR_CONF environment variables are set and the search indexing backend is set to 'solr5'.</p> +<p></p> +<ul> +<li>Change ATLAS configuration to point to the Solr instance setup. Please make sure the following configurations are set to the below values in ATLAS_HOME/conf/atlas-application.properties</li></ul> +<div class="source"><pre class="prettyprint"> + atlas.graph.index.search.backend=solr5 + atlas.graph.index.search.solr.mode=cloud + atlas.graph.index.search.solr.zookeeper-url=<the ZK quorum setup for solr as comma separated value> eg: 10.1.6.4:2181,10.1.6.5:2181 + atlas.graph.index.search.solr.zookeeper-connect-timeout=<SolrCloud Zookeeper Connection Timeout>. Default value is 60000 ms + atlas.graph.index.search.solr.zookeeper-session-timeout=<SolrCloud Zookeeper Session Timeout>. Default value is 60000 ms +</pre></div> +<p></p> +<ul> +<li>Restart Atlas</li></ul> +<p>For more information on <a href="./JanusGraph.html">JanusGraph</a> solr configuration , please refer <a class="externalLink" href="http://docs.janusgraph.org/0.2.0/solr.html";>http://docs.janusgraph.org/0.2.0/solr.html</a></p> +<p>Pre-requisites for running Solr in cloud mode * Memory - Solr is both memory and CPU intensive. Make sure the server running Solr has adequate memory, CPU and disk. Solr works well with 32GB RAM. Plan to provide as much memory as possible to Solr process * Disk - If the number of entities that need to be stored are large, plan to have at least 500 GB free space in the volume where Solr is going to store the index data * SolrCloud has support for replication and sharding. It is highly recommended to use SolrCloud with at least two Solr nodes running on different servers with replication enabled. If using SolrCloud, then you also need ZooKeeper installed and configured with 3 or 5 ZooKeeper nodes</p> +<p><b>Configuring Kafka Topics</b></p> +<p>Atlas uses Kafka to ingest metadata from other components at runtime. This is described in the <a href="./Architecture.html">Architecture page</a> in more detail. Depending on the configuration of Kafka, sometimes you might need to setup the topics explicitly before using Atlas. To do so, Atlas provides a script <tt>bin/atlas_kafka_setup.py</tt> which can be run from the Atlas server. In some environments, the hooks might start getting used first before Atlas server itself is setup. In such cases, the topics can be run on the hosts where hooks are installed using a similar script <tt>hook-bin/atlas_kafka_setup_hook.py</tt>. Both these use configuration in <tt>atlas-application.properties</tt> for setting up the topics. Please refer to the <a href="./Configuration.html">Configuration page</a> for these details.</p></div> +<div class="section"> +<h5><a name="Setting_up_Atlas"></a>Setting up Atlas</h5> +<p>There are a few steps that setup dependencies of Atlas. One such example is setting up the <a href="./JanusGraph.html">JanusGraph</a> schema in the storage backend of choice. In a simple single server setup, these are automatically setup with default configuration when the server first accesses these dependencies.</p> +<p>However, there are scenarios when we may want to run setup steps explicitly as one time operations. For example, in a multiple server scenario using <a href="./HighAvailability.html">High Availability</a>, it is preferable to run setup steps from one of the server instances the first time, and then start the services.</p> +<p>To run these steps one time, execute the command <tt>bin/atlas_start.py -setup</tt> from a single Atlas server instance.</p> +<p>However, the Atlas server does take care of parallel executions of the setup steps. Also, running the setup steps multiple times is idempotent. Therefore, if one chooses to run the setup steps as part of server startup, for convenience, then they should enable the configuration option <tt>atlas.server.run.setup.on.start</tt> by defining it with the value <tt>true</tt> in the <tt>atlas-application.properties</tt> file.</p></div> +<div class="section"> +<h5><a name="Starting_Atlas_Server"></a>Starting Atlas Server</h5> +<div class="source"><pre class="prettyprint"> +bin/atlas_start.py [-port <port>] +</pre></div></div> +<div class="section"> +<h4><a name="Using_Atlas"></a>Using Atlas</h4> +<p></p> +<ul> +<li>Verify if the server is up and running</li></ul> +<div class="source"><pre class="prettyprint"> + curl -v -u username:password http://localhost:21000/api/atlas/admin/version + {"Version":"v0.1"} +</pre></div> +<p></p> +<ul> +<li>Access Atlas UI using a browser: <a class="externalLink" href="http://localhost:21000";>http://localhost:21000</a></li></ul> +<p></p> +<ul> +<li>Run quick start to load sample model and data</li></ul> +<div class="source"><pre class="prettyprint"> + bin/quick_start.py [<atlas endpoint>] +</pre></div> +<p></p> +<ul> +<li>List the types in the repository</li></ul> +<div class="source"><pre class="prettyprint"> + curl -v -u username:password http://localhost:21000/api/atlas/v2/types/typedefs/headers + [ {"guid":"fa421be8-c21b-4cf8-a226-fdde559ad598","name":"Referenceable","category":"ENTITY"}, + {"guid":"7f3f5712-521d-450d-9bb2-ba996b6f2a4e","name":"Asset","category":"ENTITY"}, + {"guid":"84b02fa0-e2f4-4cc4-8b24-d2371cd00375","name":"DataSet","category":"ENTITY"}, + {"guid":"f93975d5-5a5c-41da-ad9d-eb7c4f91a093","name":"Process","category":"ENTITY"}, + {"guid":"79dcd1f9-f350-4f7b-b706-5bab416f8206","name":"Infrastructure","category":"ENTITY"} + ] +</pre></div> +<p></p> +<ul> +<li>List the instances for a given type</li></ul> +<div class="source"><pre class="prettyprint"> + curl -v -u username:password http://localhost:21000/api/atlas/v2/search/basic?typeName=hive_db + { + "queryType":"BASIC", + "searchParameters":{ + "typeName":"hive_db", + "excludeDeletedEntities":false, + "includeClassificationAttributes":false, + "includeSubTypes":true, + "includeSubClassifications":true, + "limit":100, + "offset":0 + }, + "entities":[ + { + "typeName":"hive_db", + "guid":"5d900c19-094d-4681-8a86-4eb1d6ffbe89", + "status":"ACTIVE", + "displayText":"default", + "classificationNames":[], + "attributes":{ + "owner":"public", + "createTime":null, + "qualifiedName":"default@cl1", + "name":"default", + "description":"Default Hive database" + } + }, + { + "typeName":"hive_db", + "guid":"3a0b14b0-ab85-4b65-89f2-e418f3f7f77c", + "status":"ACTIVE", + "displayText":"finance", + "classificationNames":[], + "attributes":{ + "owner":"hive", + "createTime":null, + "qualifiedName":"finance@cl1", + "name":"finance", + "description":null + } + } + ] + } +</pre></div> +<p></p> +<ul> +<li>Search for entities</li></ul> +<div class="source"><pre class="prettyprint"> + curl -v -u username:password http://localhost:21000/api/atlas/v2/search/dsl?query=hive_db%20where%20name='default' + { + "queryType":"DSL", + "queryText":"hive_db where name='default'", + "entities":[ + { + "typeName":"hive_db", + "guid":"5d900c19-094d-4681-8a86-4eb1d6ffbe89", + "status":"ACTIVE", + "displayText":"default", + "classificationNames":[], + "attributes":{ + "owner":"public", + "createTime":null, + "qualifiedName":"default@cl1", + "name":"default", + "description": + "Default Hive database" + } + } + ] + } +</pre></div></div> +<div class="section"> +<h4><a name="Stopping_Atlas_Server"></a>Stopping Atlas Server</h4> +<div class="source"><pre class="prettyprint"> +bin/atlas_stop.py +</pre></div></div> +<div class="section"> +<h4><a name="Troubleshooting"></a>Troubleshooting</h4></div> +<div class="section"> +<h5><a name="Setup_issues"></a>Setup issues</h5> +<p>If the setup of Atlas service fails due to any reason, the next run of setup (either by an explicit invocation of <tt>atlas_start.py -setup</tt> or by enabling the configuration option <tt>atlas.server.run.setup.on.start</tt>) will fail with a message such as <tt>A previous setup run may not have completed cleanly.</tt>. In such cases, you would need to manually ensure the setup can run and delete the Zookeeper node at <tt>/apache_atlas/setup_in_progress</tt> before attempting to run setup again.</p> +<p>If the setup failed due to HBase <a href="./JanusGraph.html">JanusGraph</a> schema setup errors, it may be necessary to repair the HBase schema. If no data has been stored, one can also disable and drop the HBase tables used by Atlas and run setup again.</p></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright é 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/Notification-Entity.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/Notification-Entity.html b/1.0.0-alpha/Notification-Entity.html new file mode 100644 index 0000000..38f1cef --- /dev/null +++ b/1.0.0-alpha/Notification-Entity.html @@ -0,0 +1,157 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/Notification-Entity.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Entity Change Notifications</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Entity Change Notifications</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h2><a name="Entity_Change_Notifications"></a>Entity Change Notifications</h2> +<p>To receive Atlas entity notifications a consumer should be obtained through the notification interface. Entity change notifications are sent every time a change is made to an entity. Operations that result in an entity change notification are:</p> +<ul> +<li><code>ENTITY_CREATE</code> - Create a new entity.</li> +<li><code>ENTITY_UPDATE</code> - Update an attribute of an existing entity.</li> +<li><code>TRAIT_ADD</code> - Add a trait to an entity.</li> +<li><code>TRAIT_DELETE</code> - Delete a trait from an entity.</li></ul> +<div class="source"><pre class="prettyprint"> + // Obtain provider through injection… + Provider<NotificationInterface> provider; + + // Get the notification interface + NotificationInterface notification = provider.get(); + + // Create consumers + List<NotificationConsumer<EntityNotification>> consumers = + notification.createConsumers(NotificationInterface.NotificationType.ENTITIES, 1); + +</pre></div> +<p>The consumer exposes the Iterator interface that should be used to get the entity notifications as they are posted. The hasNext() method blocks until a notification is available.</p> +<div class="source"><pre class="prettyprint"> + while(consumer.hasNext()) { + EntityNotification notification = consumer.next(); + + IReferenceableInstance entity = notification.getEntity(); + … + } + +</pre></div></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright é 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/1.0.0-alpha/QuickStart.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/QuickStart.html b/1.0.0-alpha/QuickStart.html new file mode 100644 index 0000000..93cff2f --- /dev/null +++ b/1.0.0-alpha/QuickStart.html @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/twiki/QuickStart.twiki at 2018-01-25 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180125" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Quick Start</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + </head> + <body class="topBarEnabled"> + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="About">About</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a></li> + <li><a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a></li> + <li><a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="project-info.html" title="Summary">Summary</a></li> + <li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li><a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a></li> + <li><a href="team-list.html" title="Team">Team</a></li> + <li><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li> + <li><a href="license.html" title="License">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/1.0.0-alpha/"; title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a></li> + <li><a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="1.0.0-alpha/index.html" title="1.0.0-alpha">1.0.0-alpha</a></li> + <li><a href="0.8.1/index.html" title="0.8.1">0.8.1</a></li> + <li><a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a></li> + <li><a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a></li> + <li><a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a></li> + <li><a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a></li> + <li><a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a></li> + <li><a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + </ul> + </li> + </ul> +<form id="search-form" action="https://www.google.com/search"; method="get" class="navbar-search pull-right" > + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <iframe src="https://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:100px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script> + <ul class="nav pull-right"><li style="margin-top: 10px;"> + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + </li></ul> + </div> + </div> + </div> + </div> + <div class="container"> + <div id="banner"> + <div class="pull-left"><a href=".." id="bannerLeft"><img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Atlas">Atlas</a><span class="divider">/</span></li> + <li class="active ">Quick Start</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li> + <li id="projectVersion" class="pull-right">Version: 1.0.0-alpha</li> + </ul> + </div> + <div id="bodyColumn" > +<div class="section"> +<h2><a name="Quick_Start"></a>Quick Start</h2></div> +<div class="section"> +<h3><a name="Introduction"></a>Introduction</h3> +<p>Quick start is a simple client that adds a few sample type definitions modeled after the example shown below. It also adds sample entities along with traits as shown in the instance graph below.</p></div> +<div class="section"> +<h4><a name="Example_Type_Definitions"></a>Example Type Definitions</h4> +<p><img src="images/twiki/guide-class-diagram.png" alt="" /></p></div> +<div class="section"> +<h4><a name="Example_Instance_Graph"></a>Example Instance Graph</h4> +<p><img src="images/twiki/guide-instance-graph.png" alt="" /></p></div> +<div class="section"> +<h3><a name="Running_the_example"></a>Running the example</h3> +<p>This will add sample types and instances along with traits as shown in the instance graph above.</p> +<p></p> +<ul> +<li>bin/quick-start.sh</li></ul></div> +<div class="section"> +<h3><a name="Dashboard"></a>Dashboard</h3> +<p>A simple dashboard with search is available.</p> +<p></p> +<ul> +<li><a class="externalLink" href="http://localhost:21000/";>http://localhost:21000/</a></li></ul></div> + </div> + </div> + <hr/> + <footer> + <div class="container"> + <div class="row"> +Copyright é 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. + </div> + <p id="poweredBy" class="pull-right"><a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +</p> + </div> + </footer> + </body> +</html>
