You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2018/11/01 17:00:52 UTC
svn commit: r1845500 - in /nifi/site/trunk: mailing_lists.html
minifi/minifi-java-agent-quick-start.html minifi/system-admin-guide.html
release-guide.html
Author: aldrin
Date: Thu Nov 1 17:00:52 2018
New Revision: 1845500
URL: http://svn.apache.org/viewvc?rev=1845500&view=rev
Log:
Updating MiNiFi docs and removing licensing headers.
Modified:
nifi/site/trunk/mailing_lists.html
nifi/site/trunk/minifi/minifi-java-agent-quick-start.html
nifi/site/trunk/minifi/system-admin-guide.html
nifi/site/trunk/release-guide.html
Modified: nifi/site/trunk/mailing_lists.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/mailing_lists.html?rev=1845500&r1=1845499&r2=1845500&view=diff
==============================================================================
--- nifi/site/trunk/mailing_lists.html (original)
+++ nifi/site/trunk/mailing_lists.html Thu Nov 1 17:00:52 2018
@@ -224,6 +224,10 @@
</p>
<ul>
<li>
+ Apache NiFi Slack Workspace: <a href="https://apachenifi.slack.com/">https://apachenifi.slack.com/</a> <br />
+ New users can join the workspace using the following <a href="https://join.slack.com/t/apachenifi/shared_invite/enQtNDI2NDMyMTY3MTA5LWJmZDI3MmM1ZmYyODQwZDYwM2MyMDY5ZjkyMDkxY2JmOGMyNmEzYTE0MTRkZTYwYzZlYTJkY2JhZTYyMzcyZGI">invite link</a>.
+ </li>
+ <li>
IRC: #nifi on <a href="http://webchat.freenode.net/?channels=#nifi">irc.freenode.net</a>
</li>
<li>
Modified: nifi/site/trunk/minifi/minifi-java-agent-quick-start.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/minifi-java-agent-quick-start.html?rev=1845500&r1=1845499&r2=1845500&view=diff
==============================================================================
--- nifi/site/trunk/minifi/minifi-java-agent-quick-start.html (original)
+++ nifi/site/trunk/minifi/minifi-java-agent-quick-start.html Thu Nov 1 17:00:52 2018
@@ -1,7 +1,7 @@
<!doctype html>
<html class="no-js" lang="en">
<head>
- <title></title>
+ <title>Apache NiFi MiNiFi Java Agent Quick Start Guide</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../assets/images/nifi16.ico"/>
@@ -103,23 +103,6 @@
<div class="row">
<div class="large-12 columns">
<div class="large-space"></div>
-<pre><code> <!--
-</code></pre>
-<p>Licensed to the Apache Software Foundation (ASF) under one or more<br>
-contributor license agreements. See the NOTICE file distributed with<br>
-this work for additional information regarding copyright ownership.<br>
-The ASF licenses this file to You under the Apache License, Version 2.0<br>
-(the "License"); you may not use this file except in compliance with<br>
-the License. You may obtain a copy of the License at</p>
-<pre><code> http://www.apache.org/licenses/LICENSE-2.0
-</code></pre>
-<p>Unless required by applicable law or agreed to in writing, software<br>
-distributed under the License is distributed on an "AS IS" BASIS,<br>
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
-See the License for the specific language governing permissions and<br>
-limitations under the License.<br>
---></p>
-<h1>MiNiFi Java Agent Quick Start Guide</h1>
<p><a href="dev@nifi.apache.org>">Apache NiFi Team</a></p>
<p><a href="http://nifi.apache.org">NiFi Homepage</a></p>
<h1>Overview</h1>
Modified: nifi/site/trunk/minifi/system-admin-guide.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/minifi/system-admin-guide.html?rev=1845500&r1=1845499&r2=1845500&view=diff
==============================================================================
--- nifi/site/trunk/minifi/system-admin-guide.html (original)
+++ nifi/site/trunk/minifi/system-admin-guide.html Thu Nov 1 17:00:52 2018
@@ -1,7 +1,7 @@
<!doctype html>
<html class="no-js" lang="en">
<head>
- <title></title>
+ <title>Apache NiFi MiNiFi System Administrator's Guide</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../assets/images/nifi16.ico"/>
@@ -103,26 +103,9 @@
<div class="row">
<div class="large-12 columns">
<div class="large-space"></div>
-<pre><code> <!--
-</code></pre>
-<p>Licensed to the Apache Software Foundation (ASF) under one or more<br>
-contributor license agreements. See the NOTICE file distributed with<br>
-this work for additional information regarding copyright ownership.<br>
-The ASF licenses this file to You under the Apache License, Version 2.0<br>
-(the "License"); you may not use this file except in compliance with<br>
-the License. You may obtain a copy of the License at</p>
-<pre><code> http://www.apache.org/licenses/LICENSE-2.0
-</code></pre>
-<p>Unless required by applicable law or agreed to in writing, software<br>
-distributed under the License is distributed on an "AS IS" BASIS,<br>
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
-See the License for the specific language governing permissions and<br>
-limitations under the License.<br>
---></p>
-<h1>MiNiFi System Administrator's Guide</h1>
<p><a href="dev@nifi.apache.org>">Apache NiFi Team</a></p>
<p><a href="https://nifi.apache.org/minifi/index.html">MiNiFi Homepage</a></p>
-<p>This documentation is for MiNiFi 0.6.0.</p>
+<p>This documentation is for MiNiFi 0.5.0.</p>
<h1>Automatic Warm-Redeploy</h1>
<p>When many MiNiFi agents running on the edge, it may not be possible to manually stop, edit the config.yml and then restart every one every time their configuration needs to change. The Config Change Coordinator and its Ingestors were designed to automatically redeploy in response to a configuration update.</p>
<p>The Config Change Ingestors are the means by which the agent is notified of a potential new configuration. Currently there are three:</p>
Modified: nifi/site/trunk/release-guide.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/release-guide.html?rev=1845500&r1=1845499&r2=1845500&view=diff
==============================================================================
--- nifi/site/trunk/release-guide.html (original)
+++ nifi/site/trunk/release-guide.html Thu Nov 1 17:00:52 2018
@@ -260,20 +260,18 @@ acceptable but the appropriate adjustmen
<li>Create meaningful release notes for this version if not already created. <a href="https://cwiki.apache.org/confluence/display/NIFI/Release+Notes">Enter them here</a> on<br>
the NiFi wiki.</li>
<li>Create a new branch off 'master' named after the JIRA ticket.
-<pre><code class="language-bash">$ git checkout -b NIFI-${JIRA_TICKET}-RC${RC} ${BRANCH}
+<pre><code class="language-bash">$ git checkout -b ${JIRA_TICKET}-RC${RC} ${BRANCH}
</code></pre></li>
<li>Verify that Maven has sufficient heap space to perform the build tasks. Some plugins and parts of the build<br>
-consumes a surprisingly large amount of space.</li>
-</ol>
+consumes a surprisingly large amount of space.
<ul>
<li>These settings have been shown to work for Java 8 for NiFi version 1.x and later.
-<pre><code class="language-bash"> $ export MAVEN_OPTS="-Xms1024m -Xmx3076m"
+<pre><code class="language-bash">$ export MAVEN_OPTS="-Xms1024m -Xmx3076m"
</code></pre></li>
<li>And these work for Java 7 for NiFi version 0.x.
<pre><code>$ export MAVEN_OPTS="-Xms1024m -Xmx3076m -XX:MaxPermSize=256m"
</code></pre></li>
-</ul>
-<ol>
+</ul></li>
<li>Ensure your settings.xml has been updated to include a <code>signed_release</code> profile and a <code><server></code> entry for<br>
"repository.apache.org" as shown below. <a href="http://blog.sonatype.com/2009/10/maven-tips-and-tricks-encrypting-passwords">Steps to configure and encrypt Maven passwords</a>.<br>
There are other ways to ensure your PGP key is available for signing as well.
@@ -312,10 +310,12 @@ problems that must be addressed before p
</ol>
<h3>Step 3. Perform the release (RM)</h3>
<ol>
-<li><p>Now its time to have maven prepare the release with this command.</p>
+<li><p>Now its time to have maven prepare the release with this command.<br>
+<em>NOTE: <code>gpg</code> will be invoked during this step, which will need to prompt you for a password. From the command line, use<br>
+<code>export GPG_TTY=$(tty)</code> to allow <code>gpg</code> to prompt you.</em></p>
<pre><code>$ mvn --batch-mode release:prepare \
-Psigned_release,include-grpc \
- -DscmCommentPrefix="NIFI-${JIRA_TICKET}-RC${RC} " \
+ -DscmCommentPrefix="${JIRA_TICKET}-RC${RC} " \
-Dtag="nifi-${NIFI_VERSION}-RC${RC}" \
-DreleaseVersion="${NIFI_VERSION}" \
-DdevelopmentVersion="${NEXT_VERSION}" \
@@ -347,9 +347,12 @@ click on that you can inspect the variou
<li>Validate that the README is present and provides sufficient information to build and if necessary execute.</li>
</ul></li>
<li><p>The validated artifacts all look good then push the branch to origin release branch to the ASF repository.</p>
-<pre><code>$ git push asf NIFI-${JIRA_TICKET}-RC${RC}
+<pre><code>$ git push asf ${JIRA_TICKET}-RC${RC}
</code></pre>
-<p><strong><em>From this branch, the ${RC_TAG_COMMIT_ID} will be the 40 byte commit hash with the comment NIFI-${JIRA_TICKET}-RC${RC} prepare release nifi-${NIFI_VERSION}-RC${RC}</em></strong></p></li>
+<p><strong><em>From this branch, the ${RC_TAG_COMMIT_ID} will be the 40 byte commit hash with the comment ${JIRA_TICKET}-RC${RC} prepare release nifi-${NIFI_VERSION}-RC${RC}</em></strong></p></li>
+<li><p>Push the tag created by the release:prepare step to the ASF repository.</p>
+<pre><code>git push asf nifi-${NIFI_VERSION}-RC${RC}
+</code></pre></li>
<li><p>Create the signature and hashes for the source release and convenience binary files.</p>
<ol>
<li>ASCII armored GPG signatures (<code>--digest-algo=SHA512</code> select the SHA512 hash algorithm). <a href="https://www.apache.org/dev/openpgp.html#key-gen-avoid-sha1">Configure GPG to always prefer stronger hashes</a>.
@@ -519,21 +522,23 @@ Here is the PMC vote thread: ${VOTE_THRE
<p>After the vote is complete and the release is approved, these steps complete the release process.</p>
<ol>
<li><p>Move convenience binaries and related artifacts from dist/dev to dist/release:</p>
-<pre><code>$ svn move -m "NIFI-${JIRA_TICKET}" https://dist.apache.org/repos/dist/dev/nifi/nifi-${NIFI_VERSION} https://dist.apache.org/repos/dist/release/nifi/${NIFI_VERSION}
+<pre><code>$ svn move -m "${JIRA_TICKET}" https://dist.apache.org/repos/dist/dev/nifi/nifi-${NIFI_VERSION} https://dist.apache.org/repos/dist/release/nifi/${NIFI_VERSION}
</code></pre></li>
<li><p>In repository.apache.org go to the staging repository and select <code>release</code> and follow the instructions on the site.</p></li>
<li><p>Merge the release branch into master.</p>
<pre><code>$ git checkout master
-$ git merge --no-ff NIFI-${JIRA_TICKET}-RC${RC}
+$ git merge --no-ff ${JIRA_TICKET}-RC${RC}
$ git push asf master
</code></pre></li>
-<li><p>Update Docker version information to point to the next release. For instance, if the next version applied by Maven is 1.3.0-SNAPSHOT, these values should be updated to 1.3.0. This currently consists of two files:</p></li>
-</ol>
+<li><p>Update Docker version information to point to the next release. For instance, if the next version applied by Maven is 1.3.0-SNAPSHOT, these values should be updated to 1.3.0. This currently consists of two files:</p>
<ul>
<li><a href="https://github.com/apache/nifi/blob/master/nifi-docker/dockerhub/Dockerfile#L24">nifi-docker/dockerhub/Dockerfile, Line 25</a>, and</li>
<li><a href="https://github.com/apache/nifi/blob/master/nifi-docker/dockerhub/DockerImage.txt#L16">nifi-docker/dockerhub/DockerImage.txt, Line 16</a>.</li>
-</ul>
-<ol>
+</ul></li>
+<li><p>Commit and push the dockerhub module updates to the ASF repository:</p>
+<pre><code>git commit -m "${JIRA_TICKET} Updated dockerhub module for next release"
+git push asf master
+</code></pre></li>
<li><p>Update the NiFi website to point to the new download(s). Remove older release artifacts from download page (leave<br>
the current release and the previous one). For the release just previous to this new one change the links to point to<br>
the archive location. See current page as an example of the needed URL changes. In addition to updating the download<br>
@@ -550,13 +555,13 @@ in the archive location so no need to do
<li><p>In JIRA mark the release version as 'Released' and 'Archived' through 'version' management in the 'administration' console.</p></li>
<li><p>Ensure the release artifacts are successfully mirrored to the archive, specifically https://archive.apache.org/dist/nifi/${NIFI_VERSION}/nifi-${NIFI_VERSION}-bin.tar.gz.<br>
This convenience binary file is the basis for our <a href="https://hub.docker.com/r/apache/nifi">Docker build</a> and is needed in place before the released tag is pushed to the repository. If there were any<br>
-issues with the above listed file not being available, it may be necessary to reach out to the ASF Infra team to adjust file size limits to accommodate larger artifacts.</p></li>
-</ol>
-<p>NOTE: The <a href="https://hub.docker.com/r/apache/nifi">Docker build</a> is triggered by pushing the signed tag in the next step. The release artifacts must be present<br>
-in the archive before continuing.</p>
-<ol>
-<li><p>Create a proper signed tag of the released codebase based on the RC Tag created during the Maven release process.</p>
-<pre><code>$ git tag -s rel/nifi-${NIFI_VERSION} -m "${JIRA_TICKET} signed release tag for approved release of NiFi ${NIFI_VERSION}" ${RC_TAG_COMMIT_ID}
+issues with the above listed file not being available, it may be necessary to reach out to the ASF Infra team to adjust file size limits to accommodate larger artifacts.<br>
+<em>NOTE: The <a href="https://hub.docker.com/r/apache/nifi">Docker build</a> is triggered by pushing the signed tag in the next step. The release artifacts must be present<br>
+in the archive before continuing.</em></p></li>
+<li><p>Create a proper signed tag of the released codebase based on the RC Tag created during the Maven release process.<br>
+<em>NOTE: <code>gpg</code> will be invoked during this step, which will need to prompt you for a password. From the command line, use<br>
+<code>export GPG_TTY=$(tty)</code> to allow <code>gpg</code> to prompt you.</em></p>
+<pre><code>$ git tag -s rel/nifi-${NIFI_VERSION} -m "${JIRA_TICKET} Signed release tag for approved release of NiFi ${NIFI_VERSION}" ${RC_TAG_COMMIT_ID}
</code></pre>
<p>For instructions on setting up to sign your tag see <a href="http://gitready.com/advanced/2014/11/02/gpg-sign-releases.html">here</a>.</p></li>
<li><p>Push the release tag to the official ASF repository.</p>