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 2013/08/27 16:22:32 UTC

git commit: KNOX-102 updated readme - replacing obsolete urls and content. Also commented the ShiroDeploymentContributor.

Updated Branches:
  refs/heads/master dfba637bc -> a42e12154


KNOX-102 updated readme - replacing obsolete urls and content. Also commented the ShiroDeploymentContributor.

Project: http://git-wip-us.apache.org/repos/asf/incubator-knox/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-knox/commit/a42e1215
Tree: http://git-wip-us.apache.org/repos/asf/incubator-knox/tree/a42e1215
Diff: http://git-wip-us.apache.org/repos/asf/incubator-knox/diff/a42e1215

Branch: refs/heads/master
Commit: a42e121541b89a4eddebd274ad9a46214610f683
Parents: dfba637
Author: Larry McCay <lm...@hortonworks.com>
Authored: Tue Aug 27 10:22:05 2013 -0400
Committer: Larry McCay <lm...@hortonworks.com>
Committed: Tue Aug 27 10:22:05 2013 -0400

----------------------------------------------------------------------
 .../deploy/impl/ShiroDeploymentContributor.java |  9 +++++-
 gateway-release/home/README                     | 30 +++++++++++---------
 2 files changed, 25 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/a42e1215/gateway-provider-security-shiro/src/main/java/org/apache/hadoop/gateway/deploy/impl/ShiroDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-shiro/src/main/java/org/apache/hadoop/gateway/deploy/impl/ShiroDeploymentContributor.java b/gateway-provider-security-shiro/src/main/java/org/apache/hadoop/gateway/deploy/impl/ShiroDeploymentContributor.java
index d3927ef..10a66ac 100644
--- a/gateway-provider-security-shiro/src/main/java/org/apache/hadoop/gateway/deploy/impl/ShiroDeploymentContributor.java
+++ b/gateway-provider-security-shiro/src/main/java/org/apache/hadoop/gateway/deploy/impl/ShiroDeploymentContributor.java
@@ -46,9 +46,16 @@ public class ShiroDeploymentContributor extends ProviderDeploymentContributorBas
 
   @Override
   public void contributeProvider( DeploymentContext context, Provider provider ) {
+	// Many filter based authentication mechanisms require a ServletContextListener
+	// to be added and the Knox deployment machinery provides the ability to add this
+	// through the DeploymentContext.
+	
     // add servletContextListener
     context.getWebAppDescriptor().createListener().listenerClass( LISTENER_CLASSNAME );
-    // Write the provider specific config out to the war for cluster specific config
+
+    // Writing provider specific config out to the war for cluster specific config can be
+	// accomplished through the DeploymentContext as well. The JBoss shrinkwrap API can be
+	// used to write the asset to the war.
     String config = new ShiroConfig( provider ).toString();
     if( config != null ) {
       context.getWebArchive().addAsWebInfResource( new StringAsset( config ), "shiro.ini" );

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/a42e1215/gateway-release/home/README
----------------------------------------------------------------------
diff --git a/gateway-release/home/README b/gateway-release/home/README
index a3cb194..2208d9d 100644
--- a/gateway-release/home/README
+++ b/gateway-release/home/README
@@ -31,20 +31,23 @@ Description
 ------------------------------------------------------------------------------
 The charter for the Gateway project is to simplify and normalize the
 deployment and implementation of secure Hadoop clusters as well as be
-a centralize access point for the service specific REST APIs exposed from
+a centralized access point for the service specific REST APIs exposed from
 within the cluster.
 
-Milestone-1 of this project intends to demonstrate the ability to dynamically
+The current state of this project provides the ability to dynamically
 provision reverse proxy capabilities with filter chains that meet the cluster
 specific needs for authentication.
 
 HTTP BASIC authentication with identity being asserted to the rest of the
 cluster via Pseudo/Simple authentication will be demonstrated for security.
 
-For API aggregation, the Gateway will provide a central endpoint for HDFS,
-Templeton and Oozie APIs for each cluster.
+In addition to Pseudo identity assertion Knox now provides trusted proxy user
+identity assertion for providing access to Kerberos secured Hadoop clusters.
 
-Future Milestone releases will extend these capabilities with additional
+For API aggregation, the Gateway provides a central endpoint for access to
+ HDFS, Templeton, Hive, HBase, Ambari and Oozie APIs for each cluster.
+
+Future releases will extend these capabilities with additional
 authentication, identity assertion, API aggregation and eventually management
 capabilities.
 
@@ -62,26 +65,27 @@ Please see the ISSUES file.
 Installation
 ------------------------------------------------------------------------------
 Please see the INSTALL file or the Apache Knox Gateway website.
-http://knox.incubator.apache.org/getting-started.html
+https://cwiki.apache.org/confluence/display/KNOX/Getting+Started
 
 ------------------------------------------------------------------------------
 Examples
 ------------------------------------------------------------------------------
 Please see the Apache Knox Gateway website for detailed examples.
-http://knox.incubator.apache.org/examples.html
+https://cwiki.apache.org/confluence/display/KNOX/Examples
 
 ------------------------------------------------------------------------------
 Filing bugs
 ------------------------------------------------------------------------------
-Currently we do not have Jira setup for Knox.  Therefore if you find an issue
-please send an email to the Knox user list (user AT knox.incubator.apache.org)
-with a subject prefix of [BUG] describing the issue.  Please include the
-results of this command in the email.
+We now have Jira setup for Knox. The following link will provide you with
+the information for accessing the Jira setup for Knox:
+http://knox.incubator.apache.org/issue-tracking.html
+
+Please provide the output from the following command in your filed Jira issue:
 
     java -jar bin/gateway-${gateway-version}.jar -version
 
 in the Environment section.  Also include the version of Hadoop being used.
 
-One we have Jira setup the email archive will be reviewed and Jira issues
-created for each bug.
+Please feel free to email the Knox user list as well (user AT knox.incubator.apache.org)
+with a subject prefix of [BUG] describing the issue.