Repository: incubator-ranger Updated Branches: refs/heads/master 76f7c2944 -> 28a401f42
RANGER-181: moving Ranger Site (ranger.incubator.apache.org) document into ranger repo Project: http://git-wip-us.apache.org/repos/asf/incubator-ranger/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ranger/commit/28a401f4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ranger/tree/28a401f4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ranger/diff/28a401f4 Branch: refs/heads/master Commit: 28a401f426ea4806d2346b5cbad21a78686b3226 Parents: 76f7c29 Author: sneethiraj <[email protected]> Authored: Wed Nov 26 21:53:49 2014 -0500 Committer: sneethiraj <[email protected]> Committed: Wed Nov 26 21:53:49 2014 -0500 ---------------------------------------------------------------------- docs/DEPENDENCIES | 199 +++++++++++++ docs/LICENSE | 202 ++++++++++++++ docs/NOTICE | 8 + docs/README.txt | 53 ++++ docs/pom.xml | 339 +++++++++++++++++++++++ docs/src/site/apt/index.apt.vm | 67 +++++ docs/src/site/fml/faq.fml | 144 ++++++++++ docs/src/site/resources/logo/rangerlogo.png | Bin 0 -> 41966 bytes docs/src/site/site.xml | 76 +++++ docs/src/site/xdoc/quick_start_guide.xml | 189 +++++++++++++ docs/src/site/xdoc/wiki.xml | 33 +++ 11 files changed, 1310 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/DEPENDENCIES ---------------------------------------------------------------------- diff --git a/docs/DEPENDENCIES b/docs/DEPENDENCIES new file mode 100644 index 0000000..794d516 --- /dev/null +++ b/docs/DEPENDENCIES @@ -0,0 +1,199 @@ +// ------------------------------------------------------------------ +// Transitive dependencies of this project determined from the +// maven pom organized by organization. +// ------------------------------------------------------------------ + +Apache Maven Site Plugin + + +From: 'an unknown organization' + - antlr antlr:antlr:jar:2.7.2 + + - FindBugs-jsr305 (http://findbugs.sourceforge.net/) com.google.code.findbugs:jsr305:jar:2.0.1 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - commons-beanutils commons-beanutils:commons-beanutils:jar:1.7.0 + + - dom4j dom4j:dom4j:jar:1.1 + + - servlet-api javax.servlet:servlet-api:jar:2.5 + + - Plexus Cipher: encryption/decryption Component (http://spice.sonatype.org/plexus-cipher) org.sonatype.plexus:plexus-cipher:jar:1.4 + License: Apache Public License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) + - Plexus Security Dispatcher Component (http://spice.sonatype.org/plexus-sec-dispatcher) org.sonatype.plexus:plexus-sec-dispatcher:jar:1.3 + License: Apache Public License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) + - Sisu - Guice (http://forge.sonatype.com/sisu-guice/) org.sonatype.sisu:sisu-guice:pom:2.1.7 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - XZ for Java (http://tukaani.org/xz/java.html) org.tukaani:xz:jar:1.2 + License: Public Domain + - oro oro:oro:jar:2.0.8 + + - XMLUnit for Java (http://xmlunit.sourceforge.net/) xmlunit:xmlunit:jar:1.5 + License: BSD License (http://xmlunit.svn.sourceforge.net/viewvc/*checkout*/xmlunit/trunk/xmlunit/LICENSE.txt) + +From: 'Apache Software Foundation' (http://velocity.apache.org/) + - VelocityTools (http://velocity.apache.org/tools/devel/) org.apache.velocity:velocity-tools:jar:2.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'Apache Software Foundation' (http://www.apache.org/) + - HttpClient (http://hc.apache.org/httpcomponents-client) org.apache.httpcomponents:httpclient:jar:4.0.2 + License: Apache License (../LICENSE.txt) + - HttpCore (http://hc.apache.org/httpcomponents-core/) org.apache.httpcomponents:httpcore:jar:4.0.1 + License: Apache License (http://www.apache.org/licenses/LICENSE-2.0.html) + - Struts Core (http://struts.apache.org) org.apache.struts:struts-core:jar:1.3.8 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Struts Taglib (http://struts.apache.org) org.apache.struts:struts-taglib:jar:1.3.8 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Struts Tiles (http://struts.apache.org) org.apache.struts:struts-tiles:jar:1.3.8 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - XML Commons External Components XML APIs (http://xml.apache.org/commons/components/external/) xml-apis:xml-apis:jar:1.3.04 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'Codehaus' (http://www.codehaus.org/) + - Plexus Archiver Component (http://plexus.codehaus.org/plexus-components/plexus-archiver) org.codehaus.plexus:plexus-archiver:jar:2.4.3 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus Classworlds (http://plexus.codehaus.org/plexus-classworlds/) org.codehaus.plexus:plexus-classworlds:jar:2.2.3 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus :: Component Annotations (http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/) org.codehaus.plexus:plexus-component-annotations:jar:1.5.5 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Default Plexus Container org.codehaus.plexus:plexus-container-default:jar:1.0-alpha-30 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus I18N Component (http://plexus.codehaus.org/plexus-components/plexus-i18n) org.codehaus.plexus:plexus-i18n:jar:1.0-beta-7 + + - Plexus Interpolation API (http://plexus.codehaus.org/plexus-components/plexus-interpolation) org.codehaus.plexus:plexus-interpolation:jar:1.14 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus IO Components (http://plexus.codehaus.org/plexus-components/plexus-io) org.codehaus.plexus:plexus-io:jar:2.0.8 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus Common Utilities (http://plexus.codehaus.org/plexus-utils) org.codehaus.plexus:plexus-utils:jar:3.0.15 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Plexus Velocity Component (http://plexus.codehaus.org/plexus-components/plexus-velocity) org.codehaus.plexus:plexus-velocity:jar:1.1.8 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'Mort Bay Consulting' (http://www.mortbay.com) + - Jetty Server (http://www.eclipse.org/jetty/jetty-parent/project/modules/jetty) org.mortbay.jetty:jetty:jar:6.1.25 + License: Apache Software License - Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) License: Eclipse Public License - Version 1.0 (http://www.eclipse.org/org/documents/epl-v10.php) + - Jetty Utilities (http://www.eclipse.org/jetty/jetty-parent/project/jetty-util) org.mortbay.jetty:jetty-util:jar:6.1.25 + License: Apache Software License - Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) License: Eclipse Public License - Version 1.0 (http://www.eclipse.org/org/documents/epl-v10.php) + - Servlet Specification API (http://jetty.mortbay.org/servlet-api) org.mortbay.jetty:servlet-api:jar:2.5-20081211 + License: Apache License Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) + +From: 'ObjectWeb' (http://www.objectweb.org/) + - ASM Core (http://asm.objectweb.org/asm/) org.ow2.asm:asm:jar:4.1 + License: BSD (http://asm.objectweb.org/license.html) + - ASM Analysis (http://asm.objectweb.org/asm-analysis/) org.ow2.asm:asm-analysis:jar:4.1 + License: BSD (http://asm.objectweb.org/license.html) + - ASM Tree (http://asm.objectweb.org/asm-tree/) org.ow2.asm:asm-tree:jar:4.1 + License: BSD (http://asm.objectweb.org/license.html) + - ASM Util (http://asm.objectweb.org/asm-util/) org.ow2.asm:asm-util:jar:4.1 + License: BSD (http://asm.objectweb.org/license.html) + +From: 'org.parboiled' (http://parboiled.org) + - parboiled-core (http://parboiled.org) org.parboiled:parboiled-core:jar:1.1.4 + License: Apache 2 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - parboiled-java (http://parboiled.org) org.parboiled:parboiled-java:jar:1.1.4 + License: Apache 2 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'org.pegdown' (http://pegdown.org) + - pegdown (http://pegdown.org) org.pegdown:pegdown:jar:1.2.1 + License: Apache 2 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'Sonatype, Inc.' (http://www.sonatype.com) + - Aether :: API (http://aether.sonatype.org/aether-api/) org.sonatype.aether:aether-api:jar:1.7 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Aether :: Implementation (http://aether.sonatype.org/aether-impl/) org.sonatype.aether:aether-impl:jar:1.7 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Aether :: SPI (http://aether.sonatype.org/aether-spi/) org.sonatype.aether:aether-spi:jar:1.7 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Aether :: Utilities (http://aether.sonatype.org/aether-util/) org.sonatype.aether:aether-util:jar:1.7 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Sisu - Inject (JSR330 bean support) (http://sisu.sonatype.org/sisu-inject/guice-bean/sisu-inject-bean/) org.sonatype.sisu:sisu-inject-bean:bundle:1.4.2 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Sisu - Inject (Plexus bean support) (http://sisu.sonatype.org/sisu-inject/guice-bean/guice-plexus/sisu-inject-plexus/) org.sonatype.sisu:sisu-inject-plexus:bundle:1.4.2 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'Steve Ditlinger' (http://sslext.sourceforge.net/) + - sslext sslext:sslext:jar:1.2-0 + License: Apache Software License, Version 1.1 (http://www.apache.org/licenses/LICENSE-1.1) + +From: 'The Apache Software Foundation' (http://jakarta.apache.org) + - Commons Chain (http://jakarta.apache.org/commons/${pom.artifactId.substring(8)}/) commons-chain:commons-chain:jar:1.1 + License: The Apache Software License, Version 2.0 (/LICENSE.txt) + - Codec (http://jakarta.apache.org/commons/codec/) commons-codec:commons-codec:jar:1.3 + License: The Apache Software License, Version 2.0 (/LICENSE.txt) + - Digester (http://jakarta.apache.org/commons/digester/) commons-digester:commons-digester:jar:1.8 + License: The Apache Software License, Version 2.0 (/LICENSE.txt) + - Validator (http://jakarta.apache.org/commons/${pom.artifactId.substring(8)}/) commons-validator:commons-validator:jar:1.3.1 + License: The Apache Software License, Version 2.0 (/LICENSE.txt) + +From: 'The Apache Software Foundation' (http://www.apache.org/) + - Commons Collections (http://commons.apache.org/collections/) commons-collections:commons-collections:jar:3.2.1 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Commons IO (http://commons.apache.org/io/) commons-io:commons-io:jar:1.4 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Commons Lang (http://commons.apache.org/lang/) commons-lang:commons-lang:jar:2.5 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Commons Logging (http://commons.apache.org/logging) commons-logging:commons-logging:jar:1.1.1 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Commons Compress (http://commons.apache.org/compress/) org.apache.commons:commons-compress:jar:1.5 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Aether Provider (http://maven.apache.org/maven-aether-provider/) org.apache.maven:maven-aether-provider:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Archiver (http://maven.apache.org/shared/maven-archiver/) org.apache.maven:maven-archiver:jar:2.4.2 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Artifact (http://maven.apache.org/maven-artifact/) org.apache.maven:maven-artifact:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Core (http://maven.apache.org/maven-core/) org.apache.maven:maven-core:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Model (http://maven.apache.org/maven-model/) org.apache.maven:maven-model:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Model Builder (http://maven.apache.org/maven-model-builder/) org.apache.maven:maven-model-builder:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Plugin API (http://maven.apache.org/maven-plugin-api/) org.apache.maven:maven-plugin-api:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Repository Metadata Model (http://maven.apache.org/maven-repository-metadata/) org.apache.maven:maven-repository-metadata:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Settings (http://maven.apache.org/maven-settings/) org.apache.maven:maven-settings:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Settings Builder (http://maven.apache.org/maven-settings-builder/) org.apache.maven:maven-settings-builder:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Core (http://maven.apache.org/doxia/doxia/doxia-core/) org.apache.maven.doxia:doxia-core:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Decoration Model (http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/) org.apache.maven.doxia:doxia-decoration-model:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Integration Tools (http://maven.apache.org/doxia/doxia-tools/doxia-integration-tools/) org.apache.maven.doxia:doxia-integration-tools:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Logging API (http://maven.apache.org/doxia/doxia/doxia-logging-api/) org.apache.maven.doxia:doxia-logging-api:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: APT Module (http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-apt/) org.apache.maven.doxia:doxia-module-apt:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: FML Module (http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fml/) org.apache.maven.doxia:doxia-module-fml:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Markdown Module (http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown/) org.apache.maven.doxia:doxia-module-markdown:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: XDoc Module (http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xdoc/) org.apache.maven.doxia:doxia-module-xdoc:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: XHTML Module (http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xhtml/) org.apache.maven.doxia:doxia-module-xhtml:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Sink API (http://maven.apache.org/doxia/doxia/doxia-sink-api/) org.apache.maven.doxia:doxia-sink-api:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Doxia :: Site Renderer (http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/) org.apache.maven.doxia:doxia-site-renderer:jar:1.6 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Reporting API (http://maven.apache.org/shared/maven-reporting-api/) org.apache.maven.reporting:maven-reporting-api:jar:3.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Apache Maven Reporting Executor (http://maven.apache.org/shared/maven-reporting-exec/) org.apache.maven.reporting:maven-reporting-exec:jar:1.2 + License: Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Shared Utils (http://maven.apache.org/shared/maven-shared-utils/) org.apache.maven.shared:maven-shared-utils:jar:0.3 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Maven Wagon API (http://maven.apache.org/wagon/wagon-provider-api) org.apache.maven.wagon:wagon-provider-api:jar:1.0 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Apache Velocity (http://velocity.apache.org/engine/releases/velocity-1.5/) org.apache.velocity:velocity:pom:1.5 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + - Xerces2 Java Parser (http://xerces.apache.org/xerces2-j) xerces:xercesImpl:jar:2.9.1 + License: The Apache Software License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) + +From: 'The Eclipse Foundation' (http://www.eclipse.org/) + - Aether Utilities (http://www.eclipse.org/aether/aether-util/) org.eclipse.aether:aether-util:jar:0.9.0.M2 + License: Eclipse Public License, Version 1.0 (http://www.eclipse.org/legal/epl-v10.html) + + + + http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/LICENSE ---------------------------------------------------------------------- diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/NOTICE ---------------------------------------------------------------------- diff --git a/docs/NOTICE b/docs/NOTICE new file mode 100644 index 0000000..623c914 --- /dev/null +++ b/docs/NOTICE @@ -0,0 +1,8 @@ + +Apache Maven Site Plugin +Copyright 2002-2014 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + + http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/README.txt ---------------------------------------------------------------------- diff --git a/docs/README.txt b/docs/README.txt new file mode 100644 index 0000000..b79c29e --- /dev/null +++ b/docs/README.txt @@ -0,0 +1,53 @@ +# 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. + +# --------------------------------------------------------------------- +# Build Instruction for Apache Ranger Documentation +# --------------------------------------------------------------------- + +$ cd ${DOC_SRC_DIR} + +$ mvn site + + +# --------------------------------------------------------------------- +# Deployment instruction +# --------------------------------------------------------------------- + +DOC_DEPLOY_DIR=/tmp/doc_deploy_dir.$$ +mkdir -p ${DOC_DEPLOY_DIR} +svn co https://svn.apache.org/repos/asf/incubator/ranger/site/trunk ranger + +cd ${DOC_SRC_DIR}/target +cp -r * ${DOC_DEPLOY_DIR}/ranger/ + +cd ${DOC_DEPLOY_DIR}/ranger + +# +# The following command should show list of changes to be committed in SVN repo +# +svn status + +# For adding any new files, use the following command +# svn add PATH + +# For deleteing any existing file, use the following command +# svn delete PATH + +# +# The following command should commit the changes to SVN repo +# + +svn commit http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/pom.xml ---------------------------------------------------------------------- diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000..c146973 --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,339 @@ +<?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. + --> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <name>Apache Ranger</name> + <description> + Apache Ranger is a framework to enable, monitor and manage comprehensive data security across the Hadoop platform. Apache Ranger currently provides a centralized security adminstration, fine grain access control and detailed auditing for user access within Apache Hadoop, Apache Hive, Apache HBase and other Apache components + + </description> + <url>http://ranger.incubator.apache.org/</url> + <modelVersion>4.0.0</modelVersion> + + <groupId>org.incubator.apache.ranger</groupId> + <version>0.4</version> + <artifactId>ranger</artifactId> + <packaging>pom</packaging> + + + <licenses> + <license> + <name>Apache 2</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + </license> + </licenses> + + <scm> + <connection>scm:svn:https://svn.apache.org/repos/asf/incubator/ranger/site/trunk</connection> + <developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/ranger/site/trunk</developerConnection> + <tag>HEAD</tag> + <url>http://svn.apache.org/repos/asf/incubator/ranger/site/trunk</url> + </scm> + + <issueManagement> + <system>Jira</system> + <url>http://issues.apache.org/jira/browse/ranger</url> + </issueManagement> + + <mailingLists> + <mailingList> + <name>User list</name> + <subscribe>mailto:[email protected] + </subscribe> + <unsubscribe>mailto:[email protected] + </unsubscribe> + <post>mailto:[email protected]</post> + <archive>http://mail-archives.apache.org/mod_mbox/ranger-user/</archive> + </mailingList> + <mailingList> + <name>Development list</name> + <subscribe>mailto:[email protected] + </subscribe> + <unsubscribe>mailto:[email protected] + </unsubscribe> + <post>mailto:[email protected]</post> + <archive>http://mail-archives.apache.org/mod_mbox/ranger-dev/</archive> + </mailingList> + <mailingList> + <name>Commit list</name> + <subscribe>mailto:[email protected] + </subscribe> + <unsubscribe>mailto:[email protected] + </unsubscribe> + <post>mailto:[email protected]</post> + <archive>http://mail-archives.apache.org/mod_mbox/ranger-commits/</archive> + </mailingList> + </mailingLists> + <developers> + <developer> + <id>agates</id> + <name>Alan Gates</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Mentor</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>bganesan</id> + <name>Balaji Ganesan</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>ddruno</id> + <name>Daniel Gruno</name> + <email>[email protected]</email> + <timezone>+1</timezone> + <roles> + <role>Mentor</role> + </roles> + <organization> + Quokka IvS + </organization> + </developer> + <developer> + <id>ddas</id> + <name>Devaraj Das</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>PMC</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>ddorai</id> + <name>Dilli Arumugam</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>bdurai</id> + <name>Don Bosco Durai</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>jghoman</id> + <name>Jakob Homan</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Mentor</role> + </roles> + <organization> + Microsoft + </organization> + </developer> + <developer> + <id>kminder</id> + <name>Kevin Minder</name> + <email>[email protected]</email> + <timezone>-5</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>lmccay</id> + <name>Larry Mccay</name> + <email>[email protected]</email> + <timezone>-5</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>mneethiraj</id> + <name>Madhanmohan Neethiraj</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>omalley</id> + <name>Owen O'Malley</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Champion, Committer, Mentor</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>rmani</id> + <name>Ramesh Mani</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>sradia</id> + <name>Sanjay Radia</name> + <email>[email protected]</email> + <timezone>-8</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + <developer> + <id>sneethiraj</id> + <name>Selvamohan Neethiraj</name> + <email>[email protected]</email> + <timezone>-5</timezone> + <roles> + <role>Committer</role> + </roles> + <organization> + Hortonworks + </organization> + </developer> + </developers> + <contributors> + <contributor> + </contributor> + </contributors> + + <organization> + <name>Apache Software Foundation</name> + <url>http://www.apache.org/</url> + </organization> + + <build> + <resources> + <resource> + <directory>src/main/resources</directory> + <filtering>true</filtering> + </resource> + </resources> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-resources-plugin</artifactId> + <version>2.4.3</version> + <configuration> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + <plugin> + <artifactId>maven-site-plugin</artifactId> + <version>3.3</version> + </plugin> + <plugin> + <inherited>true</inherited> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.3</version> + <configuration> + <outputDirectory>./target</outputDirectory> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> + + <reporting> + <excludeDefaults>true</excludeDefaults> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.4</version> + <reportSets> + <reportSet> + <reports> + <report>project-team</report> + <report>mailing-list</report> + <report>issue-tracking</report> + <report>license</report> + <report>summary</report> + <!-- for now + <report>modules</report> + <report>dependencies</report> + <report>cim</report> + <report>scm</report> + --> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> + + <distributionManagement> + <site> + <id>apache-website</id> + <name>Apache website</name> + <url>scpexe://people.apache.org/www/incubator.apache.org/ranger</url> + </site> + </distributionManagement> + +</project> http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/apt/index.apt.vm ---------------------------------------------------------------------- diff --git a/docs/src/site/apt/index.apt.vm b/docs/src/site/apt/index.apt.vm new file mode 100644 index 0000000..0b7ab30 --- /dev/null +++ b/docs/src/site/apt/index.apt.vm @@ -0,0 +1,67 @@ + ------ + Introduction + ------ + Maria Odea Ching + ------ + 2013-07-22 + ------ + + ~~ 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. + + ~~ NOTE: For help with the syntax of this file, see: + ~~ http://maven.apache.org/doxia/references/apt-format.html + + +${project.name} + + Ranger is a framework to enable, monitor and manage comprehensive data security across the Hadoop platform. + + The vision with Ranger is to provide comprehensive security across the Apache Hadoop ecosystem. With the advent of Apache YARN, the Hadoop platform can now support a true data lake architecture. Enterprises can potentially run multiple workloads, in a multi tenant environment. Data security within Hadoop needs to evolve to support multiple use cases for data access, while also providing a framework for central administration of security policies and monitoring of user access. + + Please read the {{{./faq.html}FAQs}} if you need to understand how it works over Apache Hadoop components. + +* Goals Overview + + Apache Ranger has the following goals: + + * Centralized security administration to manage all security related tasks in a central UI or using REST APIs. + + * Fine grained authorization to do a specific action and/or operation with Hadoop component/tool and managed through a central administration tool + + * Standardize authorization method across all Hadoop components. + + * Enhanced support for different authorization methods - Role based access control, attribute based access control etc. + + * Centralize auditing of user access and administrative actions (security related) within all the components of Hadoop. + + +* Usage + + General instructions on how to use the Apache Ranger can be found on the {{{./wiki.html}Wiki Page}}. + + In case you have questions regarding the Ranger' usage, please have a look at the {{{./faq.html}FAQ}} and feel + free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could + already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching + the {{{./mail-lists.html}mail archive}}. + + If you feel like the Apache Ranger is missing a feature or has a defect, you can fill a feature request or bug report in our + {{{https://issues.apache.org/jira/browse/ranger/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel}issue tracker}}. When creating a new issue, please provide a comprehensive description of your + concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. + + Contributors can check out the source codefrom our + {{{http://git.apache.org/incubator-ranger.git/}Git repository}} http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/fml/faq.fml ---------------------------------------------------------------------- diff --git a/docs/src/site/fml/faq.fml b/docs/src/site/fml/faq.fml new file mode 100644 index 0000000..5bfbdeb --- /dev/null +++ b/docs/src/site/fml/faq.fml @@ -0,0 +1,144 @@ +<?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. +--> + +<faqs xmlns="http://maven.apache.org/FML/1.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/FML/1.0 http://maven.apache.org/xsd/fml-1.0.xsd"; id="FAQ" title="Frequently Asked Questions"> + <part id="General"> + <title>General</title> + <faq id="What does Apache Ranger offer for Hadoop"> + <question>What does Apache Ranger offer for Apache Hadoop and related components?</question> + <answer> + <p> + Apache Ranger offers a centralized security framework to manage fine grained access control over Hadoop and related components (Apache Hive, HBase etc.). Using Ranger administration console, users can easily manage policies around accessing a resource (file, folder, database, table, column etc) for a particular set of users and/or groups, and enforce the policies within Hadoop. They also can enable audit tracking and policy analytics for deeper control of the environment. Rangerâ solution also provides ability to delegate administration of certain data to other group owners, with an aim of decentralizing data ownership + </p> + </answer> + </faq> + <faq id="What components does Apache Ranger support today"> + <question>What projects does Apache Ranger support today</question> + <answer> + <p> + Apache Ranger supports fine grained authorization and auditing for following Apache projects: + </p> + <ul> + <li>Apache Hadoop</li> + <li>Apache Hive</li> + <li>Apache HBase</li> + <li>Apache Storm</li> + <li>Apache Knox</li> + </ul> + </answer> + </faq> + + <faq id="How does it work over Hadoop and related components"> + <question>How does it work over Hadoop and related components</question> + <answer> + <p> + Apache Ranger' solution at the core has a centralized web application, which consists of the policy administration, audit and reporting modules. Authorized users will be able to manage their security policies using the web tool or using REST APIs. These security policies are enforced within Hadoop ecosystem using lightweight Ranger Java plugins, which run as part of the same process as the namenode (HDFS), Hive2Server(Hive), HBase server (Hbase), Nimbus server (Storm) and Knox server (Knox) respectively. Thus there is no additional OS level process to manage. + </p> + </answer> + </faq> + <faq id="Is there a single point of failure?"> + <question>Is there a single point of failure?</question> + <answer> + <p> + No, Apache Ranger is not a Single Point of Failure. Ranger' plugins run within the same process as the component, e.g. NameNode for HDFS. These agents pull the policy-changes using REST API at a configured regular interval (e.g.: 30 second). The plugin is able to function even if the policy server is temporarily down and will provide the authorization enforcement. Also, the policy manager web application can be hosted on a HA infrastructure. (with multiple apache server, multiple tomcat servers and a standby database server w/o replication setup). + </p> + </answer> + </faq> + </part> + + <part id="Apache Hadoop"> + <title>Apache Hadoop</title> + <faq id="How does Ranger provide authorization in Apache Hadoop"> + <question>How does Ranger provide authorization in Apache Hadoop?</question> + <answer> + <p> + Ranger provides a plugin for Apache Hadoop, specifically for the NameNode as part of the authorization method. Ranger' plugin is in the path of the user request and is able to make a decision on whether the user request shoud be authorized. The plugin also collects access request details required for auditing + </p> + <p> + Ranger will enforce the security policies available in the policy database. Users can create a security policy for a specific set of resources (one or more folders and/or files) and assign specific set of permissions (e.g: read, write, execute) to a specific set of users and/or groups. The security policies are stored our policy manager and are independent from native permissions. + </p> + </answer> + </faq> + <faq id="Does Ranger emulate native unix level permissions?"> + <question>Does Ranger emulated permissions at the unix level for Apache Hadoop?</question> + <answer> + <p> + No, Ranger enforces authorization based on policies entered in the policy administration tool and does not emulate the permissions at the unix level. Ranger does provide a defaut feature to validate access using native hadoop file-level permissions if the Ranger policies do not cover the requested access + </p> + </answer> + </faq> + + <faq id="Do we need an Ranger plugin in each datanode?"> + <question>Does Argun plugin need to be implemented in each datanode ?</question> + <answer> + <p> + No, Ranger plugin for Hadoop is only needed in the NameNode. + + </p> + </answer> + </faq> + +</part> + <part id="Apache Hive"> + <title>Apache Hive</title> + <faq id="How does Ranger provide authorization in Apache Hive"> + <question>How does Ranger provide authorization in Apache Hive?</question> + <answer> + <p> + Ranger plugin is enabled in Hiveserver2 as part of the authorization + </p> + </answer> + </faq> + + <faq id="How does Ranger authorization compared to SQL standard authorization"> + <question>How does Ranger authorization compare to SQL standard authorization?</question> + <answer> + <p> + Apache Hive currently provides two methods of authorization, Storage based authorization and SQL standard authorization, which was introduced in Hive 13. SQL standard authorization provides grant/revoke functionality at database, table level. The commands would be familiar to a DBA admin. Ranger provides a centralized authorization interface for Hive and provides more granular access control at column level through the Hive plugin. Ranger also provides ability to use wildcard in resource names within the policy. + </p> + </answer> + </faq> + +</part> + +<part id="Apache HBase"> + <title>Apache HBase</title> + <faq id="How does Ranger provide authorization in Apache HBase"> + <question>How does Ranger provide authorization in Apache Hbase?</question> + <answer> + <p> + Ranger provides a coprocessor which added to HBase, and includes the logic to perform authorization check and collect audit data. + </p> + </answer> + </faq> +</part> +<part id="Apache Knox"> + <title>Apache Knox</title> + <faq id="How does Ranger provide authorization in Apache Knox"> + <question>How does Ranger provide authorization in Apache Knox?</question> + <answer> + <p> + Apache Knox currently provides a service level authorization for users/groups. These acls are stored locally in a file. Ranger has built a plugin for Knox to enable administration of these policies through central UI/REST APIs as well as detailed auditing of Knox user access. + </p> + </answer> + </faq> +</part> +</faqs> http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/resources/logo/rangerlogo.png ---------------------------------------------------------------------- diff --git a/docs/src/site/resources/logo/rangerlogo.png b/docs/src/site/resources/logo/rangerlogo.png new file mode 100644 index 0000000..e262c11 Binary files /dev/null and b/docs/src/site/resources/logo/rangerlogo.png differ http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/site.xml ---------------------------------------------------------------------- diff --git a/docs/src/site/site.xml b/docs/src/site/site.xml new file mode 100644 index 0000000..4d863af --- /dev/null +++ b/docs/src/site/site.xml @@ -0,0 +1,76 @@ +<?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. +--> + +<project xmlns="http://maven.apache.org/DECORATION/1.3.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd";> +<skin> + <groupId>org.apache.maven.skins</groupId> + <artifactId>maven-fluido-skin</artifactId> + <version>1.3.1</version> + </skin> + +<bannerLeft> + <name>Argus logo</name> + <src>/logo/rangerlogo.png</src> + <height>200px</height> + <width>400px</width> + <href></href> +</bannerLeft> + +<bannerRight> + <src></src> +</bannerRight> + +<body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="FAQ" href="faq.html"/> + </menu> + <menu name="Resources"> + <item name="Quick Start Guide" href="quick_start_guide.html"/> + <!-- According to http://jira.codehaus.org/browse/MNGSITE-152 --> + <item name="License" href="http://www.apache.org/licenses/"/> + </menu> + <menu name="Project Information"> + <item name="Project Summary" href="project-summary.html"/> + <item name="Mailing Lists" href="mail-lists.html"/> + <item name ="Team" href="team-list.html"/> + </menu> +</body> + +<poweredBy> + <logo name="Maven" href="http://maven.apache.org/"img="http://maven.apache.org/images/logos/maven-feather.png"/> +</poweredBy> +<custom> + <fluidoSkin> + <sideBarEnabled>true</sideBarEnabled> + <sourceLineNumbersEnabled>true</sourceLineNumbersEnabled> + <twitter> + <user>apacheargus</user> + <showUser>true</showUser> + <showFollowers>true</showFollowers> + </twitter> + <facebookLike /> + <skipGenerationDate>true</skipGenerationDate> + </fluidoSkin> +</custom> +</project> http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/xdoc/quick_start_guide.xml ---------------------------------------------------------------------- diff --git a/docs/src/site/xdoc/quick_start_guide.xml b/docs/src/site/xdoc/quick_start_guide.xml new file mode 100644 index 0000000..dcd5987 --- /dev/null +++ b/docs/src/site/xdoc/quick_start_guide.xml @@ -0,0 +1,189 @@ +<!-- + 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. +--> +<document> + <properties> + <author email="[email protected]">Balaji Ganesan</author> + <title>Build and Check Release</title> + </properties> + <!-- Optional HEAD element, which is copied as is into the XHTML <head> element --> + <head> + </head> + <body> + <!-- The body of the document contains a number of sections --> + <section name="Quick Start Guide"> + <subsection name = "Build Process"> + <!-- Within sections, any XHTML can be used --> + <p> + 1. Check out the code from GIT repository + </p> + <ul> + <source>git clone git://git.apache.org/incubator-ranger.git</source> + <source>cd incubator-ranger </source> + </ul> + + <p> + 2. Please execute the following Maven command: + </p> + <ul> + <source>$ export JAVA_HOME=%jdk 7 Home%</source> + <source> $ mvn clean </source> + <source> $ mvn -DskipTests=false clean compile package install assembly:assembly </source> + </ul> + <p> + 3. After the above build command execution, you should see the following TAR files in the target folder: + </p> + <source> + ranger-%version-number%-admin.tar.gz + ranger-%version-number%-usersync.tar.gz + ranger-%version-number%-hdfs-plugin.tar.gz + ranger-%version-number%-hive-plugin.tar.gz + ranger-%version-number%-hbase-plugin.tar.gz + ranger-%version-number%-knox-plugin.tar.gz + ranger-%version-number%-storm-plugin.tar.gz + </source> + <!-- in addition to XHTML, any number of subsections can be within a section --> + </subsection> + + <subsection name= "Create an Apache Release"> + + <p> + 1. Checkout from ranger release branch + </p> + <ul> + <source>$ git checkout ranger-%version%</source> + </ul> + + <p> + 2. Run maven commands to build and validate the build is working fine + (See Build Process: step 2): + </p> + <ul> + <source>$ export JAVA_HOME=%jdk 7 Home%</source> + <source> $ mvn clean </source> + <source> $ mvn -DskipTests=false clean compile package install assembly:assembly </source> + </ul> + <p> + 3. Clean all generated files for building the source build + <source> + $ mvn clean + </source> + </p> + <p> + 4. Create a TAR source file using the following command: + <source> + $ tar zcf %relDir%/ranger-%version-number%.tar.gz \ + --exclude="./.git" --exclude="./.gitignore" --exclude="./.settings/*" \ + --exclude="./.classpath" --exclude="./.project" --exclude="./winpkg/*" \ + --exclude="./hdfs-agent/dependency-reduced-pom.xml" . + </source> + </p> + <p> + 5. To create a prefix folder as ranger-%version-number%, do the following commands: + <source> + $ mkdir %relDir%/%tempFolderName% + $ cd %relDir%/%tempFolderName% + $ mkdir ranger-%version-number% + $ cd ranger-%version-number% + $ tar xf %relDir%/ranger-%version-number%.tar.gz + $ find . -name '.DS_Store' -exec rm -f {} \; # required if run on MacOS + $ cd %relDir%/%tempFolderName% + $ rm %relDir%/ranger-%version-number%.tar.gz + $ tar zcf %relDir%/ranger-%version-number%.tar.gz ./ranger-%version-number% + </source> + </p> + <p> + 6. To create a signature for the %relDir%/ranger-%version-number%.tar.gz, do the following commands: + <source> $ gpg --armor --output %relDir%/ranger-%version-number%.tar.gz.asc --detach-sig %relDir%/ranger-%version-number%.tar.gz +</source> + </p> + + <p> + 7. To create MD5/SHA hash for the %relDir%/ranger-%version-number%.tar.gz, do the following commands: + <source> $ gpg --print-mds %relDir%/ranger-%version-number%.tar.gz > %relDir%/ranger-%version-number%.tar.gz.mds</source> + </p> + <p> + 8. Now, the following files are ready to be published for release: + <source> + %relDir%/ranger-%version-number%.tar.gz + %relDir%/ranger-%version-number%.tar.gz.asc + %relDir%/ranger-%version-number%.tar.gz.mds + </source> + </p> + </subsection> + + <subsection name = "Verifying Build (also called as a Release)"> + <p> + 1. Download the release source file, ranger-%build-version%.tar.gz (from URL provided in the release email) + + <ul>2. Download the PGP signature for, ranger-%build-version%.tar.gz which usaully named as ranger-%build-version%.tar.gz.asc(from URL provided in the release email)</ul> + <ul>3. Execute the following command to verify the release </ul> + </p> + <source> $ gpg --verify ranger-%build-version%.tar.gz.asc ranger-%build-version%.tar.gz </source> + + <p> + 4. Download MD5/SHA hash for ranger-%build-version%.tar.gz which usaully named as ranger-%build-version%.tar.gz.mds (from URL provided in the release email) + <source>$ gpg --print-mds ranger-%build-version%.tar.gz </source> + Compare MD5, SHA hash generated from the above command and the signature available in the ranger-%build-version%.tar.gz.mds. + </p> + + </subsection> + <subsection name = "Importing Apache Ranger Project into Eclipse" > + <p> + <ul>1. Create a Eclipse workspace called 'ranger' </ul> + <ul> 2. Import maven project from the root directory where ranger source code is downloaded and build using the following command:</ul> + </p> + <source> + $ export JAVA_HOME=%Jdk 7 Home% + $ mvn clean + $ mvn -DskipTests=false clean compile package install assembly:assembly + $ mvn eclipse:eclipse + </source> + </subsection> + + <subsection name = "Deployment Process" > + <h4>Installation Host Information</h4> + <p> + <ul>1. Ranger Admin Tool Component (ranger-%version-number%-admin.tar.gz) should be installed on a host where Policy Admin Tool web application runs on port 6080 (default).</ul> + <ul>2. Ranger User Synchronization Component (ranger-%version-number%-usersync.tar.gz) should be installed on a host to synchronize the external user/group information into Ranger database via Ranger Admin Tool.</ul> + <ul>3. Ranger Component plugin should be installed on the component boxes:</ul> + <ul>(a) HDFS Plugin needs to be installed on Name Node hosts</ul> + <ul>(b) Hive Plugin needs to be installed on HiveServer2 hosts</ul> + <ul>(c) HBase Plugin needs to be installed on both Master and Regional Server nodes.</ul> + <ul>(d) Knox Plugin needs to be installed on Knox hosts.</ul> + <ul>(e) Storm Plugin needs to be installed on Storm hosts.</ul> + </p> + <h4> Installation Process </h4> + <p> + <ul>1. Download the tar.gz file into a temporary folder in the box where it needs to be installed.</ul> + + <ul>2. Expand the tar.gz file into /usr/lib/ranger/ folder </ul> + + <ul>3. Go to the component name under the expanded folder (e.g. /usr/lib/ranger/ranger-%version-number%-admin/)</ul> + + <ul>4. Modify the install.properties file with appropriate variables </ul> + + <ul> 5. If the module has setup.sh, + <source>Execute ./setup.sh </source> + + If the setup.sh file does not exists, + <source>Execute ./enable-%component%-plugin.sh</source> + </ul> + </p> + </subsection> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/incubator-ranger/blob/28a401f4/docs/src/site/xdoc/wiki.xml ---------------------------------------------------------------------- diff --git a/docs/src/site/xdoc/wiki.xml b/docs/src/site/xdoc/wiki.xml new file mode 100644 index 0000000..93d24d9 --- /dev/null +++ b/docs/src/site/xdoc/wiki.xml @@ -0,0 +1,33 @@ +<!-- + 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. +--> +<document> + <properties> + <author email="[email protected]">Selvamohan Neethiraj</author> + <title>Apache Ranger - Wiki</title> + </properties> + <!-- Optional HEAD element, which is copied as is into the XHTML <head> element --> + <head> + </head> + <body> + <!-- The body of the document contains a number of sections --> + <section name="Work In Progress"> + <p> + We are currently working on building the Wiki for Apache Ranger. Please come and visit us later. + </p> + </section> + </body> +</document>
![http://maven.apache.org/"img="http://maven.apache.org/images/logos/maven-feather.png"/](http://maven.apache.org/"img="http://maven.apache.org/images/logos/maven-feather.png"/){kind=link}