You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by lm...@apache.org on 2014/08/20 00:37:12 UTC

svn commit: r1619004 - /knox/site/index.html

Author: lmccay
Date: Tue Aug 19 22:37:12 2014
New Revision: 1619004

URL: http://svn.apache.org/r1619004
Log:
reverting back to previous content

Modified:
    knox/site/index.html

Modified: knox/site/index.html
URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1619004&r1=1619003&r2=1619004&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Tue Aug 19 22:37:12 2014
@@ -1,17 +1,17 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2014-08-07 -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-    <title>Knox Gateway &#x2013; About</title>
-    <style type="text/css" media="all">
-      @import url("./css/maven-base.css");
-      @import url("./css/maven-theme.css");
-      @import url("./css/site.css");
-    </style>
-    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
-    <meta name="Date-Revision-yyyymmdd" content="20140807" />
-    <meta http-equiv="Content-Language" content="en" />
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jun 13, 2014 -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Knox Gateway - </title>
+    <style type="text/css" media="all">
+      @import url("./css/maven-base.css");
+      @import url("./css/maven-theme.css");
+      @import url("./css/site.css");
+    </style>
+    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+    <meta name="Date-Revision-yyyymmdd" content="20140613" />
+    <meta http-equiv="Content-Language" content="en" />
                                                     
 <script type="text/javascript">var _gaq = _gaq || [];
                 _gaq.push(['_setAccount', 'UA-27188762-1']);
@@ -25,158 +25,181 @@
                 '.google-analytics.com/ga.js';
                 var s = document.getElementsByTagName('script')[0];
                 s.parentNode.insertBefore(ga, s);
