|
| 1 | +# Licensed to the Apache Software Foundation (ASF) under one or more |
| 2 | +# contributor license agreements. See the NOTICE file distributed with |
| 3 | +# this work for additional information regarding copyright ownership. |
| 4 | +# The ASF licenses this file to You under the Apache License, Version 2.0 |
| 5 | +# (the "License"); you may not use this file except in compliance with |
| 6 | +# the License. You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +Check Apache Ranger Wiki for up to date instruction: |
| 17 | +https://cwiki.apache.org/confluence/display/RANGER/Index |
| 18 | + |
| 19 | +NOTE about using sending pull request on github: |
| 20 | +================================================ |
| 21 | +Apache Ranger is currently NOT setup to use pull requests to take in the changes for commit. |
| 22 | +Please use the apache review board to submit your code changes for review and commit. https://reviews.apache.org |
| 23 | +Also create a jira to go along with the review and mention it in the review board review. https://issues.apache.org/jira/browse/RANGER |
| 24 | + |
| 25 | +Build Process |
| 26 | +============= |
| 27 | + |
| 28 | +1. Check out the code from GIT repository |
| 29 | + |
| 30 | +2. On the root folder, please execute the following Maven command: |
| 31 | + |
| 32 | + $ mvn clean compile package install |
| 33 | + $ mvn eclipse:eclipse |
| 34 | + |
| 35 | + (Ranger Admin UI tests depend on PhantomJS. If the build fails with npm or Karma errors you can either |
| 36 | + i. install PhantomJS dependencies for your platform (bzip2 and fontconfig) |
| 37 | + ii. skip JavaScript test execution: mvn -DskipJSTests ...) |
| 38 | + |
| 39 | +3. After the above build command execution, you should see the following TAR files in the target folder: |
| 40 | + |
| 41 | + |
| 42 | + ranger-<version>-admin.tar.gz |
| 43 | + ranger-<version>-atlas-plugin.tar.gz |
| 44 | + ranger-<version>-hbase-plugin.tar.gz |
| 45 | + ranger-<version>-hdfs-plugin.tar.gz |
| 46 | + ranger-<version>-hive-plugin.tar.gz |
| 47 | + ranger-<version>-kafka-plugin.tar.gz |
| 48 | + ranger-<version>-kms.tar.gz |
| 49 | + ranger-<version>-knox-plugin.tar.gz |
| 50 | + ranger-<version>-migration-util.tar.gz |
| 51 | + ranger-<version>-ranger-tools.tar.gz |
| 52 | + ranger-<version>-solr-plugin.tar.gz |
| 53 | + ranger-<version>-sqoop-plugin.tar.gz |
| 54 | + ranger-<version>-src.tar.gz |
| 55 | + ranger-<version>-storm-plugin.tar.gz |
| 56 | + ranger-<version>-tagsync.tar.gz |
| 57 | + ranger-<version>-usersync.tar.gz |
| 58 | + ranger-<version>-yarn-plugin.tar.gz |
| 59 | + ranger-<version>-kylin-plugin.tar.gz |
| 60 | + ranger-<version>-elasticsearch-plugin.tar.gz |
| 61 | + ranger-<version>-ozone-plugin.tar.gz |
| 62 | + ranger-<version>-presto-plugin.tar.gz |
| 63 | + ranger-<version>-schema-registry-plugin.tar.gz |
| 64 | + |
| 65 | +Importing Apache Ranger Project into Eclipse |
| 66 | +============================================ |
| 67 | + |
| 68 | +1. Create a Eclipse workspace called 'ranger' |
| 69 | + |
| 70 | +2. Import maven project from the root directory where ranger source code is downloaded (and build) |
| 71 | + |
| 72 | + |
| 73 | +Deployment Process |
| 74 | +================== |
| 75 | + |
| 76 | +Installation Host Information |
| 77 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 78 | +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). |
| 79 | +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. |
| 80 | +3. Ranger Component plugin should be installed on the component boxes: |
| 81 | + (a) HDFS Plugin needs to be installed on Name Node hosts |
| 82 | + (b) Hive Plugin needs to be installed on HiveServer2 hosts |
| 83 | + (c) HBase Plugin needs to be installed on both Master and Regional Server nodes. |
| 84 | + (d) Knox Plugin needs to be installed on Knox gateway host. |
| 85 | + (e) Storm Plugin needs to be installed on Storm hosts. |
| 86 | + (f) Kafka/Solr Plugin needs to be installed on their respective component hosts. |
| 87 | + (g) YARN plugin needs to be installed on YARN Resource Manager hosts |
| 88 | + (h) Sqoop plugin needs to be installed on Sqoop2 hosts |
| 89 | + (i) Kylin plugin needs to be installed on Kylin hosts |
| 90 | + (j) Elasticsearch plugin needs to be installed on Elasticsearch hosts |
| 91 | + (k) Ozone plugin needs to be installed on Ozone hosts |
| 92 | + (l) Presto plugin needs to be installed on Presto hosts |
| 93 | + (m) Schema Registry plugin needs to be installed on Schema Registry hosts |
| 94 | + |
| 95 | +Installation Process |
| 96 | +~~~~~~~~~~~~~~~~~~~~ |
| 97 | + |
| 98 | +1. Download the tar.gz file into a temporary folder in the box where it needs to be installed. |
| 99 | + |
| 100 | +2. Expand the tar.gz file into /usr/lib/ranger/ folder |
| 101 | + |
| 102 | +3. Go to the component name under the expanded folder (e.g. /usr/lib/ranger/ranger-<version-number>-admin/) |
| 103 | + |
| 104 | +4. Modify the install.properties file with appropriate variables |
| 105 | + |
| 106 | +5. If the module has setup.sh, |
| 107 | + Execute ./setup.sh |
| 108 | + |
| 109 | + If the install.sh file does not exists, |
| 110 | + Execute ./enable-<component>-plugin.sh |
| 111 | + |
0 commit comments