http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/Import-Export-API.html ---------------------------------------------------------------------- diff --git a/Import-Export-API.html b/Import-Export-API.html index d337d21..469fba2 100644 --- a/Import-Export-API.html +++ b/Import-Export-API.html @@ -1,221 +1,118 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-08-09 - | Rendered using Apache Maven Fluido Skin 1.3.0 + | 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="20170809" /> + <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.3.0.min.css" /> + <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.3.0.min.js"></script> - - - -<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> - - </head> - <body class="topBarEnabled"> - - - - - + <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"> + <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><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"> + <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><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"> + <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/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><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"> + <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> <ul class="dropdown-menu"> - - <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><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"> + <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><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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > - + </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" src="http://www.google.com/coop/cse/brand?form=search-form";></script> - - - - - - <iframe src="http://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"; +<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:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> - - <script type="text/javascript" src="https://apis.google.com/js/plusone.js";></script> - - <ul class="nav pull-right"><li style="margin-top: 10px;"> - + 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> - + </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="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> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="index.html" title="Atlas"> - Atlas</a> - </li> - <li class="divider ">/</li> - <li class="">Export & Import REST APIs</li> - - - - <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> - - </ul> + <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__Import_REST_APIs"></a>Export & Import REST APIs</h2></div> +<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> @@ -233,8 +130,7 @@ <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> +<div class="source"><pre class="prettyprint"> "ATLAS5005E": "Another import or export is in progress. Please try again." </pre></div> @@ -247,27 +143,17 @@ <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> - + </div> + </div> <hr/> - <footer> - <div class="container"> - <div class="row span12">Copyright © 2015-2017 - <a href="http://www.apache.org";>Apache Software Foundation</a>. - All Rights Reserved. - + <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> - - - <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/InstallationSteps.html ---------------------------------------------------------------------- diff --git a/InstallationSteps.html b/InstallationSteps.html index 71bdec4..e0ea4af 100644 --- a/InstallationSteps.html +++ b/InstallationSteps.html @@ -1,339 +1,177 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-08-09 - | Rendered using Apache Maven Fluido Skin 1.3.0 + | 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="20170809" /> + <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.3.0.min.css" /> + <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.3.0.min.js"></script> - - - -<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> - - </head> - <body class="topBarEnabled"> - - - - - + <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"> + <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><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"> + <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><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"> + <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/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><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"> + <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> <ul class="dropdown-menu"> - - <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><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"> + <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><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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > - + </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" src="http://www.google.com/coop/cse/brand?form=search-form";></script> - - - - - - <iframe src="http://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"; +<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:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> - - <script type="text/javascript" src="https://apis.google.com/js/plusone.js";></script> - - <ul class="nav pull-right"><li style="margin-top: 10px;"> - + 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> - + </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="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> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="index.html" title="Atlas"> - Atlas</a> - </li> - <li class="divider ">/</li> - <li class="">Building & Installing Apache Atlas</li> - - - - <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> - - </ul> + <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__Installing_Apache_Atlas"></a>Building & Installing Apache Atlas</h3></div> +<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> +<div class="source"><pre class="prettyprint"> git clone https://git-wip-us.apache.org/repos/asf/atlas.git atlas - cd atlas - -export MAVEN_OPTS="-Xmx1536m -XX:MaxPermSize=512m" && mvn clean install - -</pre></div> -<p>Once the build successfully completes, artifacts can be packaged for deployment.</p> -<div class="source"> -<pre> - -mvn clean package -Pdist - - -</pre></div> -<p>NOTE: 1. Use option '-DskipTests' to skip running unit and integration tests 2. Use option '-P perf' to instrument atlas to collect performance metrics</p> -<p>To build a distribution that configures Atlas for external HBase and Solr, build with the external-hbase-solr profile.</p> -<div class="source"> -<pre> - -mvn clean package -Pdist,external-hbase-solr - - +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>Note that when the external-hbase-solr profile is used the following steps need to be completed to make Atlas functional.</p> +<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> -<p>To build a distribution that packages HBase and Solr, build with the embedded-hbase-solr profile.</p> -<div class="source"> -<pre> - -mvn clean 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> -<p>Atlas also supports building a distribution that can use BerkeleyDB and Elastic search as the graph and index backends. To build a distribution that is configured for these backends, build with the berkeley-elasticsearch profile.</p> -<div class="source"> -<pre> - -mvn clean package -Pdist,berkeley-elasticsearch - - -</pre></div> -<p>An additional step is required for the binary built using this profile to be used along with the Atlas distribution. Due to licensing requirements, Atlas does not bundle the BerkeleyDB Java Edition in the tarball.</p> -<p>You can download the Berkeley DB jar file from the URL: <verbatim><a class="externalLink" href="http://download.oracle.com/otn/berkeley-db/je-5.0.73.zip";>http://download.oracle.com/otn/berkeley-db/je-5.0.73.zip</a></verbatim> and copy the je-5.0.73.jar to the ${atlas_home}/libext directory.</p> -<p>Tar can be found in atlas/distro/target/apache-atlas-${project.version}-bin.tar.gz</p> -<p>Tar is structured as follows</p> -<div class="source"> -<pre> - -|- bin - |- atlas_start.py - |- atlas_stop.py - |- atlas_config.py - |- quick_start.py - |- cputil.py -|- conf - |- atlas-application.properties - |- atlas-env.sh - |- hbase - |- hbase-site.xml.template - |- log4j.xml - |- solr - |- currency.xml - |- lang - |- stopwords_en.txt - |- protowords.txt - |- schema.xml - |- solrconfig.xml - |- stopwords.txt - |- synonyms.txt -|- docs -|- hbase - |- bin - |- conf - ... -|- server - |- webapp - |- atlas.war -|- solr - |- bin - ... -|- README -|- NOTICE -|- LICENSE -|- DISCLAIMER.txt -|- CHANGES.txt - - +<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>Note that if the embedded-hbase-solr profile is specified for the build then HBase and Solr are included in the distribution.</p> -<p>In this case, a standalone instance of HBase can be started as the default storage backend for the graph repository. During Atlas installation the conf/hbase/hbase-site.xml.template gets expanded and moved to hbase/conf/hbase-site.xml for the initial standalone HBase configuration. To configure ATLAS graph persistence for a different HBase instance, please see "Graph persistence engine - HBase" in the <a href="./Configuration.html">Configuration</a> section.</p> -<p>Also, a standalone instance of Solr can be started as the default search indexing backend. To configure ATLAS search indexing for a different Solr instance please see "Graph Search Index - Solr" in the <a href="./Configuration.html">Configuration</a> section.</p></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="Installing__Running_Atlas"></a>Installing & Running Atlas</h4></div> +<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> +<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>atlas-env.sh has been added to the Atlas conf. This file can be used to set various environment variables that you need for you services. In addition you can set any other environment variables you might need. 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> +<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= @@ -352,7 +190,7 @@ cd atlas-${project.version} # 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 locaion of the installed software +# 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 @@ -361,85 +199,58 @@ cd atlas-${project.version} # Where pid files are stored. Defatult is logs directory under the base install location #export ATLAS_PID_DIR= -# where the atlas titan db data is stored. Defatult is logs/data directory under the base install location -#export ATLAS_DATA_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 several tens of thousands of metadata objects, it is recommended that you use values tuned for better GC performance of the JVM.</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> +<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 7:</p> -<div class="source"> -<pre> -export ATLAS_SERVER_HEAP="-Xms15360m -Xmx15360m -XX:MaxNewSize=3072m -XX:PermSize=100M -XX:MaxPermSize=512m" - -</pre></div> <p>The following values are recommended for JDK 8:</p> -<div class="source"> -<pre> +<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> +<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> +<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 Titan 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>Pre-requisites for running HBase as a distributed cluster</p> -<ul> -<li>3 or 5 ZooKeeper nodes</li> -<li>Atleast 3 RegionServer nodes. It would be ideal to run the DataNodes on the same hosts as the Region servers for data locality.</li></ul> -<p>HBase tablename in Titan can be set using the following configuration in ATLAS_HOME/conf/atlas-application.properties:</p> -<div class="source"> -<pre> -atlas.graph.storage.hbase.table=apache_atlas_titan +<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 Titan as the graph repository and is the only graph repository implementation available currently. For configuring Titan to work with Solr, please follow the instructions below</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.2.1. Could be installed from <a class="externalLink" href="http://archive.apache.org/dist/lucene/solr/5.2.1/solr-5.2.1.tgz";>http://archive.apache.org/dist/lucene/solr/5.2.1/solr-5.2.1.tgz</a></li></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> +<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,</li></ul>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: -<div class="source"> -<pre> +<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> @@ -447,122 +258,158 @@ atlas.audit.hbase.tablename=apache_atlas_entity_audit <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> +<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 Titan solr configuration , please refer <a class="externalLink" href="http://s3.thinkaurelius.com/docs/titan/0.5.4/solr.htm";>http://s3.thinkaurelius.com/docs/titan/0.5.4/solr.htm</a></p> +<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 Titan 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>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> +<div class="source"><pre class="prettyprint"> bin/atlas_start.py [-port <port>] - -</pre></div> -<p>By default,</p> -<ul> -<li>To change the port, use -port option.</li> -<li>atlas server starts with conf from {package dir}/conf. To override this (to use the same conf with multiple atlas upgrades), set environment variable ATLAS_CONF to the path of conf dir</li></ul></div> +</pre></div></div> <div class="section"> <h4><a name="Using_Atlas"></a>Using Atlas</h4> <p></p> <ul> -<li>Quick start model - sample model and data</li></ul> -<div class="source"> -<pre> - bin/quick_start.py [<atlas endpoint>] - +<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>Verify if the server is up and running</li></ul> -<div class="source"> -<pre> - curl -v http://localhost:21000/api/atlas/admin/version - {"Version":"v0.1"} - +<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> - curl -v http://localhost:21000/api/atlas/types - {"results":["Process","Infrastructure","DataSet"],"count":3,"requestId":"1867493731@qtp-262860041-0 - 82d43a27-7c34-4573-85d1-a01525705091"} - +<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> - curl -v http://localhost:21000/api/atlas/entities?type=hive_table - {"requestId":"788558007@qtp-44808654-5","list":["cb9b5513-c672-42cb-8477-b8f3e537a162","ec985719-a794-4c98-b98f-0509bd23aac0","48998f81-f1d3-45a2-989a-223af5c1ed6e","a54b386e-c759-4651-8779-a099294244c4"]} - - curl -v http://localhost:21000/api/atlas/entities/list/hive_db - +<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 (instances) in the repository</li></ul> -<div class="source"> -<pre> - curl -v http://localhost:21000/api/atlas/discovery/search/dsl?query="from hive_table" - -</pre></div> -<p><b>Dashboard</b></p> -<p>Once atlas is started, you can view the status of atlas entities using the Web-based dashboard. You can open your browser at the corresponding port to use the web UI.</p></div> +<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> +<div class="source"><pre class="prettyprint"> bin/atlas_stop.py - </pre></div></div> <div class="section"> -<h4><a name="Known_Issues"></a>Known Issues</h4></div> +<h4><a name="Troubleshooting"></a>Troubleshooting</h4></div> <div class="section"> -<h5><a name="Setup"></a>Setup</h5> +<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 Titan 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 'titan' schema in HBase to let setup run again.</p></div> - </div> - </div> - +<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 span12">Copyright © 2015-2017 - <a href="http://www.apache.org";>Apache Software Foundation</a>. - All Rights Reserved. - + <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> - - - <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/Notification-Entity.html ---------------------------------------------------------------------- diff --git a/Notification-Entity.html b/Notification-Entity.html index 0316601..38f1cef 100644 --- a/Notification-Entity.html +++ b/Notification-Entity.html @@ -1,220 +1,117 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-08-09 - | Rendered using Apache Maven Fluido Skin 1.3.0 + | 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="20170809" /> + <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.3.0.min.css" /> + <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.3.0.min.js"></script> - - - -<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> - - </head> - <body class="topBarEnabled"> - - - - - + <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"> + <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><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"> + <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><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"> + <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/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><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"> + <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> <ul class="dropdown-menu"> - - <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><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"> + <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><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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > - + </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" src="http://www.google.com/coop/cse/brand?form=search-form";></script> - - - - - - <iframe src="http://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"; +<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:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> - - <script type="text/javascript" src="https://apis.google.com/js/plusone.js";></script> - - <ul class="nav pull-right"><li style="margin-top: 10px;"> - + 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> - + </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="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> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="index.html" title="Atlas"> - Atlas</a> - </li> - <li class="divider ">/</li> - <li class="">Entity Change Notifications</li> - - - - <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> - - </ul> + <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"> +<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> @@ -222,8 +119,7 @@ <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> +<div class="source"><pre class="prettyprint"> // Obtain provider through injection… Provider<NotificationInterface> provider; @@ -236,8 +132,7 @@ </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> +<div class="source"><pre class="prettyprint"> while(consumer.hasNext()) { EntityNotification notification = consumer.next(); @@ -246,27 +141,17 @@ } </pre></div></div> - </div> - </div> - + </div> + </div> <hr/> - <footer> - <div class="container"> - <div class="row span12">Copyright © 2015-2017 - <a href="http://www.apache.org";>Apache Software Foundation</a>. - All Rights Reserved. - + <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> - - - <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>
