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:13:22 UTC
[2/3] knox git commit: KNOX-992 - Add README for the knoxshell
distribution (Colm O hEigeartaigh and lmccay via lmccay)
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/c7c5581d
Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/c7c5581d
Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/c7c5581d
Branch: refs/heads/master
Commit: c7c5581de387f6804b786d6b1fa5ccc0633909cd
Parents: 9b4be5e
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:13:00 2017 -0400
----------------------------------------------------------------------
gateway-shell-release/home/README | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/knox/blob/c7c5581d/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.