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 2017/08/14 14:11:59 UTC
[1/2] knox git commit: KNOX-992 - Add README for the knoxshell
distribution (Colm O hEigeartaigh and lmccay via lmccay)
Repository: knox
Updated Branches:
refs/heads/v0.13.0 b9b0db2eb -> 6f1a94deb
KNOX-992 - Add README for the knoxshell distribution (Colm O hEigeartaigh and lmccay via lmccay)
Project: http://git-wip-us.apache.org/repos/asf/knox/repo
Commit: http://git-wip-us.apache.org/repos/asf/knox/commit/6f1a94de
Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/6f1a94de
Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/6f1a94de
Branch: refs/heads/v0.13.0
Commit: 6f1a94deb9f0ed348c2a46515842981b9e026f11
Parents: 35e7173
Author: Larry McCay <lm...@hortonworks.com>
Authored: Mon Aug 14 10:11:21 2017 -0400
Committer: Larry McCay <lm...@hortonworks.com>
Committed: Mon Aug 14 10:11:36 2017 -0400
----------------------------------------------------------------------
gateway-shell-release/home/README | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/knox/blob/6f1a94de/gateway-shell-release/home/README
----------------------------------------------------------------------
diff --git a/gateway-shell-release/home/README b/gateway-shell-release/home/README
new file mode 100644
index 0000000..8fb7726
--- /dev/null
+++ b/gateway-shell-release/home/README
@@ -0,0 +1,30 @@
+*********************************************************************
+KnoxShell README
+*********************************************************************
+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
+
+Directory layout:
+
+-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
+
+See the Client Details section in the Apache Knox Users Guide for more information and
+a set of Quick Start instructions.
[2/2] knox git commit: KNOX-993 - The samples README for knoxshell
references the 0.5.0 userguide
Posted by lm...@apache.org.
KNOX-993 - The samples README for knoxshell references the 0.5.0 userguide
Project: http://git-wip-us.apache.org/repos/asf/knox/repo
Commit: http://git-wip-us.apache.org/repos/asf/knox/commit/35e7173b
Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/35e7173b
Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/35e7173b
Branch: refs/heads/v0.13.0
Commit: 35e7173bb36ea65c1037d114d229ea1e409ef874
Parents: b9b0db2
Author: Larry McCay <lm...@hortonworks.com>
Authored: Sat Aug 12 18:05:02 2017 -0400
Committer: Larry McCay <lm...@hortonworks.com>
Committed: Mon Aug 14 10:11:36 2017 -0400
----------------------------------------------------------------------
.../src/main/resources/samples/README | 32 ++++++++++++++++++--
1 file changed, 30 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/knox/blob/35e7173b/gateway-shell-samples/src/main/resources/samples/README
----------------------------------------------------------------------
diff --git a/gateway-shell-samples/src/main/resources/samples/README b/gateway-shell-samples/src/main/resources/samples/README
index 3e59836..e25466d 100644
--- a/gateway-shell-samples/src/main/resources/samples/README
+++ b/gateway-shell-samples/src/main/resources/samples/README
@@ -8,6 +8,34 @@ from the service components of a Hadoop cluster.
Depending on exactly how your Knox installation was done, there will be some number of
steps required in order fully install and configure the samples for use in your environment.
-Please see the following section within the Apache Knox Users Guide:
+Please see the following section from the Apache Knox Users Guide:
-http://knox.apache.org/books/knox-0-5-0/knox-0-5-0.html#Gateway+Samples
\ No newline at end of file
+Gateway Samples
+
+The purpose of the samples within the {GATEWAY_HOME}/samples directory is to demonstrate the capabilities
+of the Apache Knox Gateway to provide access to the numerous APIs that are available from the service
+components of a Hadoop cluster.
+
+Depending on exactly how your Knox installation was done, there will be some number of steps required in
+order fully install and configure the samples for use.
+
+This section will help describe the assumptions of the samples and the steps to get them to work in a couple
+of different deployment scenarios.
+
+Assumptions of the Samples
+
+The samples were initially written with the intent of working out of the box for the various Hadoop demo
+environments that are deployed as a single node cluster inside of a VM. The following assumptions were made
+from that context and should be understood in order to get the samples to work in other deployment scenarios:
+
+* That there is a valid java JDK on the PATH for executing the samples
+* The Knox Demo LDAP server is running on localhost and port 33389 which is the default port for the
+ApacheDS LDAP server.
+* That the LDAP directory in use has a set of demo users provisioned with the convention of username
+and username“-password” as the password. Most of the samples have some variation of this pattern with
+“guest” and “guest-password”.
+* That the Knox Gateway instance is running on the same machine which you will be running the samples
+from - therefore “localhost” and that the default port of “8443” is being used.
+* Finally, that there is a properly provisioned sandbox.xml topology in the
+{GATEWAY_HOME}/conf/topologies directory that is configured to point to the actual host and ports of
+running service components.