blob: 3c410529b5633ca6d17bc98bfccb8c7582a84864 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.8
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Balaji Ganesan" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Ranger &#x2013; Build and Check Release</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><a href="https://ranger.apache.org" id="bannerLeft"><img src="ranger.jpg" alt="Apache Ranger" width="400px" height="200px"/></a></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2023-03-23<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 3.0.0-SNAPSHOT<span class="divider">|</span></li>
<li class=""><a href="./" title="Ranger">Ranger</a><span class="divider">/</span></li>
<li class="active ">Build and Check Release</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/News" class="externalLink" title="News"><span class="none"></span>News</a> </li>
<li><a href="download.html" title="Download"><span class="none"></span>Download</a> </li>
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li>
<li class="nav-header">Resources</li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Index" class="externalLink" title="Wiki"><span class="none"></span>Wiki</a> </li>
<li class="active"><a href="#"><span class="none"></span>Quick Start Guide</a>
</li>
<li><a href="apidocs/index.html" title="Ranger REST API Documentation"><span class="none"></span>Ranger REST API Documentation</a> </li>
<li><a href="kms/apidocs/index.html" title="Ranger KMS REST API Documentation"><span class="none"></span>Ranger KMS REST API Documentation</a> </li>
<li><a href="https://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a> </li>
<li class="nav-header">Project Information</li>
<li><a href="project-summary.html" title="Project Summary"><span class="none"></span>Project Summary</a> </li>
<li><a href="mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li>
<li><a href="https://issues.apache.org/jira/browse/RANGER" class="externalLink" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li>
<li><a href="team-list.html" title="Team"><span class="none"></span>Team</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Vulnerabilities+found+in+Ranger" class="externalLink" title="Security Advisories"><span class="none"></span>Security Advisories</a> </li>
<li class="nav-header">Releases</li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+2.3.0+-+Release+Notes" class="externalLink" title="2.3.0"><span class="none"></span>2.3.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+2.2.0+-+Release+Notes" class="externalLink" title="2.2.0"><span class="none"></span>2.2.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+2.1.0+-+Release+Notes" class="externalLink" title="2.1.0"><span class="none"></span>2.1.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+2.0.0+-+Release+Notes" class="externalLink" title="2.0.0"><span class="none"></span>2.0.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+1.2.0+-+Release+Notes" class="externalLink" title="1.2.0"><span class="none"></span>1.2.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+1.1.0+-+Release+Notes" class="externalLink" title="1.1.0"><span class="none"></span>1.1.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/1.0.0+Release+-+Apache+Ranger" class="externalLink" title="1.0.0"><span class="none"></span>1.0.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.7.1+Release+-+Apache+Ranger" class="externalLink" title="0.7.1"><span class="none"></span>0.7.1</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.7.0+Release+-+Apache+Ranger" class="externalLink" title="0.7.0"><span class="none"></span>0.7.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.6.3+Release+-+Apache+Ranger" class="externalLink" title="0.6.3"><span class="none"></span>0.6.3</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.6.2+Release+-+Apache+Ranger" class="externalLink" title="0.6.2"><span class="none"></span>0.6.2</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.6.1+Release+-+Apache+Ranger" class="externalLink" title="0.6.1"><span class="none"></span>0.6.1</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.6+Release+-+Apache+Ranger" class="externalLink" title="0.6.0"><span class="none"></span>0.6.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.5.3+Release+-+Apache+Ranger" class="externalLink" title="0.5.3"><span class="none"></span>0.5.3</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.5.2+Release+-+Apache+Ranger" class="externalLink" title="0.5.2"><span class="none"></span>0.5.2</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.5.1+Release+-+Apache+Ranger" class="externalLink" title="0.5.1"><span class="none"></span>0.5.1</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.5+Release+-+Apache+Ranger" class="externalLink" title="0.5.0"><span class="none"></span>0.5.0</a> </li>
<li><a href="https://cwiki.apache.org/confluence/display/RANGER/0.4+Release" class="externalLink" title="0.4.0"><span class="none"></span>0.4.0</a> </li>
<li class="nav-header">Apache</li>
<li><a href="https://www.apache.org" class="externalLink" title="Home"><span class="none"></span>Home</a> </li>
<li><a href="https://www.apache.org/events/current-event" class="externalLink" title="Events"><span class="none"></span>Events</a> </li>
<li><a href="https://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a> </li>
<li><a href="https://www.apache.org/foundation/sponsorship" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li>
<li><a href="https://www.apache.org/security" class="externalLink" title="Security"><span class="none"></span>Security</a> </li>
<li><a href="https://www.apache.org/foundation/thanks" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li>
<li><a href="https://www.apache.org/foundation/policies/conduct" class="externalLink" title="Code of Conduct"><span class="none"></span>Code of Conduct</a> </li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<iframe src="https://www.facebook.com/plugins/like.php?href=http://ranger.apache.org/&send=false&layout=box_count&show-faces=false&action=like&colorscheme=light"
scrolling="no" frameborder="0"
style="border:none; width:48px; height:63px; margin-top: 10px;" ></iframe>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Maven" class="builtBy"><img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /></a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<div class="section">
<h2><a name="Quick_Start_Guide"></a>Quick Start Guide</h2>
<div class="section">
<h3><a name="Bring_up_Apache_Ranger_in_minutes_using_Docker_..."></a>Bring up Apache Ranger in minutes using Docker ... </h3>
<p>
Please follow the instruction provided at <a class="externalLink" href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=235837576">Wiki Page for Running Apache Ranger</a>
</p>
</div>
<div class="section">
<h3><a name="Build_Process"></a>Build Process</h3>
<p>
1. Check out the code from GIT repository
</p>
<ul>
<div class="source"><pre class="prettyprint linenums">git clone https://gitbox.apache.org/repos/asf/ranger.git</pre></div>
<div class="source"><pre class="prettyprint linenums">cd ranger </pre></div>
</ul>
<p>
Alternatively, you can checkout the code from github:
</p>
<ul>
<div class="source"><pre class="prettyprint linenums">git clone https://github.com/apache/ranger</pre></div>
<div class="source"><pre class="prettyprint linenums">cd ranger </pre></div>
</ul>
<p>
2. Please execute the following Maven command:
</p>
<ul>
<div class="source"><pre class="prettyprint linenums">$ export JAVA_HOME=%jdk 7 Home%</pre></div>
<div class="source"><pre class="prettyprint linenums"> $ mvn -Pall clean </pre></div>
<div class="source"><pre class="prettyprint linenums"> $ mvn -Pall -DskipTests=false clean compile package install</pre></div>
</ul>
<p>
3. After the above build command execution, you should see the following TAR files in the target folder:
</p>
<div class="source"><pre class="prettyprint linenums">
ranger-%version-number%-%module-name%.tar.gz
</pre></div>
</div>
<div class="section">
<h3><a name="Create_an_Apache_Release"></a>Create an Apache Release</h3>
<p>
1. Checkout from ranger release branch
</p>
<ul>
<div class="source"><pre class="prettyprint linenums">$ git checkout ranger-%version%</pre></div>
</ul>
<p>
2. Run maven commands to build and validate the build is working fine
(See Build Process: step 2):
</p>
<ul>
<div class="source"><pre class="prettyprint linenums">$ export JAVA_HOME=%jdk 7 Home%</pre></div>
<div class="source"><pre class="prettyprint linenums"> $ mvn -Pall clean </pre></div>
<div class="source"><pre class="prettyprint linenums"> $ mvn -Pall -DskipTests=false clean compile package install</pre></div>
</ul>
<p>
3. Clean all generated files for building the source build
</p>
<div class="source"><pre class="prettyprint linenums">
$ mvn -Pall clean
</pre></div>
<p>
4. Create a TAR source file using the following command:
</p>
<div class="source"><pre class="prettyprint linenums">
$ ant -f release-build.xml -Dranger-release-version=%version-number%
</pre></div>
<p>
5. Now, the following files are ready to be published for release:
</p>
<div class="source"><pre class="prettyprint linenums">
./target/apache-ranger-%version-number%.tar.gz
./target/apache-ranger-%version-number%.tar.gz.asc
./target/apache-ranger-%version-number%.tar.gz.mds
</pre></div>
</div>
<div class="section">
<h3><a name="Verifying_Build_.28also_called_as_a_Release.29"></a>Verifying Build (also called as a Release)</h3>
<p>
1. Download the release source file, apache-ranger-%version-number%.tar.gz (from URL provided in the release email)
</p>
<p>
2. Download the PGP signature for, apache-ranger-%version-number%.tar.gz which usaully named as apache-ranger-%version-number%.tar.gz.asc (from URL provided in the release email)
</p>
<p>
3. Get the keys used to sign the releases for verification. https://dist.apache.org/repos/dist/release/ranger/KEYS
</p>
<div class="source"><pre class="prettyprint linenums">
$ gpg --import KEYS
$ gpg --fingerprint key-id
</pre></div>
<p>
4. Execute the following command to verify the release
</p>
<div class="source"><pre class="prettyprint linenums"> $ gpg --verify apache-ranger-%version-number%.tar.gz.asc apache-ranger-%version-number%.tar.gz </pre></div>
<p>
5. Download MD5/SHA hash for apache-ranger-%version-number%.tar.gz which usaully named as apache-ranger-%version-number%.tar.gz.mds (from URL provided in the release email)
</p>
<div class="source"><pre class="prettyprint linenums">$ gpg --print-mds apache-ranger-%version-number%.tar.gz </pre></div>
Compare MD5, SHA hash generated from the above command and the signature available in the apache-ranger-%version-number%.tar.gz.mds.
</div>
<div class="section">
<h3><a name="Importing_Apache_Ranger_Project_into_Eclipse"></a>Importing Apache Ranger Project into Eclipse</h3>
<p>
</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>
<div class="source"><pre class="prettyprint linenums">
$ export JAVA_HOME=%Jdk 7 Home%
$ mvn -Pall clean
$ mvn -Pall -DskipTests=false clean compile package install
$ mvn eclipse:eclipse
</pre></div>
</div>
<div class="section">
<h3><a name="Deployment_Process"></a>Deployment Process</h3>
<div class="section">
<h4><a name="Installation_Host_Information"></a>Installation Host Information</h4>
<p>
</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>
</div>
<div class="section">
<h4><a name="Installation_Process"></a> Installation Process </h4>
<p>
</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,
<div class="source"><pre class="prettyprint linenums">Execute ./setup.sh </pre></div>
If the setup.sh file does not exists,
<div class="source"><pre class="prettyprint linenums">Execute ./enable-%component%-plugin.sh</pre></div>
</ul>
</div></div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p><a href="https://www.apache.org/foundation/contributing"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support the ASF" id="asf-logo" height="20" width="20" /></a>Copyright © 2011-2018 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/">Apache License, Version 2.0</a>.<br/>
Apache Ranger, Ranger, Apache, the Apache feather logo are trademarks of the <a href="https://www.apache.org">Apache Software Foundation</a>.<br/>
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
</div>
</div>
</footer>
</body>
</html>