You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mw...@apache.org on 2017/07/03 12:53:38 UTC
[3/3] accumulo-website git commit: Jekyll build from master:74699ed
Jekyll build from master:74699ed
Merge branch 'docs-version'
Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/cfab2520
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/cfab2520
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/cfab2520
Branch: refs/heads/asf-site
Commit: cfab2520501a1960935f5bb9266f3f8b16234530
Parents: 78bb2bc
Author: Mike Walch <mw...@apache.org>
Authored: Mon Jul 3 08:52:57 2017 -0400
Committer: Mike Walch <mw...@apache.org>
Committed: Mon Jul 3 08:52:57 2017 -0400
----------------------------------------------------------------------
.../administration/in-depth-install.html | 4 +--
.../development/development_tools.html | 12 +++----
docs/unreleased/getting-started/clients.html | 36 +++++++++++++++-----
.../getting-started/quick-install.html | 6 ++--
docs/unreleased/getting-started/shell.html | 2 +-
feed.xml | 4 +--
6 files changed, 42 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/docs/unreleased/administration/in-depth-install.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/administration/in-depth-install.html b/docs/unreleased/administration/in-depth-install.html
index 79971d5..5ed89b1 100644
--- a/docs/unreleased/administration/in-depth-install.html
+++ b/docs/unreleased/administration/in-depth-install.html
@@ -436,8 +436,8 @@ at the low end of the range to, and including, the high end of the range.</p>
sufficient space:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>cd <install directory>
-tar xzf accumulo-X.Y.Z-bin.tar.gz # Replace 'X.Y.Z' with your Accumulo version
-cd accumulo-X.Y.Z
+tar xzf accumulo-2.0.0-bin.tar.gz
+cd accumulo-2.0.0
</code></pre>
</div>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/docs/unreleased/development/development_tools.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/development/development_tools.html b/docs/unreleased/development/development_tools.html
index dfd1ea2..2f13f86 100644
--- a/docs/unreleased/development/development_tools.html
+++ b/docs/unreleased/development/development_tools.html
@@ -333,13 +333,13 @@
<h2 id="miniaccumulocluster">MiniAccumuloCluster</h2>
-<p><a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/1.8.1/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> is a standalone instance of Apache Accumulo for testing. It will
+<p><a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/2.0.0/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> is a standalone instance of Apache Accumulo for testing. It will
create Zookeeper and Accumulo processes that write all of their data to a single local
-directory. <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/1.8.1/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> makes it easy to code agaist a real Accumulo instance.
+directory. <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/2.0.0/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> makes it easy to code agaist a real Accumulo instance.
Developers can write realistic-to-end integration tests that mimic the use of a normal
Accumulo instance.</p>
-<p><a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/1.8.1/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> is published in a separate jar that should be added to your pom.xml
+<p><a href="https://static.javadoc.io/org.apache.accumulo/accumulo-minicluster/2.0.0/org/apache/accumulo/minicluster/MiniAccumuloCluster.html">MiniAccumuloCluster</a> is published in a separate jar that should be added to your pom.xml
as a test dependency:</p>
<div class="language-xml highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span>
@@ -396,7 +396,7 @@ a test dependency:</p>
</code></pre>
</div>
-<p>To use the Iterator test harness, create a class that extends the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/1.8.1/org/apache/accumulo/iteratortest/junit4/BaseJUnit4IteratorTest.html">BaseJUnit4IteratorTest</a> class
+<p>To use the Iterator test harness, create a class that extends the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/2.0.0/org/apache/accumulo/iteratortest/junit4/BaseJUnit4IteratorTest.html">BaseJUnit4IteratorTest</a> class
and defines the following:</p>
<ul>
@@ -404,7 +404,7 @@ and defines the following:</p>
<li>A <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a> to use in tests</li>
<li>A <code class="highlighter-rouge">Map</code> of options (<code class="highlighter-rouge">String</code> to <code class="highlighter-rouge">String</code> pairs)</li>
<li>A <code class="highlighter-rouge">SortedMap</code> of output data (<code class="highlighter-rouge">Key</code>-<code class="highlighter-rouge">Value</code> pairs)</li>
- <li>A list of <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/1.8.1/org/apache/accumulo/iteratortest/testcases/IteratorTestCase.html">IteratorTestCase</a>s (these can be automatically discovered)</li>
+ <li>A list of <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/2.0.0/org/apache/accumulo/iteratortest/testcases/IteratorTestCase.html">IteratorTestCase</a>s (these can be automatically discovered)</li>
</ul>
<p>The majority of effort a user must make is in creating the input dataset and the expected
@@ -472,7 +472,7 @@ output dataset for the iterator being tested.</p>
<h3 id="limitations">Limitations</h3>
-<p>While the provided <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/1.8.1/org/apache/accumulo/iteratortest/testcases/IteratorTestCase.html">IteratorTestCase</a>s should exercise common edge-cases in user iterators,
+<p>While the provided <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-iterator-test-harness/2.0.0/org/apache/accumulo/iteratortest/testcases/IteratorTestCase.html">IteratorTestCase</a>s should exercise common edge-cases in user iterators,
there are still many limitations to the existing test harness. Some of them are:</p>
<ul>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/docs/unreleased/getting-started/clients.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/getting-started/clients.html b/docs/unreleased/getting-started/clients.html
index edd9691..7defb85 100644
--- a/docs/unreleased/getting-started/clients.html
+++ b/docs/unreleased/getting-started/clients.html
@@ -329,18 +329,38 @@
<div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/accumulo-website/edit/master/_docs-unreleased/getting-started/clients.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <h2 id="running-client-code">Running Client Code</h2>
+ <h2 id="creating-client-code">Creating Client Code</h2>
-<p>There are multiple ways to run Java code that uses Accumulo. Below is a list
+<p>If you are using Maven to create Accumulo client code, add the following to your pom:</p>
+
+<div class="language-xml highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.accumulo<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>accumulo-core<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>2.0.0<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre>
+</div>
+
+<h2 id="running-client-code">Running Client Code</h2>
+
+<p>There are multiple ways to run Java code that use Accumulo. Below is a list
of the different ways to execute client code.</p>
<ul>
- <li>using the <code class="highlighter-rouge">java</code> command</li>
- <li>using the <code class="highlighter-rouge">accumulo</code> command</li>
- <li>using the <code class="highlighter-rouge">accumulo-util hadoop-jar</code> command</li>
+ <li>build and execute an uber jar</li>
+ <li>add <code class="highlighter-rouge">accumulo classpath</code> to your Java classpath</li>
+ <li>use the <code class="highlighter-rouge">accumulo</code> command</li>
+ <li>use the <code class="highlighter-rouge">accumulo-util hadoop-jar</code> command</li>
</ul>
-<h3 id="using-the-java-command">Using the java command</h3>
+<h3 id="build-and-execute-an-uber-jar">Build and execute an uber jar</h3>
+
+<p>If you have included <code class="highlighter-rouge">accumulo-core</code> as dependency in your pom, you can build an uber jar
+using the Maven assembly or shade plugin and use it to run Accumulo client code. When building
+an uber jar, you should set the versions of any Hadoop dependencies in your pom to match the
+version running on your cluster.</p>
+
+<h3 id="add-accumulo-classpath-to-your-java-classpath">Add ‘accumulo classpath’ to your Java classpath</h3>
<p>To run Accumulo client code using the <code class="highlighter-rouge">java</code> command, use the <code class="highlighter-rouge">accumulo classpath</code> command
to include all of Accumulo’s dependencies on your classpath:</p>
@@ -356,7 +376,7 @@ output a more human readable format using the <code class="highlighter-rouge">-d
</code></pre>
</div>
-<h3 id="using-the-accumulo-command">Using the accumulo command</h3>
+<h3 id="use-the-accumulo-command">Use the accumulo command</h3>
<p>Another option for running your code is to use the Accumulo script which can execute a
main class (if it exists on its classpath):</p>
@@ -375,7 +395,7 @@ the accumulo command.</p>
</code></pre>
</div>
-<h3 id="using-the-accumulo-util-hadoop-jar-command">Using the ‘accumulo-util hadoop-jar’ command</h3>
+<h3 id="use-the-accumulo-util-hadoop-jar-command">Use the ‘accumulo-util hadoop-jar’ command</h3>
<p>If you are writing map reduce job that accesses Accumulo, then you can use
<code class="highlighter-rouge">accumulo-util hadoop-jar</code> to run those jobs. See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/mapred.md">MapReduce example</a>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/docs/unreleased/getting-started/quick-install.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/getting-started/quick-install.html b/docs/unreleased/getting-started/quick-install.html
index 34dcb14..e7cc860 100644
--- a/docs/unreleased/getting-started/quick-install.html
+++ b/docs/unreleased/getting-started/quick-install.html
@@ -337,8 +337,8 @@ see the <a href="/docs/unreleased/administration/in-depth-install">in-depth inst
<p>Either <a href="https://accumulo.apache.org/downloads/">download</a> or <a href="https://github.com/apache/accumulo/blob/master/README.md#building">build</a> a binary distribution of Accumulo from source code and
unpack as follows.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>tar xzf /path/to/accumulo-X.Y.Z-bin.tar.gz
-cd accumulo-X.Y.Z
+<div class="highlighter-rouge"><pre class="highlight"><code>tar xzf /path/to/accumulo-2.0.0-bin.tar.gz
+cd accumulo-2.0.0
</code></pre>
</div>
@@ -353,7 +353,7 @@ to manage Accumulo:</p>
</ol>
<p>These scripts will be used in the remaining instructions to configure and run Accumulo.
-For convenience, consider adding <code class="highlighter-rouge">accumulo-X.Y.Z/bin/</code> to your shell’s path.</p>
+For convenience, consider adding <code class="highlighter-rouge">accumulo-2.0.0/bin/</code> to your shell’s path.</p>
<h2 id="configuring-accumulo">Configuring Accumulo</h2>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/docs/unreleased/getting-started/shell.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/getting-started/shell.html b/docs/unreleased/getting-started/shell.html
index c66782d..f1c8053 100644
--- a/docs/unreleased/getting-started/shell.html
+++ b/docs/unreleased/getting-started/shell.html
@@ -344,7 +344,7 @@ and then display the following prompt:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>Shell - Apache Accumulo Interactive Shell
-
-- version: 2.x.x
+- version: 2.0.0
- instance name: myinstance
- instance id: 00000000-0000-0000-0000-000000000000
-
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/cfab2520/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index d495e28..bed727d 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
</description>
<link>https://accumulo.apache.org/</link>
<atom:link href="https://accumulo.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Fri, 30 Jun 2017 16:26:12 -0400</pubDate>
- <lastBuildDate>Fri, 30 Jun 2017 16:26:12 -0400</lastBuildDate>
+ <pubDate>Mon, 03 Jul 2017 08:52:48 -0400</pubDate>
+ <lastBuildDate>Mon, 03 Jul 2017 08:52:48 -0400</lastBuildDate>
<generator>Jekyll v3.3.1</generator>
<item>