blob: e6ae184be0acb2227fcdc60a1fb7a287f45c2afb [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-04-02
| Rendered using Apache Maven Fluido Skin 1.5
-->
<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="Date-Revision-yyyymmdd" content="20180402" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Streams &#x2013; Release Setup</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.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.5.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-77087101-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body class="topBarEnabled">
<a href="https://github.com/apache/streams">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
alt="Fork me on GitHub">
</a>
<div id="topbar" class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<div class="container"><div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="index.html" title="Overview">Overview</a>
</li>
<li> <a href="architecture.html" title="Architecture">Architecture</a>
</li>
<li> <a href="concepts.html" title="Concepts">Concepts</a>
</li>
<li> <a href="downloads.html" title="Downloads">Downloads</a>
</li>
<li> <a href="streams-examples/index.html" title="Examples">Examples</a>
</li>
<li> <a href="faq.html" title="Frequently Asked Questions">Frequently Asked Questions</a>
</li>
<li> <a href="modules.html" title="Modules">Modules</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Users <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="install/java.html" title="Install Java">Install Java</a>
</li>
<li> <a href="install/docker.html" title="Install Docker">Install Docker</a>
</li>
<li> <a href="install/sbt.html" title="Install SBT">Install SBT</a>
</li>
<li class="dropdown-submenu">
<a href="" title="Credentials">Credentials</a>
<ul class="dropdown-menu">
<li> <a href="credentials/twitter.html" title="Twitter">Twitter</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="" title="Services">Services</a>
<ul class="dropdown-menu">
<li> <a href="services/cassandra.html" title="Cassandra">Cassandra</a>
</li>
<li> <a href="services/elasticsearch.html" title="Elasticsearch">Elasticsearch</a>
</li>
<li> <a href="services/mongo.html" title="Mongo">Mongo</a>
</li>
<li> <a href="services/neo4j.html" title="Neo4j">Neo4j</a>
</li>
<li> <a href="services/riak.html" title="Riak">Riak</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Developers <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="install/git.html" title="Install Git">Install Git</a>
</li>
<li> <a href="install/maven.html" title="Install Maven">Install Maven</a>
</li>
<li> <a href="changelog.html" title="Changelog">Changelog</a>
</li>
<li> <a href="release-setup.html" title="Release Setup">Release Setup</a>
</li>
<li> <a href="release.html" title="Release Process">Release Process</a>
</li>
<li> <a href="website.html" title="Website Management">Website Management</a>
</li>
<li> <a href="code-conventions.html" title="Coding Conventions">Coding Conventions</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Reports <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html" title="Project Information">Project Information</a>
<ul class="dropdown-menu">
<li> <a href="index.html" title="About">About</a>
</li>
<li> <a href="modules.html" title="Project Modules">Project Modules</a>
</li>
<li> <a href="license.html" title="Licenses">Licenses</a>
</li>
<li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li> <a href="team-list.html" title="Team">Team</a>
</li>
<li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a>
</li>
<li> <a href="issue-tracking.html" title="Issue Management">Issue Management</a>
</li>
<li> <a href="dependencies.html" title="Dependencies">Dependencies</a>
</li>
<li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a>
</li>
<li> <a href="dependency-management.html" title="Dependency Management">Dependency Management</a>
</li>
<li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a>
</li>
<li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
<ul class="dropdown-menu">
<li> <a href="checkstyle.html" title="Checkstyle">Checkstyle</a>
</li>
<li> <a href="checkstyle-aggregate.html" title="Checkstyle">Checkstyle</a>
</li>
<li> <a href="aggregate-third-party-report.html" title="Third Parties (Aggregate mode)">Third Parties (Aggregate mode)</a>
</li>
<li> <a href="rat-report.html" title="Rat Report">Rat Report</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Other Resources <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="http://activitystrea.ms" title="ActivityStreams Homepage">ActivityStreams Homepage</a>
</li>
<li> <a href="http://activitystrea.ms/specs/" title="ActivityStreams Specifications">ActivityStreams Specifications</a>
</li>
<li> <a href="http://blogs.apache.org/streams/" title="Streams Blog">Streams Blog</a>
</li>
<li> <a href="http://wiki.apache.org/incubator/StreamsProposal" title="Streams Proposal Wiki Page">Streams Proposal Wiki Page</a>
</li>
<li> <a href="http://www.apache.org/" title="Apache Foundation Info">Apache Foundation Info</a>
</li>
<li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
</li>
<li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
</li>
</ul>
</li>
</ul>
<ul class="nav pull-right"><li>
<a href="https://twitter.com/ApacheStreams" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheStreams</a>
<script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</li></ul>
</div>
</div>
</div>
</div>
<div class="container">
<div id="banner">
<div class="pull-left">
<a href="http://streams.apache.org" id="bannerLeft">
<img src="http://streams.apache.org/images/streams_logo.jpg" alt="Apache Streams" width="150" height="100"/>
</a>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="http://streams.apache.org" class="externalLink" title="Streams">
Streams</a>
<span class="divider">/</span>
</li>
<li class="active ">Release Setup</li>
</ul>
</div>
<div id="bodyColumn" >
<div class="section">
<div class="section">
<h3><a name="Release_Setup"></a>Release Setup</h3>
<p>These setup steps only need to be performed on a particular machine once.</p>
<p>Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including Utils/gnupg and Net/openssh packages.</p>
<div class="section">
<h4><a name="Create_and_install_a_SSH_key"></a>Create and install a SSH key</h4>
<ol style="list-style-type: decimal">
<li>Open a shell window. If using Windows, open a cygwin window.</li>
<li>
<p>Use ssh-keygen to create an SSH key.</p>
<div class="source">
<div class="source"><pre class="prettyprint">ssh-keygen -t rsa -b 4096
</pre></div></div>
<ul>
<li>Follow the latest steps and guides on the <a class="externalLink" href="http://www.apache.org/dev/openpgp.html#generate-key">ASF website</a> as you should <b>NOT</b> be using SHA1 and new keys <b>MUST</b> be at least 4096 bits.</li>
<li>Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public).</li>
<li>See <a class="externalLink" href="http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html">Authenticating By Public Key (OpenSSH)</a> for a good description on why and how to perform this task.</li>
</ul></li>
<li>
<p>SCP your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org.</p>
<div class="source">
<div class="source"><pre class="prettyprint">cd ~/.ssh
scp id_dsa.pub &lt;your userid&gt;@people.apache.org:id_dsa.pub
</pre></div></div>
<ul>
<li>You will be prompted for your password.</li>
</ul></li>
<li>
<p>Use ssh to login to people.apache.org</p>
<div class="source">
<div class="source"><pre class="prettyprint">cd ~
ssh &lt;your userid&gt;@people.apache.org
</pre></div></div>
<ul>
<li>At this point, you will still be prompted for your password.</li>
</ul></li>
<li>
<p>Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.</p>
<div class="source">
<div class="source"><pre class="prettyprint">mkdir ~/.ssh
chmod 700 ~/.ssh
</pre></div></div></li>
<li>
<p>Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.</p>
<div class="source">
<div class="source"><pre class="prettyprint">mv ~/id_dsa.pub ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys
</pre></div></div>
<ul>
<li>Each public key in the authorized_keys spans only one line. For example: &#x201c;ssh-dss AAAAB3NzaC1kc3MAAA &#x2026;.. agBmmfZ9uAbSqA== dsa-key-20071107&#x201d;</li>
<li><i>&#x2018;#&#x2019; in the first column is a comment line.</i></li>
</ul></li>
<li>
<p>Exit out of this ssh session.</p></li>
<li>
<p>Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh).</p>
<div class="source">
<div class="source"><pre class="prettyprint">ssh &lt;userid&gt;@people.apache.org
</pre></div></div>
<ul>
<li>If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly.*</li>
</ul></li>
</ol></div>
<div class="section">
<h4><a name="Create_a_GPG_key"></a>Create a GPG key</h4>
<ol style="list-style-type: decimal">
<li>Open a shell window. If using Windows, open a cygwin window.</li>
<li>
<p>Generate a key-pair with gpg, using default key kind (&#x201c;RSA and RSA&#x201d;) and keys size (4096).</p>
<div class="source">
<div class="source"><pre class="prettyprint">gpg --gen-key
</pre></div></div>
<ul>
<li>The program&#x2019;s default values should be fine. For the &#x201c;Real Name&#x201d; enter your full name (ie. Stan Programmer). For the &#x201c;e-mail address&#x201d; enter your apache address (ie. <a class="externalLink" href="mailto:sprogrammer@apache.org)">sprogrammer@apache.org)</a>. You will also be required to enter a &#x201c;passphrase&#x201d; for the GPG key generation. Keep track of this as you will need this for the Release processing.</li>
<li><i>The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg subdirectory.</i></li>
<li><i>Save the content in this subdirectory to a safe media. This contains your private key used to sign all the Streams release materials.</i></li>
</ul></li>
<li>
<p>Backup your home directory to another media ||</p></li>
<li>
<p>Add your public key to the <a class="externalLink" href="https://github.com/apache/streams/blob/master/KEYS">KEYS</a> file. See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the Streams releases.</p>
<div class="source">
<div class="source"><pre class="prettyprint">gpg --list-sigs &lt;Real Name&gt; &amp;&amp; gpg --armor -- export &lt;Real Name&gt;
</pre></div></div></li>
<li>
<p>Submit your public key to a key server. E.g. <a class="externalLink" href="http://pgp.surfnet.nl:11371/">SURFNET</a> or <a class="externalLink" href="http://pgp.mit.edu/">MIT</a></p></li>
<li>
<p>Following the instructions in <a class="externalLink" href="http://people.apache.org/~henkp/trust/">http://people.apache.org/~henkp/trust/</a> and ask multiple (at least 3) current Apache committers to sign your public key.</p></li>
</ol></div>
<div class="section">
<h4><a name="Configure_Maven"></a>Configure Maven</h4>
<ol style="list-style-type: decimal">
<li>Update your ~/.m2/settings.xml with the properties from <a class="externalLink" href="http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env">Publishing Maven Artifacts</a></li>
</ol>
<div class="section">
<div class="section">
<h6><a name="Licensed_under_Apache_License_2.0_-_http:www.apache.orglicensesLICENSE-2.0"></a>Licensed under Apache License 2.0 - <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></h6></div></div></div></div></div>
</div>
</div>
<hr/>
<footer>
<div class="container">
<div class="row">
<p >Copyright &copy; 2018
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.
<li id="publishDate" class="pull-right">Last Published: 2018-04-02</li>
<li id="projectVersion" class="pull-right">
Version: 0.5.2-SNAPSHOT
</li>
</p>
</div>
<p id="poweredBy" class="pull-right">
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</p>
</div>
</footer>
</body>
</html>