Added: knox/site/books/knox-1-1-0/warning.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/warning.png?rev=1823389&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-1-0/warning.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-1-1-0/workflow-configuration.xml
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/workflow-configuration.xml?rev=1823389&view=auto
==============================================================================
--- knox/site/books/knox-1-1-0/workflow-configuration.xml (added)
+++ knox/site/books/knox-1-1-0/workflow-configuration.xml Tue Feb 6 20:46:11
2018
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<configuration>
+ <property>
+ <name>jobTracker</name>
+ <value>REPLACE.JOBTRACKER.RPCHOSTPORT</value>
+ <!-- Example: <value>localhost:50300</value> -->
+ </property>
+ <property>
+ <name>nameNode</name>
+ <value>hdfs://REPLACE.NAMENODE.RPCHOSTPORT</value>
+ <!-- Example: <value>hdfs://localhost:8020</value> -->
+ </property>
+ <property>
+ <name>oozie.wf.application.path</name>
+ <value>hdfs://REPLACE.NAMENODE.RPCHOSTPORT/tmp/test</value>
+ <!-- Example: <value>hdfs://localhost:8020/tmp/test</value> -->
+ </property>
+ <property>
+ <name>user.name</name>
+ <value>mapred</value>
+ </property>
+ <property>
+ <name>inputDir</name>
+ <value>/tmp/test/input</value>
+ </property>
+ <property>
+ <name>outputDir</name>
+ <value>/tmp/test/output</value>
+ </property>
+</configuration>
Added: knox/site/books/knox-1-1-0/workflow-definition.xml
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/workflow-definition.xml?rev=1823389&view=auto
==============================================================================
--- knox/site/books/knox-1-1-0/workflow-definition.xml (added)
+++ knox/site/books/knox-1-1-0/workflow-definition.xml Tue Feb 6 20:46:11 2018
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<workflow-app xmlns="uri:oozie:workflow:0.2" name="wordcount-workflow">
+ <start to="root"/>
+ <action name="root">
+ <java>
+ <job-tracker>${jobTracker}</job-tracker>
+ <name-node>${nameNode}</name-node>
+ <main-class>org.apache.hadoop.examples.WordCount</main-class>
+ <arg>${inputDir}</arg>
+ <arg>${outputDir}</arg>
+ </java>
+ <ok to="end"/>
+ <error to="fail"/>
+ </action>
+ <kill name="fail">
+ <message>Java failed, error
message[${wf:errorMessage(wf:lastErrorNode())}]</message>
+ </kill>
+ <end name="end"/>
+</workflow-app>
\ No newline at end of file
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<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" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -94,21 +94,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -130,6 +130,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Modified: knox/site/issue-tracking.html
URL:
http://svn.apache.org/viewvc/knox/site/issue-tracking.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/issue-tracking.html (original)
+++ knox/site/issue-tracking.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Issue Tracking</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -96,21 +96,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -132,6 +132,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Modified: knox/site/license.html
URL:
http://svn.apache.org/viewvc/knox/site/license.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/license.html (original)
+++ knox/site/license.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -94,21 +94,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -130,6 +130,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Modified: knox/site/mail-lists.html
URL:
http://svn.apache.org/viewvc/knox/site/mail-lists.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/mail-lists.html (original)
+++ knox/site/mail-lists.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -96,21 +96,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -132,6 +132,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Modified: knox/site/project-info.html
URL:
http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -96,21 +96,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -132,6 +132,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Modified: knox/site/team-list.html
URL:
http://svn.apache.org/viewvc/knox/site/team-list.html?rev=1823389&r1=1823388&r2=1823389&view=diff
==============================================================================
--- knox/site/team-list.html (original)
+++ knox/site/team-list.html Tue Feb 6 20:46:11 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2018-01-03
+ | Generated by Apache Maven Doxia at 2018-02-06
| 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="20180103" />
+ <meta name="Date-Revision-yyyymmdd" content="20180206" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Team list</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -54,11 +54,11 @@
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.13.0</li>
+ <li id="projectVersion">Version: 1.0.0</li>
- <li id="publishDate" class="pull-right">Last Published:
2018-01-03</li>
+ <li id="publishDate" class="pull-right">Last Published:
2018-02-06</li>
</ul>
</div>
@@ -96,21 +96,21 @@
<li>
- <a href="books/knox-0-14-0/user-guide.html"
title="User's Guide">
+ <a href="books/knox-1-0-0/user-guide.html"
title="User's Guide">
<i class="none"></i>
User's Guide</a>
</li>
<li>
- <a href="books/knox-0-14-0/dev-guide.html"
title="Developer's Guide">
+ <a href="books/knox-1-0-0/dev-guide.html"
title="Developer's Guide">
<i class="none"></i>
Developer's Guide</a>
</li>
<li>
- <a
href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start">
+ <a
href="books/knox-1-0-0/user-guide.html#Quick+Start" title="Quick Start">
<i class="none"></i>
Quick Start</a>
</li>
@@ -132,6 +132,13 @@
<li>
+ <a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+1.0.0";
class="externalLink" title="1.0.0">
+ <i class="none"></i>
+ 1.0.0</a>
+ </li>
+
+ <li>
+
<a
href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0";
class="externalLink" title="0.14.0">
<i class="none"></i>
0.14.0</a>
Added: knox/trunk/books/1.0.0/admin_api.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.0.0/admin_api.md?rev=1823389&view=auto
==============================================================================
--- knox/trunk/books/1.0.0/admin_api.md (added)
+++ knox/trunk/books/1.0.0/admin_api.md Tue Feb 6 20:46:11 2018
@@ -0,0 +1,523 @@
+<!---
+ 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.
+--->
+
+### Admin API
+
+Access to the administrator functions of Knox are provided by the Admin REST
API.
+
+#### Admin API URL
+
+The URL mapping for the Knox Admin API is:
+
+| ------- |
-----------------------------------------------------------------------------
|
+| GatewayAPI |
`https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/v1`
|
+
+Please note that to access this API, the user attempting to connect must have
admin credentials configured on the LDAP Server
+
+
+##### API Documentation
+
+<table>
+ <thead>
+ <th>Resource</th>
+ <th>Operation</th>
+ <th>Description</th>
+ </thead>
+ <tr>
+ <td>version</td>
+ <td>GET</td>
+ <td>Get the gateway version and the associated version hash</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/version -H
Accept:application/json</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "ServerVersion" : {
+ "version" : "VERSION_ID",
+ "hash" : "VERSION_HASH"
+ }
+} </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>topologies</td>
+ <td>GET</td>
+ <td>Get an enumeration of the topologies currently deployed in the
gateway.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/topologies -H
Accept:application/json</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "topologies" : {
+ "topology" : [ {
+ "name" : "admin",
+ "timestamp" : "1501508536000",
+ "uri" : "https://localhost:8443/gateway/admin";,
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/topologies/admin";
+ }, {
+ "name" : "sandbox",
+ "timestamp" : "1501508536000",
+ "uri" : "https://localhost:8443/gateway/sandbox";,
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/topologies/sandbox";
+ } ]
+ }
+} </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>topologies/{id}</td>
+ <td>GET</td>
+ <td>Get a JSON representation of the specified topology</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/topologies/admin -H
Accept:application/json</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "name": "admin",
+ "providers": [{
+ "enabled": true,
+ "name": "ShiroProvider",
+ "params": {
+ "sessionTimeout": "30",
+ "main.ldapRealm": "org.apache.knox.gateway.shirorealm.KnoxLdapRealm",
+ "main.ldapRealm.userDnTemplate":
"uid={0},ou=people,dc=hadoop,dc=apache,dc=org",
+ "main.ldapRealm.contextFactory.url": "ldap://localhost:33389";,
+ "main.ldapRealm.contextFactory.authenticationMechanism": "simple",
+ "urls./**": "authcBasic"
+ },
+ "role": "authentication"
+ }, {
+ "enabled": true,
+ "name": "AclsAuthz",
+ "params": {
+ "knox.acl": "admin;*;*"
+ },
+ "role": "authorization"
+ }, {
+ "enabled": true,
+ "name": "Default",
+ "params": {},
+ "role": "identity-assertion"
+ }, {
+ "enabled": true,
+ "name": "static",
+ "params": {
+ "localhost": "sandbox,sandbox.hortonworks.com"
+ },
+ "role": "hostmap"
+ }],
+ "services": [{
+ "name": null,
+ "params": {},
+ "role": "KNOX",
+ "url": null
+ }],
+ "timestamp": 1406672646000,
+ "uri": "https://localhost:8443/gateway/admin";
+} </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td> </td>
+ <td>PUT</td>
+ <td>Add (and deploy) a topology</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/topologies/mytopology
\
+ -X PUT \
+ -H Content-Type:application/xml
+ -d "@mytopology.xml"</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<topology>
+ <uri>https://localhost:8443/gateway/mytopology</uri>
+ <name>mytopology</name>
+ <timestamp>1509720338000</timestamp>
+ <gateway>
+ <provider>
+ <role>authentication</role>
+ <name>ShiroProvider</name>
+ <enabled>true</enabled>
+ <param>
+ <name>sessionTimeout</name>
+ <value>30</value>
+ </param>
+ <param>
+ <name>main.ldapRealm</name>
+
<value>org.apache.knox.gateway.shirorealm.KnoxLdapRealm</value>
+ </param>
+ <param>
+ <name>main.ldapContextFactory</name>
+
<value>org.apache.knox.gateway.shirorealm.KnoxLdapContextFactory</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.contextFactory</name>
+ <value>$ldapContextFactory</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.userDnTemplate</name>
+
<value>uid={0},ou=people,dc=hadoop,dc=apache,dc=org</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.contextFactory.url</name>
+ <value>ldap://localhost:33389</value>
+ </param>
+ <param>
+
<name>main.ldapRealm.contextFactory.authenticationMechanism</name>
+ <value>simple</value>
+ </param>
+ <param>
+ <name>urls./**</name>
+ <value>authcBasic</value>
+ </param>
+ </provider>
+ <provider>
+ <role>identity-assertion</role>
+ <name>Default</name>
+ <enabled>true</enabled>
+ </provider>
+ <provider>
+ <role>hostmap</role>
+ <name>static</name>
+ <enabled>true</enabled>
+ <param>
+ <name>localhost</name>
+ <value>sandbox,sandbox.hortonworks.com</value>
+ </param>
+ </provider>
+ </gateway>
+ <service>
+ <role>NAMENODE</role>
+ <url>hdfs://localhost:8020</url>
+ </service>
+ <service>
+ <role>JOBTRACKER</role>
+ <url>rpc://localhost:8050</url>
+ </service>
+ <service>
+ <role>WEBHDFS</role>
+ <url>http://localhost:50070/webhdfs</url>
+ </service>
+ <service>
+ <role>WEBHCAT</role>
+ <url>http://localhost:50111/templeton</url>
+ </service>
+ <service>
+ <role>OOZIE</role>
+ <url>http://localhost:11000/oozie</url>
+ </service>
+ <service>
+ <role>WEBHBASE</role>
+ <url>http://localhost:60080</url>
+ </service>
+ <service>
+ <role>HIVE</role>
+ <url>http://localhost:10001/cliservice</url>
+ </service>
+ <service>
+ <role>RESOURCEMANAGER</role>
+ <url>http://localhost:8088/ws</url>
+ </service>
+</topology></pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td> </td>
+ <td>DELETE</td>
+ <td>Delete (and undeploy) a topology</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/topologies/mytopology
-X DELETE</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td><pre>{ "deleted" : true }</pre></td>
+ </tr>
+
+ <tr>
+ <td>providerconfig</td>
+ <td>GET</td>
+ <td>Get an enumeration of the shared provider configurations currently
deployed to the gateway.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/providerconfig</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "href" : "https://localhost:8443/gateway/admin/api/v1/providerconfig";,
+ "items" : [ {
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/providerconfig/myproviders";,
+ "name" : "myproviders.xml"
+ },{
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/providerconfig/sandbox-providers";,
+ "name" : "sandbox-providers.xml"
+ } ]
+} </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>providerconfig/{id}</td>
+ <td>GET</td>
+ <td>Get the XML content of the specified shared provider
configuration.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/providerconfig/sandbox-providers \
+ -H Accept:application/xml</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+<gateway>
+ <provider>
+ <role>authentication</role>
+ <name>ShiroProvider</name>
+ <enabled>true</enabled>
+ <param>
+ <name>sessionTimeout</name>
+ <value>30</value>
+ </param>
+ <param>
+ <name>main.ldapRealm</name>
+
<value>org.apache.knox.gateway.shirorealm.KnoxLdapRealm</value>
+ </param>
+ <param>
+ <name>main.ldapContextFactory</name>
+
<value>org.apache.knox.gateway.shirorealm.KnoxLdapContextFactory</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.contextFactory</name>
+ <value>$ldapContextFactory</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.userDnTemplate</name>
+
<value>uid={0},ou=people,dc=hadoop,dc=apache,dc=org</value>
+ </param>
+ <param>
+ <name>main.ldapRealm.contextFactory.url</name>
+ <value>ldap://localhost:33389</value>
+ </param>
+ <param>
+
<name>main.ldapRealm.contextFactory.authenticationMechanism</name>
+ <value>simple</value>
+ </param>
+ <param>
+ <name>urls./**</name>
+ <value>authcBasic</value>
+ </param>
+ </provider>
+
+ <provider>
+ <role>identity-assertion</role>
+ <name>Default</name>
+ <enabled>true</enabled>
+ </provider>
+
+ <provider>
+ <role>hostmap</role>
+ <name>static</name>
+ <enabled>true</enabled>
+ <param>
+ <name>localhost</name>
+ <value>sandbox,sandbox.hortonworks.com</value>
+ </param>
+ </provider>
+</gateway></pre>
+ </td>
+ </tr>
+ </tr>
+ <td> </td>
+ <td>PUT</td>
+ <td>Add a shared provider configuration.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/providerconfig/sandbox-providers \
+ -X PUT \
+ -H Content-Type:application/xml \
+ -d "@sandbox-providers.xml"</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td><pre>HTTP 201 Created</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>DELETE</td>
+ <td>Delete a shared provider configuration</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/providerconfig/sandbox-providers -X DELETE</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>{ "deleted" : "provider config sandbox-providers" }</pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>descriptors</td>
+ <td>GET</td>
+ <td>Get an enumeration of the simple descriptors currently deployed to the
gateway.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password {GatewayAPI}/descriptors -H
Accept:application/json</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "href" : "https://localhost:8443/gateway/admin/api/v1/descriptors";,
+ "items" : [ {
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/descriptors/docker-sandbox";,
+ "name" : "docker-sandbox.json"
+ }, {
+ "href" :
"https://localhost:8443/gateway/admin/api/v1/descriptors/mytopology";,
+ "name" : "mytopology.yml"
+ } ]
+} </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>descriptors/{id}</td>
+ <td>GET</td>
+ <td>Get the content of the specified descriptor.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/descriptors/docker-sandbox \
+ -H Accept:application/json</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "discovery-type":"AMBARI",
+ "discovery-address":"http://sandbox.hortonworks.com:8080";,
+ "provider-config-ref":"sandbox-providers",
+ "cluster":"Sandbox",
+ "services":[
+ {"name":"NAMENODE"},
+ {"name":"JOBTRACKER"},
+ {"name":"WEBHDFS"},
+ {"name":"WEBHCAT"},
+ {"name":"OOZIE"},
+ {"name":"WEBHBASE"},
+ {"name":"HIVE"},
+ {"name":"RESOURCEMANAGER"} ]
+} </pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>PUT</td>
+ <td>Add a simple descriptor (and generate and deploy a full topology
descriptor).</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/descriptors/docker-sandbox \
+ -X PUT \
+ -H Content-Type:application/json \
+ -d "@docker-sandbox.json"</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td><pre>HTTP 201 Created</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>DELETE</td>
+ <td>Delete a simple descriptor (and undeploy the associated topology)</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/descriptors/docker-sandbox -X DELETE</pre></td>
+ <tr>
+ </tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>{ "deleted" : "descriptor docker-sandbox" }</pre>
+ </td>
+ </tr>
+
+</table>
+
+
+
Added: knox/trunk/books/1.0.0/admin_ui.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.0.0/admin_ui.md?rev=1823389&view=auto
==============================================================================
--- knox/trunk/books/1.0.0/admin_ui.md (added)
+++ knox/trunk/books/1.0.0/admin_ui.md Tue Feb 6 20:46:11 2018
@@ -0,0 +1,45 @@
+<!---
+ 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.
+--->
+
+### Admin UI ###
+
+In addition to the Admin REST API, from this release there is the ability to
access some of the functionality
+via a webpage. The initial functionality is very limited and serves more as a
starting point/placeholder. The details
+ are below.
+
+#### Admin UI URL ####
+
+The URL mapping for the Knox Admin UI is:
+
+| ------- |
----------------------------------------------------------------------------------------------
|
+| Gateway |
`https://{gateway-host}:{gateway-port}/{gateway-path}/manager/admin-ui/index.html`
|
+
+
+##### UI Functionality
+
+###### Operations
+
+The application is a conventional one page application with functionality
limited to basic functionality related to
+ Topology CRUD. Once logged in the user can view all topologies that are
deployed to the gateway instance and can
+ view the details of a topology file, modify it and save it, delete it or copy
it to create a new topology.
+
+###### Authentication
+
+The admin UI is deployed using the topology called 'manager'. The out of box
authentication specified uses the LDAP credentials
+ and since the UI depends on the admin UI, only someone in the admin role can
access the UI functionality. In order to change the
+ authentication mechanism, the manager topology needs to be changed. For
example, KNOXSSO can be used as an alternative mechanism here.
+
\ No newline at end of file
Added: knox/trunk/books/1.0.0/book.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.0.0/book.md?rev=1823389&view=auto
==============================================================================
--- knox/trunk/books/1.0.0/book.md (added)
+++ knox/trunk/books/1.0.0/book.md Tue Feb 6 20:46:11 2018
@@ -0,0 +1,161 @@
+<!--
+ 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.
+-->
+
+<<../common/header.md>>
+
+<img src="knox-logo.gif" alt="Knox"/>
+<!-- <img src="apache-logo.gif" alt="Apache"/> -->
+<img src="apache-logo.gif" align="right" alt="Apache"/>
+
+# Apache Knox Gateway 1.0.x User's Guide #
+
+## Table Of Contents ##
+
+* #[Introduction]
+* #[Quick Start]
+* #[Gateway Samples]
+* #[Apache Knox Details]
+ * #[Apache Knox Directory Layout]
+ * #[Supported Services]
+* #[Gateway Details]
+ * #[URL Mapping]
+ * #[Default Topology URLs]
+ * #[Fully Qualified URLs]
+ * #[Topology Port Mapping]
+ * #[Configuration]
+ * #[Gateway Server Configuration]
+ * #[Simplified Topology Descriptors]
+ * #[Externalized Provider Configurations]
+ * #[Sharing HA Providers]
+ * #[Simplified Descriptor Files]
+ * #[Cluster Configuration Monitoring]
+ * #[Remote Configuration Monitor]
+ * #[Remote Configuration Registry Clients]
+ * #[Topology Descriptors]
+ * #[Hostmap Provider]
+ * #[Knox CLI]
+ * #[Admin API]
+ * #[X-Forwarded-* Headers Support]
+ * #[Metrics]
+* #[Authentication]
+ * #[Advanced LDAP Authentication]
+ * #[LDAP Authentication Caching]
+ * #[LDAP Group Lookup]
+ * #[LDAP Group Lookup]
+ * #[PAM based Authentication]
+ * #[HadoopAuth Authentication Provider]
+ * #[Preauthenticated SSO Provider]
+ * #[SSO Cookie Provider]
+ * #[JWT Provider]
+ * #[Pac4j Provider - CAS / OAuth / SAML / OpenID Connect]
+ * #[KnoxSSO Setup and Configuration]
+ * #[KnoxToken Configuration]
+ * #[Mutual Authentication with SSL]
+* #[Authorization]
+* #[Identity Assertion]
+ * #[Default Identity Assertion Provider]
+ * #[Concat Identity Assertion Provider]
+ * #[SwitchCase Identity Assertion Provider]
+ * #[Regular Expression Identity Assertion Provider]
+ * #[Hadoop Group Lookup Provider]
+* #[Secure Clusters]
+* #[High Availability]
+* #[Web App Security Provider]
+ * #[CSRF]
+ * #[CORS]
+ * #[X-Frame-Options]
+ * #[HTTP Strict-Tranport-Security - HSTS]
+* #[Websocket Support]
+* #[Audit]
+* #[Client Details]
+ * #[Client Quickstart]
+ * #[Client Token Sessions]
+ * #[Server Setup]
+ * #[Client DSL and SDK Details]
+* #[Service Details]
+ * #[WebHDFS]
+ * #[WebHCat]
+ * #[Oozie]
+ * #[HBase]
+ * #[Hive]
+ * #[Yarn]
+ * #[Kafka]
+ * #[Storm]
+ * #[SOLR]
+ * #[Avatica]
+ * #[Livy Server]
+ * #[Common Service Config]
+ * #[Default Service HA support]
+* #[UI Service Details]
+* #[Admin UI]
+* #[Limitations]
+* #[Troubleshooting]
+* #[Export Controls]
+
+
+## Introduction ##
+
+The Apache Knox Gateway is a system that provides a single point of
authentication and access for Apache Hadoop services in a cluster.
+The goal is to simplify Hadoop security for both users (i.e. who access the
cluster data and execute jobs) and operators (i.e. who control access and
manage the cluster).
+The gateway runs as a server (or cluster of servers) that provide centralized
access to one or more Hadoop clusters.
+In general the goals of the gateway are as follows:
+
+* Provide perimeter security for Hadoop REST APIs to make Hadoop security
easier to setup and use
+ * Provide authentication and token verification at the perimeter
+ * Enable authentication integration with enterprise and cloud identity
management systems
+ * Provide service level authorization at the perimeter
+* Expose a single URL hierarchy that aggregates REST APIs of a Hadoop cluster
+ * Limit the network endpoints (and therefore firewall holes) required to
access a Hadoop cluster
+ * Hide the internal Hadoop cluster topology from potential attackers
+
+<<quick_start.md>>
+<<book_getting-started.md>>
+<<book_knox-samples.md>>
+<<book_gateway-details.md>>
+<<book_client-details.md>>
+<<book_service-details.md>>
+<<book_ui_service_details.md>>
+<<admin_ui.md>>
+<<book_limitations.md>>
+<<book_troubleshooting.md>>
+
+
+## Export Controls ##
+
+Apache Knox Gateway includes cryptographic software.
+The country in which you currently reside may have restrictions on the import,
possession, use, and/or
+re-export to another country, of encryption software.
+BEFORE using any encryption software, please check your country's laws,
regulations and policies concerning the
+import, possession, or use, and re-export of encryption software, to see if
this is permitted.
+See http://www.wassenaar.org for more information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and Security
(BIS),
+has classified this software as Export Commodity Control Number (ECCN)
5D002.C.1,
+which includes information security software using or performing cryptographic
functions with asymmetric algorithms.
+The form and manner of this Apache Software Foundation distribution makes it
eligible for export under the
+License Exception ENC Technology Software Unrestricted (TSU) exception
+(see the BIS Export Administration Regulations, Section 740.13) for both
object code and source code.
+
+The following provides more details on the included cryptographic software:
+
+* Apache Knox Gateway uses the ApacheDS which in turn uses Bouncy Castle
generic encryption libraries.
+* See http://www.bouncycastle.org for more details on Bouncy Castle.
+* See http://directory.apache.org/apacheds for more details on ApacheDS.
+
+
+<<../common/footer.md>>
+
Added: knox/trunk/books/1.0.0/book_client-details.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.0.0/book_client-details.md?rev=1823389&view=auto
==============================================================================
--- knox/trunk/books/1.0.0/book_client-details.md (added)
+++ knox/trunk/books/1.0.0/book_client-details.md Tue Feb 6 20:46:11 2018
@@ -0,0 +1,691 @@
+<!---
+ 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.
+--->
+
+## Client Details ##
+The KnoxShell release artifact provides a small footprint client environment
that removes all unnecessary server dependencies, configuration, binary
scripts, etc. It is comprised a couple different things that empower different
sorts of users.
+
+* A set of SDK type classes for providing access to Hadoop resources over HTTP
+* A Groovy based DSL for scripting access to Hadoop resources based on the
underlying SDK classes
+* A KnoxShell Token based Sessions to provide a CLI SSO session for executing
multiple scripts
+
+The following sections provide an overview and quickstart for the KnoxShell.
+
+### Client Quickstart ###
+The following installation and setup instructions should get you started with
using the KnoxShell very quickly.
+
+1. Download a knoxshell-x.x.x.zip or tar file and unzip it in your preferred
location {GATEWAY_CLIENT_HOME}
+
+ home:knoxshell-0.12.0 larry$ ls -l
+ total 296
+ -rw-r--r--@ 1 larry staff 71714 Mar 14 14:06 LICENSE
+ -rw-r--r--@ 1 larry staff 164 Mar 14 14:06 NOTICE
+ -rw-r--r--@ 1 larry staff 71714 Mar 15 20:04 README
+ drwxr-xr-x@ 12 larry staff 408 Mar 15 21:24 bin
+ drwxr--r--@ 3 larry staff 102 Mar 14 14:06 conf
+ drwxr-xr-x+ 3 larry staff 102 Mar 15 12:41 logs
+ drwxr-xr-x@ 18 larry staff 612 Mar 14 14:18 samples
+
+ |Directory | Description |
+ |-------------|-------------|
+ |bin |contains the main knoxshell jar and related shell scripts|
+ |conf |only contains log4j config|
+ |logs |contains the knoxshell.log file|
+ |samples |has numerous examples to help you get started|
+
+2. cd {GATEWAY_CLIENT_HOME}
+3. Get/setup truststore for the target Knox instance or fronting load balancer
+ - if you have access to the server you may use the command knoxcli.sh
export-cert --type JKS
+ - copy the resulting gateway-client-identity.jks to your user home
directory
+4. Execute the an example script from the {GATEWAY_CLIENT_HOME}/samples
directory - for instance:
+ - bin/knoxshell.sh samples/ExampleWebHdfsLs.groovy
+
+ home:knoxshell-0.12.0 larry$ bin/knoxshell.sh
samples/ExampleWebHdfsLs.groovy
+ Enter username: guest
+ Enter password:
+ [app-logs, apps, mapred, mr-history, tmp, user]
+
+At this point, you should have seen something similar to the above output -
probably with different directories listed. You should get the idea from the
above. Take a look at the sample that we ran above:
+
+ import groovy.json.JsonSlurper
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.knox.gateway.shell.hdfs.Hdfs
+
+ import org.apache.knox.gateway.shell.Credentials
+
+ gateway = "https://localhost:8443/gateway/sandbox";
+
+ credentials = new Credentials()
+ credentials.add("ClearInput", "Enter username: ", "user")
+ .add("HiddenInput", "Enter pas" + "sword: ", "pass")
+ credentials.collect()
+
+ username = credentials.get("user").string()
+ pass = credentials.get("pass").string()
+
+ session = Hadoop.login( gateway, username, pass )
+
+ text = Hdfs.ls( session ).dir( "/" ).now().string
+ json = (new JsonSlurper()).parseText( text )
+ println json.FileStatuses.FileStatus.pathSuffix
+ session.shutdown()
+
+Some things to note about this sample:
+
+1. the gateway URL is hardcoded
+ - alternatives would be passing it as an argument to the script, using an
environment variable or prompting for it with a ClearInput credential collector
+2. credential collectors are used to gather credentials or other input from
various sources. In this sample the HiddenInput and ClearInput collectors
prompt the user for the input with the provided prompt text and the values are
acquired by a subsequent get call with the provided name value.
+3. The Hadoop.login method establishes a login session of sorts which will
need to be provided to the various API classes as an argument.
+4. the response text is easily retrieved as a string and can be parsed by the
JsonSlurper or whatever you like
+
+### Client Token Sessions ###
+Building on the Quickstart above we will drill into some of the token session
details here and walk through another sample.
+
+Unlike the quickstart, token sessions require the server to be configured in
specific ways to allow the use of token sessions/federation.
+
+#### Server Setup ####
+1. KnoxToken service should be added to your sandbox.xml topology - see the
[KnoxToken Configuration Section] (#KnoxToken+Configuration)
+
+ <service>
+ <role>KNOXTOKEN</role>
+ <param>
+ <name>knox.token.ttl</name>
+ <value>36000000</value>
+ </param>
+ <param>
+ <name>knox.token.audiences</name>
+ <value>tokenbased</value>
+ </param>
+ <param>
+ <name>knox.token.target.url</name>
+ <value>https://localhost:8443/gateway/tokenbased</value>
+ </param>
+ </service>
+
+2. tokenbased.xml topology to accept tokens as federation tokens for access to
exposed resources with JWTProvider [JWT Provider](#JWT+Provider)
+
+ <provider>
+ <role>federation</role>
+ <name>JWTProvider</name>
+ <enabled>true</enabled>
+ <param>
+ <name>knox.token.audiences</name>
+ <value>tokenbased</value>
+ </param>
+ </provider>
+3. Use the KnoxShell token commands to establish and manage your session
+ - bin/knoxshell.sh init https://localhost:8443/gateway/sandbox to acquire
a token and cache in user home directory
+ - bin/knoxshell.sh list to display the details of the cached token, the
expiration time and optionally the target url
+ - bin/knoxshell destroy to remove the cached session token and terminate
the session
+
+4. Execute a script that can take advantage of the token credential collector
and target url
+
+ import groovy.json.JsonSlurper
+ import java.util.HashMap
+ import java.util.Map
+ import org.apache.knox.gateway.shell.Credentials
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.knox.gateway.shell.hdfs.Hdfs
+
+ credentials = new Credentials()
+ credentials.add("KnoxToken", "none: ", "token")
+ credentials.collect()
+
+ token = credentials.get("token").string()
+
+ gateway = System.getenv("KNOXSHELL_TOPOLOGY_URL")
+ if (gateway == null || gateway.equals("")) {
+ gateway = credentials.get("token").getTargetUrl()
+ }
+
+ println ""
+ println "*****************************GATEWAY
INSTANCE**********************************"
+ println gateway
+ println
"*******************************************************************************"
+ println ""
+
+ headers = new HashMap()
+ headers.put("Authorization", "Bearer " + token)
+
+ session = Hadoop.login( gateway, headers )
+
+ if (args.length > 0) {
+ dir = args[0]
+ } else {
+ dir = "/"
+ }
+
+ text = Hdfs.ls( session ).dir( dir ).now().string
+ json = (new JsonSlurper()).parseText( text )
+ statuses = json.get("FileStatuses");
+
+ println statuses
+
+ session.shutdown()
+
+Note the following about the above sample script:
+
+1. use of the KnoxToken credential collector
+2. use of the targetUrl from the credential collector
+3. optional override of the target url with environment variable
+4. the passing of the headers map to the session creation in Hadoop.login
+5. the passing of an argument for the ls command for the path to list or
default to "/"
+
+Also note that there is no reason to prompt for username and password as long
as the token has not been destroyed or expired.
+There is also no hardcoded endpoint for using the token - it is specified in
the token cache or overridden by environment variable.
+
+## Client DSL and SDK Details ##
+
+The lack of any formal SDK or client for REST APIs in Hadoop led to thinking
about a very simple client that could help people use and evaluate the gateway.
+The list below outlines the general requirements for such a client.
+
+* Promote the evaluation and adoption of the Apache Knox Gateway
+* Simple to deploy and use on data worker desktops for access to remote Hadoop
clusters
+* Simple to extend with new commands both by other Hadoop projects and by the
end user
+* Support the notion of a SSO session for multiple Hadoop interactions
+* Support the multiple authentication and federation token capabilities of the
Apache Knox Gateway
+* Promote the use of REST APIs as the dominant remote client mechanism for
Hadoop services
+* Promote the sense of Hadoop as a single unified product
+* Aligned with the Apache Knox Gateway's overall goals for security
+
+The result is a very simple DSL ([Domain Specific
Language](http://en.wikipedia.org/wiki/Domain-specific_language)) of sorts that
is used via [Groovy](http://groovy.codehaus.org) scripts.
+Here is an example of a command that copies a file from the local file system
to HDFS.
+
+_Note: The variables `session`, `localFile` and `remoteFile` are assumed to be
defined._
+
+ Hdfs.put(session).file(localFile).to(remoteFile).now()
+
+*This work is in very early development but is already very useful in its
current state.*
+*We are very interested in receiving feedback about how to improve this
feature and the DSL in particular.*
+
+A note of thanks to [REST-assured](https://code.google.com/p/rest-assured/)
which provides a [Fluent
interface](http://en.wikipedia.org/wiki/Fluent_interface) style DSL for testing
REST services.
+It served as the initial inspiration for the creation of this DSL.
+
+### Assumptions ###
+
+This document assumes a few things about your environment in order to simplify
the examples.
+
+* The JVM is executable as simply `java`.
+* The Apache Knox Gateway is installed and functional.
+* The example commands are executed within the context of the `GATEWAY_HOME`
current directory.
+The `GATEWAY_HOME` directory is the directory within the Apache Knox Gateway
installation that contains the README file and the bin, conf and deployments
directories.
+* A few examples require the use of commands from a standard Groovy
installation. These examples are optional but to try them you will need Groovy
[installed](http://groovy.codehaus.org/Installing+Groovy).
+
+
+### Basics ###
+
+In order for secure connections to be made to the Knox gateway server over
SSL, the user will need to trust
+the certificate presented by the gateway while connecting. The knoxcli command
export-cert may be used to get
+access the gateway-identity cert. It can then be imported into cacerts on the
client machine or put into a
+keystore that will be discovered in:
+
+* the user's home directory
+* in a directory specified in an environment variable:
KNOX_CLIENT_TRUSTSTORE_DIR
+* in a directory specified with the above variable with the keystore filename
specified in the variable: KNOX_CLIENT_TRUSTSTORE_FILENAME
+* default password "changeit" or password may be specified in environment
variable: KNOX_CLIENT_TRUSTSTORE_PASS
+* or the JSSE system property: javax.net.ssl.trustStore can be used to specify
its location
+
+The DSL requires a shell to interpret the Groovy script.
+The shell can either be used interactively or to execute a script file.
+To simplify use, the distribution contains an embedded version of the Groovy
shell.
+
+The shell can be run interactively. Use the command `exit` to exit.
+
+ java -jar bin/shell.jar
+
+When running interactively it may be helpful to reduce some of the output
generated by the shell console.
+Use the following command in the interactive shell to reduce that output.
+This only needs to be done once as these preferences are persisted.
+
+ set verbosity QUIET
+ set show-last-result false
+
+Also when running interactively use the `exit` command to terminate the shell.
+Using `^C` to exit can sometimes leaves the parent shell in a problematic
state.
+
+The shell can also be used to execute a script by passing a single filename
argument.
+
+ java -jar bin/shell.jar samples/ExampleWebHdfsPutGet.groovy
+
+
+### Examples ###
+
+Once the shell can be launched the DSL can be used to interact with the
gateway and Hadoop.
+Below is a very simple example of an interactive shell session to upload a
file to HDFS.
+
+ java -jar bin/shell.jar
+ knox:000> session = Hadoop.login(
"https://localhost:8443/gateway/sandbox";, "guest", "guest-password" )
+ knox:000> Hdfs.put( session ).file( "README" ).to( "/tmp/example/README"
).now()
+
+The `knox:000>` in the example above is the prompt from the embedded Groovy
console.
+If you output doesn't look like this you may need to set the verbosity and
show-last-result preferences as described above in the Usage section.
+
+If you recieve an error `HTTP/1.1 403 Forbidden` it may be because that file
already exists.
+Try deleting it with the following command and then try again.
+
+ knox:000> Hdfs.rm(session).file("/tmp/example/README").now()
+
+Without using some other tool to browse HDFS it is hard to tell that this
command did anything.
+Execute this to get a bit more feedback.
+
+ knox:000> println "Status=" + Hdfs.put( session ).file( "README" ).to(
"/tmp/example/README2" ).now().statusCode
+ Status=201
+
+Notice that a different filename is used for the destination.
+Without this an error would have resulted.
+Of course the DSL also provides a command to list the contents of a directory.
+
+ knox:000> println Hdfs.ls( session ).dir( "/tmp/example" ).now().string
+
{"FileStatuses":{"FileStatus":[{"accessTime":1363711366977,"blockSize":134217728,"group":"hdfs","length":19395,"modificationTime":1363711366977,"owner":"guest","pathSuffix":"README","permission":"644","replication":1,"type":"FILE"},{"accessTime":1363711375617,"blockSize":134217728,"group":"hdfs","length":19395,"modificationTime":1363711375617,"owner":"guest","pathSuffix":"README2","permission":"644","replication":1,"type":"FILE"}]}}
+
+It is a design decision of the DSL to not provide type safe classes for
various request and response payloads.
+Doing so would provide an undesirable coupling between the DSL and the service
implementation.
+It also would make adding new commands much more difficult.
+See the Groovy section below for a variety capabilities and tools for working
with JSON and XML to make this easy.
+The example below shows the use of JsonSlurper and GPath to extract content
from a JSON response.
+
+ knox:000> import groovy.json.JsonSlurper
+ knox:000> text = Hdfs.ls( session ).dir( "/tmp/example" ).now().string
+ knox:000> json = (new JsonSlurper()).parseText( text )
+ knox:000> println json.FileStatuses.FileStatus.pathSuffix
+ [README, README2]
+
+*In the future, "built-in" methods to slurp JSON and XML may be added to make
this a bit easier.*
+*This would allow for the following type of single line interaction:*
+
+ println
Hdfs.ls(session).dir("/tmp").now().json().FileStatuses.FileStatus.pathSuffix
+
+Shell sessions should always be ended with shutting down the session.
+The examples above do not touch on it but the DSL supports the simple
execution of commands asynchronously.
+The shutdown command attempts to ensures that all asynchronous commands have
completed before existing the shell.
+
+ knox:000> session.shutdown()
+ knox:000> exit
+
+All of the commands above could have been combined into a script file and
executed as a single line.
+
+ java -jar bin/shell.jar samples/ExampleWebHdfsPutGet.groovy
+
+This would be the content of that script.
+
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.knox.gateway.shell.hdfs.Hdfs
+ import groovy.json.JsonSlurper
+
+ gateway = "https://localhost:8443/gateway/sandbox";
+ username = "guest"
+ password = "guest-password"
+ dataFile = "README"
+
+ session = Hadoop.login( gateway, username, password )
+ Hdfs.rm( session ).file( "/tmp/example" ).recursive().now()
+ Hdfs.put( session ).file( dataFile ).to( "/tmp/example/README" ).now()
+ text = Hdfs.ls( session ).dir( "/tmp/example" ).now().string
+ json = (new JsonSlurper()).parseText( text )
+ println json.FileStatuses.FileStatus.pathSuffix
+ session.shutdown()
+ exit
+
+Notice the `Hdfs.rm` command. This is included simply to ensure that the
script can be rerun.
+Without this an error would result the second time it is run.
+
+### Futures ###
+
+The DSL supports the ability to invoke commands asynchronously via the later()
invocation method.
+The object returned from the later() method is a java.util.concurrent.Future
parameterized with the response type of the command.
+This is an example of how to asynchronously put a file to HDFS.
+
+ future = Hdfs.put(session).file("README").to("/tmp/example/README").later()
+ println future.get().statusCode
+
+The future.get() method will block until the asynchronous command is complete.
+To illustrate the usefulness of this however multiple concurrent commands are
required.
+
+ readmeFuture =
Hdfs.put(session).file("README").to("/tmp/example/README").later()
+ licenseFuture =
Hdfs.put(session).file("LICENSE").to("/tmp/example/LICENSE").later()
+ session.waitFor( readmeFuture, licenseFuture )
+ println readmeFuture.get().statusCode
+ println licenseFuture.get().statusCode
+
+The session.waitFor() method will wait for one or more asynchronous commands
to complete.
+
+
+### Closures ###
+
+Futures alone only provide asynchronous invocation of the command.
+What if some processing should also occur asynchronously once the command is
complete.
+Support for this is provided by closures.
+Closures are blocks of code that are passed into the later() invocation method.
+In Groovy these are contained within {} immediately after a method.
+These blocks of code are executed once the asynchronous command is complete.
+
+ Hdfs.put(session).file("README").to("/tmp/example/README").later(){
println it.statusCode }
+
+In this example the put() command is executed on a separate thread and once
complete the `println it.statusCode` block is executed on that thread.
+The `it` variable is automatically populated by Groovy and is a reference to
the result that is returned from the future or `now()` method.
+The future example above can be rewritten to illustrate the use of closures.
+
+ readmeFuture =
Hdfs.put(session).file("README").to("/tmp/example/README").later() { println
it.statusCode }
+ licenseFuture =
Hdfs.put(session).file("LICENSE").to("/tmp/example/LICENSE").later() { println
it.statusCode }
+ session.waitFor( readmeFuture, licenseFuture )
+
+Again, the session.waitFor() method will wait for one or more asynchronous
commands to complete.
+
+
+### Constructs ###
+
+In order to understand the DSL there are three primary constructs that need to
be understood.
+
+
+#### Session ####
+
+This construct encapsulates the client side session state that will be shared
between all command invocations.
+In particular it will simplify the management of any tokens that need to be
presented with each command invocation.
+It also manages a thread pool that is used by all asynchronous commands which
is why it is important to call one of the shutdown methods.
+
+The syntax associated with this is expected to change. We expect that
credentials will not need to be provided to the gateway. Rather it is expected
that some form of access token will be used to initialize the session.
+
+
+#### Services ####
+
+Services are the primary extension point for adding new suites of commands.
+The current built-in examples are: Hdfs, Job and Workflow.
+The desire for extensibility is the reason for the slightly awkward
`Hdfs.ls(session)` syntax.
+Certainly something more like `session.hdfs().ls()` would have been preferred
but this would prevent adding new commands easily.
+At a minimum it would result in extension commands with a different syntax
from the "built-in" commands.
+
+The service objects essentially function as a factory for a suite of commands.
+
+
+#### Commands ####
+
+Commands provide the behavior of the DSL.
+They typically follow a Fluent interface style in order to allow for single
line commands.
+There are really three parts to each command: Request, Invocation, Response
+
+
+#### Request ####
+
+The request is populated by all of the methods following the "verb" method and
the "invoke" method.
+For example in `Hdfs.rm(session).ls(dir).now()` the request is populated
between the "verb" method `rm()` and the "invoke" method `now()`.
+
+
+#### Invocation ####
+
+The invocation method controls how the request is invoked.
+Currently supported synchronous and asynchronous invocation.
+The now() method executes the request and returns the result immediately.
+The later() method submits the request to be executed later and returns a
future from which the result can be retrieved.
+In addition later() invocation method can optionally be provided a closure to
execute when the request is complete.
+See the Futures and Closures sections below for additional detail and examples.
+
+
+#### Response ####
+
+The response contains the results of the invocation of the request.
+In most cases the response is a thin wrapper over the HTTP response.
+In fact many commands will share a single BasicResponse type that only
provides a few simple methods.
+
+ public int getStatusCode()
+ public long getContentLength()
+ public String getContentType()
+ public String getContentEncoding()
+ public InputStream getStream()
+ public String getString()
+ public byte[] getBytes()
+ public void close();
+
+Thanks to Groovy these methods can be accessed as attributes.
+In the some of the examples the staticCode was retrieved for example.
+
+ println Hdfs.put(session).rm(dir).now().statusCode
+
+Groovy will invoke the getStatusCode method to retrieve the statusCode
attribute.
+
+The three methods getStream(), getBytes() and getString deserve special
attention.
+Care must be taken that the HTTP body is fully read once and only once.
+Therefore one of these methods (and only one) must be called once and only
once.
+Calling one of these more than once will cause an error.
+Failing to call one of these methods once will result in lingering open HTTP
connections.
+The close() method may be used if the caller is not interested in reading the
result body.
+Most commands that do not expect a response body will call close implicitly.
+If the body is retrieved via getBytes() or getString(), the close() method
need not be called.
+When using getStream(), care must be taken to consume the entire body
otherwise lingering open HTTP connections will result.
+The close() method may be called after reading the body partially to discard
the remainder of the body.
+
+
+### Services ###
+
+The built-in supported client DSL for each Hadoop service can be found in the
#[Service Details] section.
+
+
+### Extension ###
+
+Extensibility is a key design goal of the KnoxShell and client DSL.
+There are two ways to provide extended functionality for use with the shell.
+The first is to simply create Groovy scripts that use the DSL to perform a
useful task.
+The second is to add new services and commands.
+In order to add new service and commands new classes must be written in either
Groovy or Java and added to the classpath of the shell.
+Fortunately there is a very simple way to add classes and JARs to the shell
classpath.
+The first time the shell is executed it will create a configuration file in
the same directory as the JAR with the same base name and a `.cfg` extension.
+
+ bin/shell.jar
+ bin/shell.cfg
+
+That file contains both the main class for the shell as well as a definition
of the classpath.
+Currently that file will by default contain the following.
+
+ main.class=org.apache.knox.gateway.shell.Shell
+ class.path=../lib; ../lib/*.jar; ../ext; ../ext/*.jar
+
+Therefore to extend the shell you should copy any new service and command
class either to the `ext` directory or if they are packaged within a JAR copy
the JAR to the `ext` directory.
+The `lib` directory is reserved for JARs that may be delivered with the
product.
+
+Below are samples for the service and command classes that would need to be
written to add new commands to the shell.
+These happen to be Groovy source files but could - with very minor changes -
be Java files.
+The easiest way to add these to the shell is to compile them directly into the
`ext` directory.
+*Note: This command depends upon having the Groovy compiler installed and
available on the execution path.*
+
+ groovy -d ext -cp bin/shell.jar samples/SampleService.groovy \
+ samples/SampleSimpleCommand.groovy samples/SampleComplexCommand.groovy
+
+These source files are available in the samples directory of the distribution
but are included here for convenience.
+
+
+#### Sample Service (Groovy)
+
+ import org.apache.knox.gateway.shell.Hadoop
+
+ class SampleService {
+
+ static String PATH = "/webhdfs/v1"
+
+ static SimpleCommand simple( Hadoop session ) {
+ return new SimpleCommand( session )
+ }
+
+ static ComplexCommand.Request complex( Hadoop session ) {
+ return new ComplexCommand.Request( session )
+ }
+
+ }
+
+#### Sample Simple Command (Groovy)
+
+ import org.apache.knox.gateway.shell.AbstractRequest
+ import org.apache.knox.gateway.shell.BasicResponse
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.http.client.methods.HttpGet
+ import org.apache.http.client.utils.URIBuilder
+
+ import java.util.concurrent.Callable
+
+ class SimpleCommand extends AbstractRequest<BasicResponse> {
+
+ SimpleCommand( Hadoop session ) {
+ super( session )
+ }
+
+ private String param
+ SimpleCommand param( String param ) {
+ this.param = param
+ return this
+ }
+
+ @Override
+ protected Callable<BasicResponse> callable() {
+ return new Callable<BasicResponse>() {
+ @Override
+ BasicResponse call() {
+ URIBuilder uri = uri( SampleService.PATH, param )
+ addQueryParam( uri, "op", "LISTSTATUS" )
+ HttpGet get = new HttpGet( uri.build() )
+ return new BasicResponse( execute( get ) )
+ }
+ }
+ }
+
+ }
+
+
+#### Sample Complex Command (Groovy)
+
+ import com.jayway.jsonpath.JsonPath
+ import org.apache.knox.gateway.shell.AbstractRequest
+ import org.apache.knox.gateway.shell.BasicResponse
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.http.HttpResponse
+ import org.apache.http.client.methods.HttpGet
+ import org.apache.http.client.utils.URIBuilder
+
+ import java.util.concurrent.Callable
+
+ class ComplexCommand {
+
+ static class Request extends AbstractRequest<Response> {
+
+ Request( Hadoop session ) {
+ super( session )
+ }
+
+ private String param;
+ Request param( String param ) {
+ this.param = param;
+ return this;
+ }
+
+ @Override
+ protected Callable<Response> callable() {
+ return new Callable<Response>() {
+ @Override
+ Response call() {
+ URIBuilder uri = uri( SampleService.PATH, param )
+ addQueryParam( uri, "op", "LISTSTATUS" )
+ HttpGet get = new HttpGet( uri.build() )
+ return new Response( execute( get ) )
+ }
+ }
+ }
+
+ }
+
+ static class Response extends BasicResponse {
+
+ Response(HttpResponse response) {
+ super(response)
+ }
+
+ public List<String> getNames() {
+ return JsonPath.read( string,
"\$.FileStatuses.FileStatus[*].pathSuffix" )
+ }
+
+ }
+
+ }
+
+
+### Groovy
+
+The shell included in the distribution is basically an unmodified packaging of
the Groovy shell.
+The distribution does however provide a wrapper that makes it very easy to
setup the class path for the shell.
+In fact the JARs required to execute the DSL are included on the class path by
default.
+Therefore these command are functionally equivalent if you have Groovy
installed.
+See below for a description of what is required for JARs required by the DSL
from `lib` and `dep` directories.
+
+ java -jar bin/shell.jar samples/ExampleWebHdfsPutGet.groovy
+ groovy -classpath {JARs required by the DSL from lib and dep}
samples/ExampleWebHdfsPutGet.groovy
+
+The interactive shell isn't exactly equivalent.
+However the only difference is that the shell.jar automatically executes some
additional imports that are useful for the KnoxShell client DSL.
+So these two sets of commands should be functionality equivalent.
+*However there is currently a class loading issue that prevents the groovysh
command from working properly.*
+
+ java -jar bin/shell.jar
+
+ groovysh -classpath {JARs required by the DSL from lib and dep}
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.knox.gateway.shell.hdfs.Hdfs
+ import org.apache.knox.gateway.shell.job.Job
+ import org.apache.knox.gateway.shell.workflow.Workflow
+ import java.util.concurrent.TimeUnit
+
+Alternatively, you can use the Groovy Console which does not appear to have
the same class loading issue.
+
+ groovyConsole -classpath {JARs required by the DSL from lib and dep}
+
+ import org.apache.knox.gateway.shell.Hadoop
+ import org.apache.knox.gateway.shell.hdfs.Hdfs
+ import org.apache.knox.gateway.shell.job.Job
+ import org.apache.knox.gateway.shell.workflow.Workflow
+ import java.util.concurrent.TimeUnit
+
+The JARs currently required by the client DSL are
+
+ lib/gateway-shell-{GATEWAY_VERSION}.jar
+ dep/httpclient-4.3.6.jar
+ dep/httpcore-4.3.3.jar
+ dep/commons-lang3-3.4.jar
+ dep/commons-codec-1.7.jar
+
+So on Linux/MacOS you would need this command
+
+ groovy -cp
lib/gateway-shell-0.10.0.jar:dep/httpclient-4.3.6.jar:dep/httpcore-4.3.3.jar:dep/commons-lang3-3.4.jar:dep/commons-codec-1.7.jar
samples/ExampleWebHdfsPutGet.groovy
+
+and on Windows you would need this command
+
+ groovy -cp
lib/gateway-shell-0.10.0.jar;dep/httpclient-4.3.6.jar;dep/httpcore-4.3.3.jar;dep/commons-lang3-3.4.jar;dep/commons-codec-1.7.jar
samples/ExampleWebHdfsPutGet.groovy
+
+The exact list of required JARs is likely to change from release to release so
it is recommended that you utilize the wrapper `bin/shell.jar`.
+
+In addition because the DSL can be used via standard Groovy, the Groovy
integrations in many popular IDEs (e.g. IntelliJ, Eclipse) can also be used.
+This makes it particularly nice to develop and execute scripts to interact
with Hadoop.
+The code-completion features in modern IDEs in particular provides immense
value.
+All that is required is to add the `gateway-shell-{GATEWAY_VERSION}.jar` to
the projects class path.
+
+There are a variety of Groovy tools that make it very easy to work with the
standard interchange formats (i.e. JSON and XML).
+In Groovy the creation of XML or JSON is typically done via a "builder" and
parsing done via a "slurper".
+In addition once JSON or XML is "slurped" the GPath, an XPath like feature
build into Groovy can be used to access data.
+
+* XML
+ * Markup Builder
[Overview](http://groovy.codehaus.org/Creating+XML+using+Groovy's+MarkupBuilder),
[API](http://groovy.codehaus.org/api/groovy/xml/MarkupBuilder.html)
+ * XML Slurper
[Overview](http://groovy.codehaus.org/Reading+XML+using+Groovy's+XmlSlurper),
[API](http://groovy.codehaus.org/api/groovy/util/XmlSlurper.html)
+ * XPath [Overview](http://groovy.codehaus.org/GPath),
[API](http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/xpath/XPath.html)
+* JSON
+ * JSON Builder
[API](http://groovy.codehaus.org/gapi/groovy/json/JsonBuilder.html)
+ * JSON Slurper
[API](http://groovy.codehaus.org/gapi/groovy/json/JsonSlurper.html)
+ * JSON Path [API](https://code.google.com/p/json-path/)
+ * GPath [Overview](http://groovy.codehaus.org/GPath)
+
Added: knox/trunk/books/1.0.0/book_gateway-details.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.0.0/book_gateway-details.md?rev=1823389&view=auto
==============================================================================
--- knox/trunk/books/1.0.0/book_gateway-details.md (added)
+++ knox/trunk/books/1.0.0/book_gateway-details.md Tue Feb 6 20:46:11 2018
@@ -0,0 +1,105 @@
+<!---
+ 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.
+-->
+
+## Gateway Details ##
+
+This section describes the details of the Knox Gateway itself. Including:
+
+* How URLs are mapped between a gateway that services multiple Hadoop clusters
and the clusters themselves
+* How the gateway is configured through gateway-site.xml and cluster specific
topology files
+* How to configure the various policy enforcement provider features such as
authentication, authorization, auditing, hostmapping, etc.
+
+### URL Mapping ###
+
+The gateway functions much like a reverse proxy.
+As such, it maintains a mapping of URLs that are exposed externally by the
gateway to URLs that are provided by the Hadoop cluster.
+
+#### Default Topology URLs #####
+In order to provide compatibility with the Hadoop java client and existing CLI
tools, the Knox Gateway has provided a feature called the Default Topology.
This refers to a topology deployment that will be able to route URLs without
the additional context that the gateway uses for differentiating from one
Hadoop cluster to another. This allows the URLs to match those used by existing
clients that may access webhdfs through the Hadoop file system abstraction.
+
+When a topology file is deployed with a file name that matches the configured
default topology name, a specialized mapping for URLs is installed for that
particular topology. This allows the URLs that are expected by the existing
Hadoop CLIs for webhdfs to be used in interacting with the specific Hadoop
cluster that is represented by the default topology file.
+
+The configuration for the default topology name is found in gateway-site.xml
as a property called: "default.app.topology.name".
+
+The default value for this property is "sandbox".
+
+Therefore, when deploying the sandbox.xml topology, both of the following
example URLs work for the same underlying Hadoop cluster:
+
+ https://{gateway-host}:{gateway-port}/webhdfs
+ https://{gateway-host}:{gateway-port}/{gateway-path}/{cluster-name}/webhdfs
+
+These default topology URLs exist for all of the services in the topology.
+
+#### Fully Qualified URLs #####
+Examples of mappings for the WebHDFS, WebHCat, Oozie and HBase are shown below.
+These mapping are generated from the combination of the gateway configuration
file (i.e. `{GATEWAY_HOME}/conf/gateway-site.xml`) and the cluster topology
descriptors (e.g. `{GATEWAY_HOME}/conf/topologies/{cluster-name}.xml`).
+The port numbers shown for the Cluster URLs represent the default ports for
these services.
+The actual port number may be different for a given cluster.
+
+* WebHDFS
+ * Gateway:
`https://{gateway-host}:{gateway-port}/{gateway-path}/{cluster-name}/webhdfs`
+ * Cluster: `http://{webhdfs-host}:50070/webhdfs`
+* WebHCat (Templeton)
+ * Gateway:
`https://{gateway-host}:{gateway-port}/{gateway-path}/{cluster-name}/templeton`
+ * Cluster: `http://{webhcat-host}:50111/templeton}`
+* Oozie
+ * Gateway:
`https://{gateway-host}:{gateway-port}/{gateway-path}/{cluster-name}/oozie`
+ * Cluster: `http://{oozie-host}:11000/oozie}`
+* HBase
+ * Gateway:
`https://{gateway-host}:{gateway-port}/{gateway-path}/{cluster-name}/hbase`
+ * Cluster: `http://{hbase-host}:8080`
+* Hive JDBC
+ * Gateway:
`jdbc:hive2://{gateway-host}:{gateway-port}/;ssl=true;sslTrustStore={gateway-trust-store-path};trustStorePassword={gateway-trust-store-password};transportMode=http;httpPath={gateway-path}/{cluster-name}/hive`
+ * Cluster: `http://{hive-host}:10001/cliservice`
+
+The values for `{gateway-host}`, `{gateway-port}`, `{gateway-path}` are
provided via the gateway configuration file (i.e.
`{GATEWAY_HOME}/conf/gateway-site.xml`).
+
+The value for `{cluster-name}` is derived from the file name of the cluster
topology descriptor (e.g. `{GATEWAY_HOME}/deployments/{cluster-name}.xml`).
+
+The value for `{webhdfs-host}`, `{webhcat-host}`, `{oozie-host}`,
`{hbase-host}` and `{hive-host}` are provided via the cluster topology
descriptor (e.g. `{GATEWAY_HOME}/conf/topologies/{cluster-name}.xml`).
+
+Note: The ports 50070, 50111, 11000, 8080 and 10001 are the defaults for
WebHDFS, WebHCat, Oozie, HBase and Hive respectively.
+Their values can also be provided via the cluster topology descriptor if your
Hadoop cluster uses different ports.
+
+Note: The HBase REST API uses port 8080 by default. This often clashes with
other running services.
+In the Hortonworks Sandbox, Apache Ambari might be running on this port so you
might have to change it to a different port (e.g. 60080).
+
+<<book_topology_port_mapping.md>>
+<<config.md>>
+<<knox_cli.md>>
+<<admin_api.md>>
+<<x-forwarded-headers.md>>
+<<config_metrics.md>>
+<<config_authn.md>>
+<<config_advanced_ldap.md>>
+<<config_ldap_authc_cache.md>>
+<<config_ldap_group_lookup.md>>
+<<config_pam_authn.md>>
+<<config_id_assertion.md>>
+<<config_authz.md>>
+<<config_kerberos.md>>
+<<config_ha.md>>
+<<config_webappsec_provider.md>>
+<<config_hadoop_auth_provider.md>>
+<<config_preauth_sso_provider.md>>
+<<config_sso_cookie_provider.md>>
+<<config_pac4j_provider.md>>
+<<config_knox_sso.md>>
+<<config_knox_token.md>>
+<<config_mutual_authentication_ssl.md>>
+<<websocket-support.md>>
+<<config_audit.md>>
