http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/Repository.html ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/Repository.html b/0.5.0-incubating/Repository.html new file mode 100644 index 0000000..61a0dde --- /dev/null +++ b/0.5.0-incubating/Repository.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-07-09 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<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="20150709" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metadata and Governance - Repository</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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"> + + + + + + <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/incubator-atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://svn.apache.org/repos/asf/incubator/atlas"; title="Svn">Svn</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="https://cwiki.apache.org/confluence/display/ATLAS"; title="Coming soon">Coming soon</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="index.html" title="current">current</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="Overview">Overview</a> +</li> + + <li> <a href="QuickStart.html" title="Getting Started">Getting Started</a> +</li> + + <li> <a href="Architecture.html" title="Architecture">Architecture</a> +</li> + + <li> <a href="InstallationSteps.html" title="Installation">Installation</a> +</li> + + <li> <a href="TypeSystem.html" title="Type System">Type System</a> +</li> + + <li> <a href="Configuration.html" title="Configuration">Configuration</a> +</li> + + <li> <a href="Security.html" title="Security">Security</a> +</li> + + <li> <a href="api/rest.html" title="Rest API">Rest API</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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.incubator.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.incubator.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;"> + + <div class="g-plusone" data-href="http://atlas.incubator.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"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </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="">Repository</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2015-07-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.5-incubating</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2>Repository<a name="Repository"></a></h2></div> +<div class="section"> +<h3>Introduction<a name="Introduction"></a></h3></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </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/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/Search.html ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/Search.html b/0.5.0-incubating/Search.html new file mode 100644 index 0000000..38d936f --- /dev/null +++ b/0.5.0-incubating/Search.html @@ -0,0 +1,343 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-07-09 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<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="20150709" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metadata and Governance - Search</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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"> + + + + + + <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/incubator-atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://svn.apache.org/repos/asf/incubator/atlas"; title="Svn">Svn</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="https://cwiki.apache.org/confluence/display/ATLAS"; title="Coming soon">Coming soon</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="index.html" title="current">current</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="Overview">Overview</a> +</li> + + <li> <a href="QuickStart.html" title="Getting Started">Getting Started</a> +</li> + + <li> <a href="Architecture.html" title="Architecture">Architecture</a> +</li> + + <li> <a href="InstallationSteps.html" title="Installation">Installation</a> +</li> + + <li> <a href="TypeSystem.html" title="Type System">Type System</a> +</li> + + <li> <a href="Configuration.html" title="Configuration">Configuration</a> +</li> + + <li> <a href="Security.html" title="Security">Security</a> +</li> + + <li> <a href="api/rest.html" title="Rest API">Rest API</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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.incubator.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.incubator.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;"> + + <div class="g-plusone" data-href="http://atlas.incubator.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"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </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="">Search</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2015-07-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.5-incubating</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2>Search<a name="Search"></a></h2> +<p>Atlas exposes search over the metadata in two ways:</p> +<ul> +<li>Search using DSL</li> +<li>Full-text search</li></ul></div> +<div class="section"> +<h3>Search DSL Grammar<a name="Search_DSL_Grammar"></a></h3> +<p>The DSL exposes an SQL like query language for searching the metadata based on the type system. The grammar for the DSL is below.</p> +<div class="source"> +<pre> +queryWithPath: query ~ opt(WITHPATH) + +query: rep1sep(singleQuery, opt(COMMA)) + +singleQuery: singleQrySrc ~ opt(loopExpression) ~ opt(selectClause) + +singleQrySrc = FROM ~ fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) | + WHERE ~ (expr ^? notIdExpression) | + expr ^? notIdExpression | + fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) + +fromSrc: identifier ~ AS ~ alias | identifier + +loopExpression: LOOP ~ (LPAREN ~> query <~ RPAREN) ~ opt(intConstant <~ TIMES) ~ opt(AS ~> alias) + +selectClause: SELECT ~ rep1sep(selectExpression, COMMA) + +selectExpression: expr ~ opt(AS ~> alias) + +expr: compE ~ opt(rep(exprRight)) + +exprRight: (AND | OR) ~ compE + +compE: + arithE ~ (LT | LTE | EQ | NEQ | GT | GTE) ~ arithE | + arithE ~ (ISA | IS) ~ ident | + arithE ~ HAS ~ ident | + arithE + +arithE: multiE ~ opt(rep(arithERight)) + +arithERight: (PLUS | MINUS) ~ multiE + +multiE: atomE ~ opt(rep(multiERight)) + +multiERight: (STAR | DIV) ~ atomE + +atomE: literal | identifier | LPAREN ~> expr <~ RPAREN + +identifier: rep1sep(ident, DOT) + +alias: ident | stringLit + +literal: booleanConstant | + intConstant | + longConstant | + floatConstant | + doubleConstant | + stringLit + +</pre></div> +<p>Grammar language: {noformat} opt(a) => a is optional ~ => a combinator. 'a ~ b' means a followed by b rep => zero or more rep1sep => one or more, separated by second arg. {noformat}</p> +<p>Language Notes:</p> +<ul> +<li>A <b><a href="./SingleQuery.html">SingleQuery</a></b> expression can be used to search for entities of a <i>Trait</i> or <i>Class</i>.</li></ul>Entities can be filtered based on a 'Where Clause' and Entity Attributes can be retrieved based on a 'Select Clause'. +<ul> +<li>An Entity Graph can be traversed/joined by combining one or more <a href="./SingleQueries.html">SingleQueries</a>.</li> +<li>An attempt is made to make the expressions look SQL like by accepting keywords "SELECT",</li></ul>"FROM", and "WHERE"; but these are optional and users can simply think in terms of Entity Graph Traversals. +<ul> +<li>The transitive closure of an Entity relationship can be expressed via the <i>Loop</i> expression. A</li></ul><i>Loop</i> expression can be any traversal (recursively a query) that represents a <i>Path</i> that ends in an Entity of the same <i>Type</i> as the starting Entity. +<ul> +<li>The <i><a href="./WithPath.html">WithPath</a></i> clause can be used with transitive closure queries to retrieve the Path that</li></ul>connects the two related Entities. (We also provide a higher level interface for Closure Queries see scaladoc for 'org.apache.metadata.query.ClosureQuery') +<ul> +<li>There are couple of Predicate functions different from SQL: +<ul> +<li><i>is</i> or <i>isa</i>can be used to filter Entities that have a particular Trait.</li> +<li><i>has</i> can be used to filter Entities that have a value for a particular Attribute.</li></ul></li></ul></div> +<div class="section"> +<h4>DSL Examples<a name="DSL_Examples"></a></h4> +<p></p> +<ul> +<li>from DB</li> +<li>DB where name="Reporting" select name, owner</li> +<li>DB has name</li> +<li>DB is <a href="./JdbcAccess.html">JdbcAccess</a></li> +<li>Column where Column isa PII</li> +<li>Table where name="sales_fact", columns</li> +<li>Table where name="sales_fact", columns as column select column.name, column.dataType, column.comment</li></ul></div> +<div class="section"> +<h3>Full-text Search<a name="Full-text_Search"></a></h3> +<p>Atlas also exposes a lucene style full-text search capability.</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </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/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/Security.html ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/Security.html b/0.5.0-incubating/Security.html new file mode 100644 index 0000000..5df87ba --- /dev/null +++ b/0.5.0-incubating/Security.html @@ -0,0 +1,323 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-07-09 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<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="20150709" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metadata and Governance - Security Features of Apache Atlas</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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"> + + + + + + <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/incubator-atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://svn.apache.org/repos/asf/incubator/atlas"; title="Svn">Svn</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="https://cwiki.apache.org/confluence/display/ATLAS"; title="Coming soon">Coming soon</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="index.html" title="current">current</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="Overview">Overview</a> +</li> + + <li> <a href="QuickStart.html" title="Getting Started">Getting Started</a> +</li> + + <li> <a href="Architecture.html" title="Architecture">Architecture</a> +</li> + + <li> <a href="InstallationSteps.html" title="Installation">Installation</a> +</li> + + <li> <a href="TypeSystem.html" title="Type System">Type System</a> +</li> + + <li> <a href="Configuration.html" title="Configuration">Configuration</a> +</li> + + <li> <a href="Security.html" title="Security">Security</a> +</li> + + <li> <a href="api/rest.html" title="Rest API">Rest API</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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.incubator.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.incubator.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;"> + + <div class="g-plusone" data-href="http://atlas.incubator.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"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </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="">Security Features of Apache Atlas</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2015-07-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.5-incubating</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2>Security Features of Apache Atlas<a name="Security_Features_of_Apache_Atlas"></a></h2></div> +<div class="section"> +<h3>Overview<a name="Overview"></a></h3> +<p>The following features are available for enhancing the security of the platform:</p> +<ul> +<li>SSL</li> +<li>Service Authentication</li> +<li>SPNEGO-based HTTP Authentication</li></ul></div> +<div class="section"> +<h4>SSL<a name="SSL"></a></h4> +<p>Both SSL one-way (server authentication) and two-way (server and client authentication) are supported. The following application properties (properties configured in the application.properties file) are available for configuring SSL:</p> +<p></p> +<ul> +<li><code>atlas.enableTLS</code> (false|true) [default: false] - enable/disable the SSL listener</li> +<li><code>keystore.file</code> - the path to the keystore file leveraged by the server. This file contains the server certificate.</li> +<li><code>truststore.file</code> - the path to the truststore file. This file contains the certificates of other trusted entities (e.g. the certificates for client processes if two-way SSL is enabled). In most instances this can be set to the same value as the keystore.file property (especially if one-way SSL is enabled).</li> +<li><code>client.auth.enabled</code> (false|true) [default: false] - enable/disable client authentication. If enabled, the client will have to authenticate to the server during the transport session key creation process (i.e. two-way SSL is in effect).</li> +<li><code>cert.stores.credential.provider.path</code> - the path to the Credential Provider store file. The passwords for the keystore, truststore, and server certificate are maintained in this secure file. Utilize the cputil script in the 'bin' directoy (see below) to populate this file with the passwords required.</li></ul></div> +<div class="section"> +<h5>Credential Provider Utility Script<a name="Credential_Provider_Utility_Script"></a></h5> +<p>In order to prevent the use of clear-text passwords, the Atlas platofrm makes use of the Credential Provider facility for secure password storage (see <a class="externalLink" href="http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/CommandsManual.html#credential";>Hadoop Credential Command Reference</a> for more information about this facility). The cputil script in the 'bin' directory can be leveraged to create the password store required.</p> +<p>To create the credential provdier for Atlas:</p> +<p></p> +<ul> +<li><code>bin</code>' directory</li> +<li><code>./cputil.sh</code>'</li> +<li>Enter the path for the generated credential provider. The format for the path is: +<ul> +<li><a class="externalLink" href="jceks://file/local/file/path/file.jceks">jceks://file/local/file/path/file.jceks</a> or <a class="externalLink" href="jceks://hdfs@namenodehost:port/path/in/hdfs/to/file.jceks.">jceks://hdfs@namenodehost:port/path/in/hdfs/to/file.jceks.</a> The files generally use the ".jceks" extension (e.g. test.jceks)</li></ul></li> +<li>Enter the passwords for the keystore, truststore, and server key (these passwords need to match the ones utilized for actually creating the associated certificate store files).</li></ul> +<p>The credential provider will be generated and saved to the path provided.</p></div> +<div class="section"> +<h4>Service Authentication<a name="Service_Authentication"></a></h4> +<p>The Atlas platform, upon startup, is associated to an authenticated identity. By default, in an insecure environment, that identity is the same as the OS authenticated user launching the server. However, in a secure cluster leveraging kerberos, it is considered a best practice to configure a keytab and principal in order for the platform to authenticate to the KDC. This allows the service to subsequently interact with other secure cluster services (e.g. HDFS).</p> +<p>The properties for configuring service authentication are:</p> +<p></p> +<ul> +<li><code>atlas.authentication.method</code> (simple|kerberos) [default: simple] - the authentication method to utilize. Simple will leverage the OS authenticated identity and is the default mechanism. 'kerberos' indicates that the service is required to authenticate to the KDC leveraging the configured keytab and principal.</li> +<li><code>atlas.authentication.keytab</code> - the path to the keytab file.</li> +<li><code>atlas.authentication.principal</code> - the principal to use for authenticating to the KDC. The principal is generally of the form "user/host@realm". You may use the '_HOST' token for the hostname and the local hostname will be substituted in by the runtime (e.g. "Atlas/[email protected]").</li></ul></div> +<div class="section"> +<h4>SPNEGO-based HTTP Authentication<a name="SPNEGO-based_HTTP_Authentication"></a></h4> +<p>HTTP access to the Atlas platform can be secured by enabling the platform's SPNEGO support. There are currently two supported authentication mechanisms:</p> +<p></p> +<ul> +<li><code>simple</code> - authentication is performed via a provided user name</li> +<li><code>kerberos</code> - the KDC authenticated identity of the client is leveraged to authenticate to the server</li></ul> +<p>The kerberos support requires the client accessing the server to first authenticate to the KDC (usually this is done via the 'kinit' command). Once authenticated, the user may access the server (the authenticated identity will be related to the server via the SPNEGO negotiation mechanism).</p> +<p>The properties for configuring the SPNEGO support are:</p> +<p></p> +<ul> +<li><code>atlas.http.authentication.enabled</code> (true|false) [default: false] - a property indicating whether to enable HTTP authentication</li> +<li><code>atlas.http.authentication.type</code> (simple|kerberos) [default: simple] - the authentication type</li> +<li><code>atlas.http.authentication.kerberos.principal</code> - the web-application Kerberos principal name. The Kerberos principal name must start with "HTTP/...". For example: "HTTP/localhost@LOCALHOST". There is no default value.</li> +<li><code>atlas.http.authentication.kerberos.keytab</code> - the path to the keytab file containing the credentials for the kerberos principal.</li></ul> +<p>For a more detailed discussion of the HTTP authentication mechanism refer to <a class="externalLink" href="http://hadoop.apache.org/docs/stable/hadoop-auth/Configuration.html";>Hadoop Auth, Java HTTP SPNEGO 2.6.0 - Server Side Configuration</a>. The prefix that document references is "atlas.http.authentication" in the case of the Atlas authentication implementation.</p></div> +<div class="section"> +<h4>Client security configuration<a name="Client_security_configuration"></a></h4> +<p>When leveraging Atlas client code to communicate with an Atlas server configured for SSL transport and/or Kerberos authentication, there is a requirement to provide a client configuration file that provides the security properties that allow for communication with, or authenticating to, the server. Create a client.properties file with the appropriate settings (see below) and place it on the client's classpath or in the directory specified by the "atlas.conf" system property.</p> +<p>The client properties for SSL communication are:</p> +<p></p> +<ul> +<li><code>atlas.enableTLS</code> (false|true) [default: false] - enable/disable the SSL client communication infrastructure.</li> +<li><code>keystore.file</code> - the path to the keystore file leveraged by the client. This file is only required if 2-Way SSL is enabled at the server and contains the client certificate.</li> +<li><code>truststore.file</code> - the path to the truststore file. This file contains the certificates of trusted entities (e.g. the certificates for the server or a shared certification authority). This file is required for both one-way or two-way SSL.</li> +<li><code>cert.stores.credential.provider.path</code> - the path to the Credential Provider store file. The passwords for the keystore, truststore, and client certificate are maintained in this secure file.</li></ul> +<p>The property required for authenticating to the server (if authentication is enabled):</p> +<p></p> +<ul> +<li><code>atlas.http.authentication.type</code> (simple|kerberos) [default: simple] - the authentication type</li></ul> +<p>If the authentication type specified is 'kerberos', then the kerberos ticket cache will be accessed for authenticating to the server (Therefore the client is required to authenticate to the KDC prior to communication with the server using 'kinit' or a similar mechanism).</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </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/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/TypeSystem.html ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/TypeSystem.html b/0.5.0-incubating/TypeSystem.html new file mode 100644 index 0000000..80a3d84 --- /dev/null +++ b/0.5.0-incubating/TypeSystem.html @@ -0,0 +1,278 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-07-09 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<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="20150709" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metadata and Governance - Type System</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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"> + + + + + + <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/incubator-atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://svn.apache.org/repos/asf/incubator/atlas"; title="Svn">Svn</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="https://cwiki.apache.org/confluence/display/ATLAS"; title="Coming soon">Coming soon</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="index.html" title="current">current</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="Overview">Overview</a> +</li> + + <li> <a href="QuickStart.html" title="Getting Started">Getting Started</a> +</li> + + <li> <a href="Architecture.html" title="Architecture">Architecture</a> +</li> + + <li> <a href="InstallationSteps.html" title="Installation">Installation</a> +</li> + + <li> <a href="TypeSystem.html" title="Type System">Type System</a> +</li> + + <li> <a href="Configuration.html" title="Configuration">Configuration</a> +</li> + + <li> <a href="Security.html" title="Security">Security</a> +</li> + + <li> <a href="api/rest.html" title="Rest API">Rest API</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="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.incubator.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.incubator.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;"> + + <div class="g-plusone" data-href="http://atlas.incubator.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"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </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="">Type System</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2015-07-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.5-incubating</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2>Type System<a name="Type_System"></a></h2></div> +<div class="section"> +<h3>Introduction<a name="Introduction"></a></h3></div> +<div class="section"> +<h3>Overview<a name="Overview"></a></h3></div> +<div class="section"> +<h4>Data Types Overview<a name="Data_Types_Overview"></a></h4> +<p><img src="data-types.png" alt="" /></p></div> +<div class="section"> +<h4>Types Instances Overview<a name="Types_Instances_Overview"></a></h4> +<p><img src="types-instances.png" alt="" /></p></div> +<div class="section"> +<h3>Details<a name="Details"></a></h3> +<p>### Structs are like C structs - they don't have an identity - no independent lifecycle - like a bag of properties - like in hive, also</p> +<p>### Classes are classes - like any OO class - have identity - can have inheritence - can contain structs - don't necessarily need to use a struct inside the class to define props - can also define props using <a href="./AttributeDefinition.html">AttributeDefinition</a> using the basic data types - classes are immutable once created</p> +<p>### On search interface: - can search for all instances of a class - classes could become tables in a relational system, for instance - also databases, columns, etc.</p> +<p>### Traits is similar to scala - traits more like decorators (?) - traits get applied to instances - not classes - this satisfies the classification mechanism (ish) - can have a class instance have any number of traits - e.g. security clearance - any Person class could have it; so we add it as a mixin to the Person class - security clearance trait has a level attribute - traits are labels - each label can have its own attribute - reason for doing this is: - modeled security clearance trait - want to prescribe it to other things, too - can now search for anything that has security clearance level = 1, for instance</p> +<p>### On Instances: - class, trait, struct all have bags of attributes - can get name of type associated with attribute - can get or set the attribute in that bag for each instance</p> +<p>### On Classification: - create column as a class - create a trait to classify as "PHI" - would create the instance of the column with the PHI trait - apply traits to instances - CAN'T apply traits to class</p> +<p>### Other useful information</p> +<p><a href="./HierarchicalClassType.html">HierarchicalClassType</a> - base type for <a href="./ClassType.html">ClassType</a> and <a href="./TraitType.html">TraitType</a> Instances created from Definitions</p> +<p>Every instance is referenceable - i.e. something can point to it in the graph db <a href="./MetadataService.html">MetadataService</a> may not be used longterm - it is currently used for bootstrapping the repo & type system</p> +<p>Id class - represents the Id of an instance</p> +<p>When the web service receives an object graph, the <a href="./ObjectGraphWalker.html">ObjectGraphWalker</a> is used to update things - <a href="./DiscoverInstances.html">DiscoverInstances</a> is used to discover the instances in the object graph received by the web service</p> +<p><a href="./MapIds.html">MapIds</a> assigns new ids to the discovered instances in the object graph</p> +<p>Anything under the storage package is not part of the public interface</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </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/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/api/apple-touch-icon.png ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/api/apple-touch-icon.png b/0.5.0-incubating/api/apple-touch-icon.png new file mode 100644 index 0000000..6d2fc39 Binary files /dev/null and b/0.5.0-incubating/api/apple-touch-icon.png differ http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/api/application.wadl ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/api/application.wadl b/0.5.0-incubating/api/application.wadl new file mode 100644 index 0000000..d4685cb --- /dev/null +++ b/0.5.0-incubating/api/application.wadl @@ -0,0 +1,402 @@ +<?xml version="1.0" encoding="UTF-8"?> +<wadl:application xmlns:wadl="http://wadl.dev.java.net/2009/02"; xmlns:xs="http://www.w3.org/2001/XMLSchema";> + <wadl:doc xmlns:enunciate="http://enunciate.codehaus.org/"; enunciate:generatedBy="Enunciate-1.29"/> + <wadl:grammars/> + <wadl:resources base="http://localhost:8080/atlas-webapp";> + <wadl:resource path="/api/atlas/entities"> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Submits an entity definition (instance) corresponding to a given type.]]> + </wadl:doc> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Gets the list of entities for a given entity type.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="type" style="query"> + <wadl:doc> + <![CDATA[name of a type which is unique]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/types"> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Submits a type definition corresponding to a given type representing a meta model of a +domain. Could represent things like Hive Database, Hive Table, etc.]]> + </wadl:doc> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Gets the list of trait type names registered in the type system.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="type" style="query"> + <wadl:doc> + <![CDATA[type should be the name of enum +org.apache.atlas.typesystem.types.DataTypes.TypeCategory +Typically, would be one of all, TRAIT, CLASS, ENUM, STRUCT]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[entity names response payload as json]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/stack"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the thread stack dump for this application.]]> + </wadl:doc> + <wadl:response> + <wadl:doc> + <![CDATA[json representing the thread stack dump.]]> + </wadl:doc> + <wadl:representation mediaType="text/plain"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/version"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the version for this application.]]> + </wadl:doc> + <wadl:response> + <wadl:doc> + <![CDATA[json representing the version.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using a given query.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in raw gremlin or DSL format falling back to full text.]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[GUID for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetch the complete definition of an entity given its GUID.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:doc> + <![CDATA[Adds property to the given entity id]]> + </wadl:doc> + <wadl:request> + <wadl:param name="property" style="query"> + <wadl:doc> + <![CDATA[property to add]]> + </wadl:doc> + </wadl:param> + <wadl:param name="value" style="query"> + <wadl:doc> + <![CDATA[property's value]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[response payload as json]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/graph/vertices"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Get a list of vertices matching a property key and a value. +<p/> +GET http://host/metadata/lineage/vertices?key=<key>&value=<value> +graph.getVertices(key, value);]]> + </wadl:doc> + <wadl:request> + <wadl:param name="key" style="query"/> + <wadl:param name="value" style="query"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/types/{typeName}"> + <wadl:param name="typeName" style="template"> + <wadl:doc> + <![CDATA[name of a type which is unique.]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetch the complete definition of a given type name which is unique.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/dsl"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using query DSL format.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in DSL format.]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/fulltext"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using full text search.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query.]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/gremlin"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using raw gremlin query format.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in raw gremlin format.]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traits"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Gets the list of trait names for a given entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:doc> + <![CDATA[a list of trait names for the given entity guid]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Adds a new trait to an existing entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/graph/edges/{id}"> + <wadl:param name="id" style="template"/> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Get a single edge with a unique id. + +GET http://host/metadata/lineage/edges/id +graph.getEdge(id);]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/graph/vertices/{id}"> + <wadl:param name="id" style="template"/> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Get a single vertex with a unique id. + +GET http://host/metadata/lineage/vertices/id +graph.getVertex(id);]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traits/{traitName}"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:param name="traitName" style="template"> + <wadl:doc> + <![CDATA[name of the trait]]> + </wadl:doc> + </wadl:param> + <wadl:method name="DELETE"> + <wadl:doc> + <![CDATA[Deletes a given trait from an existing entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/graph/vertices/properties/{id}"> + <wadl:param name="id" style="template"/> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Get properties for a single vertex with a unique id. +This is NOT a rexster API. +<p/> +GET http://host/metadata/lineage/vertices/properties/id]]> + </wadl:doc> + <wadl:request> + <wadl:param name="relationships" style="query"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/graph/vertices/{id}/{direction}"> + <wadl:param name="id" style="template"/> + <wadl:param name="direction" style="template"/> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Get a list of adjacent edges with a direction. + +GET http://host/metadata/lineage/vertices/id/direction +graph.getVertex(id).get{Direction}Edges(); +direction: {(?!outE)(?!bothE)(?!inE)(?!out)(?!both)(?!in)(?!query).+}]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/schema"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Return the schema for the given tableName.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/inputs/graph"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the inputs graph for a given entity.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/outputs/graph"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the outputs graph for a given entity.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + </wadl:resources> +</wadl:application> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/api/crossdomain.xml ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/api/crossdomain.xml b/0.5.0-incubating/api/crossdomain.xml new file mode 100644 index 0000000..0d42929 --- /dev/null +++ b/0.5.0-incubating/api/crossdomain.xml @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<!DOCTYPE cross-domain-policy SYSTEM "http://www.adobe.com/xml/dtds/cross-domain-policy.dtd";> +<cross-domain-policy> + + +<!-- Read this: www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html --> + +<!-- Most restrictive policy: --> + <site-control permitted-cross-domain-policies="none"/> + + + +<!-- Least restrictive policy: --> +<!-- + <site-control permitted-cross-domain-policies="all"/> + <allow-access-from domain="*" to-ports="*" secure="false"/> + <allow-http-request-headers-from domain="*" headers="*" secure="false"/> +--> +<!-- + If you host a crossdomain.xml file with allow-access-from domain=â*â + and donât understand all of the points described here, you probably + have a nasty security vulnerability. ~ simon willison +--> + +</cross-domain-policy> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/api/css/home.gif ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/api/css/home.gif b/0.5.0-incubating/api/css/home.gif new file mode 100644 index 0000000..49aa306 Binary files /dev/null and b/0.5.0-incubating/api/css/home.gif differ http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/0.5.0-incubating/api/css/prettify.css ---------------------------------------------------------------------- diff --git a/0.5.0-incubating/api/css/prettify.css b/0.5.0-incubating/api/css/prettify.css new file mode 100644 index 0000000..d44b3a2 --- /dev/null +++ b/0.5.0-incubating/api/css/prettify.css @@ -0,0 +1 @@ +.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee} \ No newline at end of file