-                })();</script>
-                      
-        </head>
-  <body class="composite">
-    <div id="banner">
-                                      <a href="./" id="bannerLeft">
-                                                <img src="images/knox-logo.gif" alt="Knox Gateway" />
-                </a>
-                                            <a href="./" id="bannerRight">
-                                                <img src="images/apache-logo.gif" alt="Apache Incubator" />
-                </a>
-            <div class="clear">
-        <hr/>
-      </div>
-    </div>
-    <div id="breadcrumbs">
-            
-                    
-                <div class="xleft">
-                                  <a href="index.html" title="Knox">Knox</a>
-        &gt;
-    About
-      </div>
-            <div class="xright">                    <a href="https://git-wip-us.apache.org/repos/asf/knox.git" class="externalLink" title="Git">Git</a>
-            |
-                        <a href="https://svn.apache.org/repos/asf/knox" class="externalLink" title="Svn">Svn</a>
-            |
-                        <a href="https://issues.apache.org/jira/browse/KNOX" class="externalLink" title="Jira">Jira</a>
-            |
-                        <a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
-              
-                    
-                &nbsp;| <span id="publishDate">Last Published: 2014-08-07</span>
-              &nbsp;| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
-            </div>
-      <div class="clear">
-        <hr/>
-      </div>
-    </div>
-    <div id="leftColumn">
-      <div id="navcolumn">
-             
-                    
-                                <h5>Knox</h5>
-                  <ul>
-                  <li class="none">
-            <strong>Home</strong>
-          </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/News" class="externalLink" title="News">News</a>
-            </li>
-                  <li class="none">
-                          <a href="license.html" title="License">License</a>
-            </li>
-          </ul>
-                       <h5>Documentation</h5>
-                  <ul>
-                  <li class="none">
-                          <a href="books/knox-0-4-0/knox-0-4-0.html" title="User's Guide">User's Guide</a>
-            </li>
-                  <li class="none">
-                          <a href="books/knox-0-4-0/knox-0-4-0.html#Quick+Start" title="Quick Start">Quick Start</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Dependencies" class="externalLink" title="Dependencies">Dependencies</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
-            </li>
-          </ul>
-                       <h5>Releases</h5>
-                  <ul>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.4.0" class="externalLink" title="0.4.0">0.4.0</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.3.0" class="externalLink" title="0.3.0">0.3.0</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.2.0" class="externalLink" title="0.2.0">0.2.0</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Roadmap" class="externalLink" title="Roadmap">Roadmap</a>
-            </li>
-          </ul>
-                       <h5>Processes</h5>
-                  <ul>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Build+Process" class="externalLink" title="Build">Build</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+Process" class="externalLink" title="Release">Release</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process" class="externalLink" title="Contribute">Contribute</a>
-            </li>
-                  <li class="none">
-                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Site+Maintenance" class="externalLink" title="Site Maintenance">Site Maintenance</a>
-            </li>
-          </ul>
-                       <h5>Resources</h5>
-                  <ul>
-                  <li class="none">
-                          <a href="https://git-wip-us.apache.org/repos/asf/knox.git" class="externalLink" title="Product Source">Product Source</a>
-            </li>
-                  <li class="none">
-                          <a href="https://svn.apache.org/repos/asf/knox" class="externalLink" title="Site Source">Site Source</a>
-            </li>
-                  <li class="none">
-                          <a href="team-list.html" title="Project Team">Project Team</a>
-            </li>
-                  <li class="none">
-                          <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
-            </li>
-                  <li class="none">
-                          <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
-            </li>
-          </ul>
-                       <h5>ASF</h5>
-                  <ul>
-                  <li class="none">
-                          <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">How Apache Works</a>
-            </li>
-                  <li class="none">
-                          <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">Foundation</a>
-            </li>
-                  <li class="none">
-                          <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">Sponsoring Apache</a>
-            </li>
-                  <li class="none">
-                          <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
-            </li>
-          </ul>
-                             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
-        <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
-      </a>
-                   
-                    
-            </div>
-    </div>
-    <div id="bodyColumn">
-      <div id="contentBox">
-        <div class="section">
-<h2><a name="About_Apache_Knox_Gateway_Site"></a>About Apache Knox Gateway Site</h2><a name="About_Apache_Knox_Gateway_Site"></a>
-<p>Knox is a gateway for Hadoop clusters.</p></div>
-      </div>
-    </div>
-    <div class="clear">
-      <hr/>
-    </div>
-    <div id="footer">
-      <div class="xright">
+                })();</script>
+                      
+        </head>
+  <body class="composite">
+    <div id="banner">
+                                      <a href="./" id="bannerLeft">
+                                                <img src="images/knox-logo.gif" alt="Knox Gateway" />
+                </a>
+                                            <a href="./" id="bannerRight">
+                                                <img src="images/apache-logo.gif" alt="Apache Incubator" />
+                </a>
+            <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="breadcrumbs">
+            
+                    
+                <div class="xleft">
+                                  <a href="index.html" title="Knox">Knox</a>
+        &gt;
+    
+      </div>
+            <div class="xright">                    <a href="https://git-wip-us.apache.org/repos/asf/knox.git" class="externalLink" title="Git">Git</a>
+            |
+                        <a href="https://svn.apache.org/repos/asf/knox" class="externalLink" title="Svn">Svn</a>
+            |
+                        <a href="https://issues.apache.org/jira/browse/KNOX" class="externalLink" title="Jira">Jira</a>
+            |
+                        <a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
+              
+                    
+                &nbsp;| <span id="publishDate">Last Published: 2014-06-13</span>
+              &nbsp;| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
+            </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="leftColumn">
+      <div id="navcolumn">
+             
+                    
+                                <h5>Knox</h5>
+                  <ul>
+                  <li class="none">
+            <strong>Home</strong>
+          </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/News" class="externalLink" title="News">News</a>
+            </li>
+                  <li class="none">
+                          <a href="license.html" title="License">License</a>
+            </li>
+          </ul>
+                       <h5>Documentation</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="books/knox-0-4-0/knox-0-4-0.html" title="User's Guide">User's Guide</a>
+            </li>
+                  <li class="none">
+                          <a href="books/knox-0-4-0/knox-0-4-0.html#Quick+Start" title="Quick Start">Quick Start</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Dependencies" class="externalLink" title="Dependencies">Dependencies</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
+            </li>
+          </ul>
+                       <h5>Releases</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.4.0" class="externalLink" title="0.4.0">0.4.0</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.3.0" class="externalLink" title="0.3.0">0.3.0</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.2.0" class="externalLink" title="0.2.0">0.2.0</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Roadmap" class="externalLink" title="Roadmap">Roadmap</a>
+            </li>
+          </ul>
+                       <h5>Processes</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Build+Process" class="externalLink" title="Build">Build</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+Process" class="externalLink" title="Release">Release</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process" class="externalLink" title="Contribute">Contribute</a>
+            </li>
+                  <li class="none">
+                          <a href="https://cwiki.apache.org/confluence/display/KNOX/Site+Maintenance" class="externalLink" title="Site Maintenance">Site Maintenance</a>
+            </li>
+          </ul>
+                       <h5>Resources</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="https://git-wip-us.apache.org/repos/asf/knox.git" class="externalLink" title="Product Source">Product Source</a>
+            </li>
+                  <li class="none">
+                          <a href="https://svn.apache.org/repos/asf/knox" class="externalLink" title="Site Source">Site Source</a>
+            </li>
+                  <li class="none">
+                          <a href="team-list.html" title="Project Team">Project Team</a>
+            </li>
+                  <li class="none">
+                          <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+            </li>
+                  <li class="none">
+                          <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+            </li>
+          </ul>
+                       <h5>ASF</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">How Apache Works</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">Foundation</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">Sponsoring Apache</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
+            </li>
+          </ul>
+                             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+        <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+      </a>
+                   
+                    
+            </div>
+    </div>
+    <div id="bodyColumn">
+      <div id="contentBox">
+        <!-- -
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. --><div class="section"><h2>Introduction<a name="Introduction"></a></h2><p>The Apache Knox Gateway is a REST API Gateway for interacting with Hadoop clusters.</p><p>The Knox Gateway provides a single access point for all REST interactions with Hadoop clusters.</p><p>In this capacity, the Knox Gateway is able to provide valuable functionality to aid in the control,<br /> integration, monitoring and automation of critical administrative and analytical needs of the enterprise.</p>
+<ul>
+  <li>Authentication (LDAP and Active Directory Authentication Provider)</li>
+  <li>Federation/SSO (HTTP Header Based Identity Federation)</li>
+  <li>Authorization (Service Level Authorization)</li>
+  <li>Auditing</li>
+</ul><p>While there are a number of benefits for unsecured Hadoop clusters,<br /> the Knox Gateway also complements the kerberos secured cluster quite nicely.</p><p>Coupled with proper network isolation of a Kerberos secured Hadoop cluster,<br /> the Knox Gateway provides the enterprise with a solution that:</p>
+<ul>
+  <li>Integrates well with enterprise identity management solutions</li>
+  <li>Protects the details of the Hadoop cluster deployment (hosts and ports are hidden from endusers)</li>
+  <li>Simplifies the number of services that clients need to interact with</li>
+</ul><p><img src="http://knox.apache.org/images/knox-overview.gif" alt="alt text" /></p></div><div class="section"><h2>Overview<a name="Overview"></a></h2><p>The Knox API Gateway is designed as a reverse proxy with consideration for pluggability in the areas of<br /> policy enforcement, through providers and the backend services for which it proxies requests.</p><p>Policy enforcement ranges from authentication/federation, authorization, audit, dispatch, hostmapping<br /> and content rewrite rules. Policy is enforced through a chain of providers that are defined within the topology<br /> deployment descriptor for each Hadoop cluster gated by Knox. The cluster definition is also defined<br /> within the topology deployment descriptor and provides the Knox Gateway with the layout of the Hadoop<br /> cluster for purposes of routing and translation between user facing URLs and Hadoop cluster internals.</p><p>Each Hadoop cluster that is protected by Knox has its set of REST APIs represent
 ed by a single cluster specific<br /> application context path. This allows the Knox Gateway to both protect multiple Hadoop clusters and present<br /> the REST API consumer with a single endpoint for access to all of the Hadoop services required, across the<br /> multiple clusters.</p><p>Simply by writing a topology deployment descriptor to the topologies directory of the Knox installation, a<br /> new Hadoop cluster definition is processed, the policy enforcement providers are configured and the application<br /> context path is made available for use by API consumers.</p></div><div class="section"><h2>Supported Hadoop Services<a name="Supported_Hadoop_Services"></a></h2><p>The following Hadoop services have integrations with the Knox Gateway:</p><p>WebHDFS (HDFS)<br /> Templeton (HCatalog)<br /> Stargate (HBase)<br /> Oozie<br /> Hive/JDBC<br /></p></div><div class="section"><h2>Authentication<a name="Authentication"></a></h2><p>Providers with the role of authentication are respo
 nsible for collecting credentials presented by the API<br /> consumer, validating them and communicating the successful or failed authentication to the client or the<br /> rest of the provider chain.</p><p>Out of the box, the Knox Gateway provides the Shiro authentication provider. This is a provider that leverages<br /> the Apache Shiro project for authenticating BASIC credentials against an LDAP user store. There is support for<br /> OpenLDAP, ApacheDS and Microsoft Active Directory.</p></div><div class="section"><h2>Federation/SSO<a name="FederationSSO"></a></h2><p>For customers that require credentials to be presented to a limited set of trusted entities within the enterprise,<br /> the Knox Gateway may be configured to federate the authenticated identity from an external authentication event.<br /> This is done through providers with the role of federation. The out of the box federation provider is a simple<br /> mechanism for propagating the identity through HTTP Headers that 
 specify the username and group for the authenticated<br /> user. This has been built with vendor usecases such as SiteMinder and IBM Tivoli Access Manager.</p></div><div class="section"><h2>Authorization<a name="Authorization"></a></h2><p>The authorization role is used by providers that make access decisions for the requested resources based on the<br /> effective user identity context. This identity context is determined by the authentication provider and the identity<br /> assertion provider mapping rules. Evaluation of the identity contexts user and group principals against a set of<br /> access policies is done by the authorization provider in order to determine whether access should be granted to<br /> the effective user for the requested resource.</p><p>Out of the box, the Knox Gateway provides an ACL based authorization provider that evaluates rules that comprise<br /> of username, groups and ip addresses. These ACLs are bound to and protect resources at the service level.<br
  /> That is, they protect access to the Hadoop services themselves based on user, group and remote ip address.</p></div><div class="section"><h2>Audit<a name="Audit"></a></h2><p>The ability to determine what actions were taken by whom during some period of time is provided by the auditing<br /> capabilities of the Knox Gateway. The facility is built on an extension of the Log4j framework and may be extended<br /> by replacing the out of the box implementation with another.</p></div>
+      </div>
+    </div>
+    <div class="clear">
+      <hr/>
+    </div>
+    <div id="footer">
+      <div class="xright">
               <?xml version="1.0" encoding="UTF-8"?>
 <footer>
   <div class="row span12">Apache Knox Gateway, Apache, the Apache feather logo and the Apache Knox Gateway project logos
@@ -185,11 +208,11 @@
   <div class="row span12">
     <a href="https://cwiki.apache.org/confluence/display/KNOX/Privacy+Policy">Privacy Policy</a>
   </div>
-</footer>
-            </div>
-      <div class="clear">
-        <hr/>
-      </div>
-    </div>
-  </body>
-</html>
+</footer>
+            </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+  </body>
+</html>