Author: lmccay
Date: Sat Apr 29 16:26:29 2017
New Revision: 1793215
URL: http://svn.apache.org/viewvc?rev=1793215&view=rev
Log:
some formatting and content changes to site page
Modified:
knox/site/index.html
knox/trunk/src/site/markdown/index.md
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1793215&r1=1793214&r2=1793215&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Sat Apr 29 16:26:29 2017
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20170429" />
<meta http-equiv="Content-Language" content="en" />
- <title>Knox Gateway – REST API Gateway for the Apache Hadoop
Ecosystem</title>
+ <title>Knox Gateway – REST API and Application Gateway for the
Apache Hadoop Ecosystem</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" />
@@ -354,21 +354,29 @@ distributed under the License is distrib
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><a name="REST_API_Gateway_for_the_Apache_Hadoop_Ecosystem"></a>REST API
Gateway for the Apache Hadoop Ecosystem</h2>
-<p>The Apache Knox Gateway is a REST API Gateway for interacting with Apache
Hadoop clusters.</p>
-<p>The Knox Gateway provides a single access point for all REST interactions
with Apache 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>
+<h2><a
name="REST_API_and_Application_Gateway_for_the_Apache_Hadoop_Ecosystem"></a>REST
API and Application Gateway for the Apache Hadoop Ecosystem</h2>
+<p>The Apache Knox Gateway is an Application Gateway for interacting with the
REST APIs and UIs of Apache Hadoop deployments.</p>
+<p>The Knox Gateway provides a single access point for all REST and HTTP
interactions with Apache Hadoop clusters.</p>
+<p>Knox delivers three groups of user facing services:</p>
+<p><img src="http://knox.apache.org/images/knox-services.png"; alt="Services"
style="width: 600px;" /></p>
<ul>
-<li>Authentication (LDAP and Active Directory Authentication Provider)</li>
+<li>
+<p><b>Proxying Services</b><br /> Primary goals of the Apache Knox project is
to provide access to Apache Hadoop via proxying of HTTP resources.</p></li>
-<li>Federation/SSO (HTTP Header Based Identity Federation)</li>
+<li>
+<p><b>Authentication Services</b><br /> Authentication for REST API access as
well as WebSSO flow for UIs. LDAP/AD, Header based PreAuth, Kerberos, SAML,
OAuth are all available options.</p></li>
-<li>Authorization (Service Level Authorization)</li>
-
-<li>Auditing</li>
-</ul>
+<li>
+<p><b>Client Services</b><br /> Client development can be done with scripting
through DSL or using the Knox Shell classes directly as SDK.</p></li>
+</ul></div>
+<div class="section">
+<h2><a name="Overview"></a>Overview</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 Apache 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<br /> cluster
for purposes of routing and translation between user facing URLs and cluster
internals.</p>
+<p>Each Apache Hadoop cluster that is protected by Knox has its set of REST
APIs represented by a single cluster specific<br /> application context path.
This allows the Knox Gateway to both protect multiple clusters and present<br
/> the REST API consumer with a single endpoint for access to all of the
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 Apache 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>
<p>While there are a number of benefits for unsecured Apache 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 Apache Hadoop
cluster,<br /> the Knox Gateway provides the enterprise with a solution
that:</p>
@@ -379,22 +387,14 @@ limitations under the License. --><div c
<li>Protects the details of the 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>
-<p><img src="http://knox.apache.org/images/knox-services.png"; alt="alt text"
/></p></div>
-<div class="section">
-<h2><a name="Overview"></a>Overview</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 Apache 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<br /> cluster
for purposes of routing and translation between user facing URLs and cluster
internals.</p>
-<p>Each Apache Hadoop cluster that is protected by Knox has its set of REST
APIs represented by a single cluster specific<br /> application context path.
This allows the Knox Gateway to both protect multiple clusters and present<br
/> the REST API consumer with a single endpoint for access to all of the
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 Apache 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>
+</ul></div>
<div class="section">
<h2><a name="Supported_Apache_Hadoop_Services"></a>Supported Apache Hadoop
Services</h2>
<p>The following Apache Hadoop services have integrations with the Knox
Gateway:</p>
-<p>Ambari<br /> WebHDFS (HDFS)<br /> Templeton (HCatalog)<br /> Stargate
(HBase)<br /> Oozie<br /> Hive/JDBC<br /> Yarn RM<br /> Storm<br /></p></div>
+<p>Ambari<br /> WebHDFS (HDFS)<br /> Templeton (HCatalog)<br /> Stargate
(HBase)<br /> Oozie<br /> Hive/JDBC<br /> Yarn RM<br /> Storm<br /> Gremlin<br
/> Avatica/Phoenix<br /></p></div>
<div class="section">
<h2><a name="Supported_Apache_Hadoop_UIs"></a>Supported Apache Hadoop UIs</h2>
-<p>Name Node UI<br /> Job History UI<br /> Oozie UI<br /> HBase UI<br /> Yarn
UI<br /> Spark UI<br /> Ambari UI<br /> Ranger Admin Console<br /></p></div>
+<p>Name Node UI<br /> Job History UI<br /> Oozie UI<br /> HBase UI<br /> Yarn
UI<br /> Spark UI<br /> Ambari UI<br /> Ranger Admin Console<br /> Zeppelin<br
/></p></div>
<div class="section">
<h2><a name="Configuring_Support_for_new_services_and_UIs"></a>Configuring
Support for new services and UIs</h2>
<p>Apache Knox provides a configuration driven method of adding new routing
services.<br /> This enables for new Apache Hadoop REST APIs to come on board
very quickly and easily. It also enables<br /> users and developers to add
support for custom REST APIs to the Knox gateway as well.<br /> This capability
was added in release 0.6.0 and furthers the Knox commitment to extensibility
and integration.</p></div>
Modified: knox/trunk/src/site/markdown/index.md
URL:
http://svn.apache.org/viewvc/knox/trunk/src/site/markdown/index.md?rev=1793215&r1=1793214&r2=1793215&view=diff
==============================================================================
--- knox/trunk/src/site/markdown/index.md (original)
+++ knox/trunk/src/site/markdown/index.md Sat Apr 29 16:26:29 2017
@@ -14,36 +14,26 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY
See the License for the specific language governing permissions and
limitations under the License.
-->
-REST API Gateway for the Apache Hadoop Ecosystem
+REST API and Application Gateway for the Apache Hadoop Ecosystem
------------
-The Apache Knox Gateway is a REST API Gateway for interacting with Apache
Hadoop
-clusters.
+The Apache Knox Gateway is an Application Gateway for interacting with the
REST APIs and UIs
+of Apache Hadoop deployments.
-The Knox Gateway provides a single access point for all REST interactions with
Apache Hadoop
+The Knox Gateway provides a single access point for all REST and HTTP
interactions with Apache Hadoop
clusters.
-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.
-
-* Authentication (LDAP and Active Directory Authentication Provider)
-* Federation/SSO (HTTP Header Based Identity Federation)
-* Authorization (Service Level Authorization)
-* Auditing
+Knox delivers three groups of user facing services:
-While there are a number of benefits for unsecured Apache Hadoop
clusters,<br/> the Knox Gateway also
-complements the kerberos secured cluster quite nicely.
-
-Coupled with proper network isolation of a Kerberos secured Apache Hadoop
cluster,<br/> the Knox Gateway
-provides the enterprise with a solution that:
+<img src="http://knox.apache.org/images/knox-services.png"; alt="Services"
style="width: 600px;"/>
-* Integrates well with enterprise identity management solutions
-* Protects the details of the cluster deployment (hosts and ports are hidden
from endusers)
-* Simplifies the number of services that clients need to interact with
+* **Proxying Services**<br/>
+Primary goals of the Apache Knox project is to provide access to Apache Hadoop
via proxying of HTTP resources.
-
+* **Authentication Services**<br/>
+Authentication for REST API access as well as WebSSO flow for UIs. LDAP/AD,
Header based PreAuth, Kerberos, SAML, OAuth are all available options.
-
+* **Client Services**<br/>
+Client development can be done with scripting through DSL or using the Knox
Shell classes directly as SDK.
Overview
------------
@@ -65,6 +55,16 @@ Simply by writing a topology deployment
new Apache 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.
+While there are a number of benefits for unsecured Apache Hadoop
clusters,<br/> the Knox Gateway also
+complements the kerberos secured cluster quite nicely.
+
+Coupled with proper network isolation of a Kerberos secured Apache Hadoop
cluster,<br/> the Knox Gateway
+provides the enterprise with a solution that:
+
+* Integrates well with enterprise identity management solutions
+* Protects the details of the cluster deployment (hosts and ports are hidden
from endusers)
+* Simplifies the number of services that clients need to interact with
+
## Supported Apache Hadoop Services
The following Apache Hadoop services have integrations with the Knox Gateway:
@@ -76,6 +76,8 @@ Oozie<br/>
Hive/JDBC<br/>
Yarn RM<br/>
Storm<br/>
+Gremlin<br/>
+Avatica/Phoenix<br/>
## Supported Apache Hadoop UIs
Name Node UI<br/>
@@ -86,6 +88,7 @@ Yarn UI<br/>
Spark UI<br/>
Ambari UI<br/>
Ranger Admin Console<br/>
+Zeppelin<br/>
## Configuring Support for new services and UIs
Apache Knox provides a configuration driven method of adding new routing
services.<br/>
![http://knox.apache.org/images/knox-services.png"](http://knox.apache.org/images/knox-services.png"){kind=link}
![http://knox.apache.org/images/knox-overview.gif"](http://knox.apache.org/images/knox-overview.gif"){kind=link}
