You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mj...@apache.org on 2017/06/20 16:24:36 UTC
[06/19] accumulo-website git commit: Jekyll build from master:c9398c5
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/eab65f94/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
new file mode 100644
index 0000000..770ba2b
--- /dev/null
+++ b/docs/unreleased/getting-started/quick-install.html
@@ -0,0 +1,595 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/paper/bootstrap.min.css" rel="stylesheet" integrity="sha384-awusxf8AUojygHf2+joICySzB780jVvQaVCAt1clU3QsyAitLGul28Qxb2r1e5g+" crossorigin="anonymous">
+<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+<link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/v/bs/jq-2.2.3/dt-1.10.12/datatables.min.css">
+<link href="/css/accumulo.css" rel="stylesheet" type="text/css">
+
+<title>Accumulo Documentation - Quick Installation</title>
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+<script type="text/javascript" src="https://cdn.datatables.net/v/bs/jq-2.2.3/dt-1.10.12/datatables.min.js"></script>
+<script>
+ // show location of canonical site if not currently on the canonical site
+ $(function() {
+ var host = window.location.host;
+ if (typeof host !== 'undefined' && host !== 'accumulo.apache.org') {
+ $('#non-canonical').show();
+ }
+ });
+
+ $(function() {
+ // decorate section headers with anchors
+ return $("h2, h3, h4, h5, h6").each(function(i, el) {
+ var $el, icon, id;
+ $el = $(el);
+ id = $el.attr('id');
+ icon = '<i class="fa fa-link"></i>';
+ if (id) {
+ return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon));
+ }
+ });
+ });
+
+ // fix sidebar width in documentation
+ $(function() {
+ var $affixElement = $('div[data-spy="affix"]');
+ $affixElement.width($affixElement.parent().width());
+ });
+
+ // configure Google Analytics
+ (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','//www.google-analytics.com/analytics.js','ga');
+
+ if (ga.hasOwnProperty('loaded') && ga.loaded === true) {
+ ga('create', 'UA-50934829-1', 'apache.org');
+ ga('send', 'pageview');
+ }
+</script>
+
+</head>
+<body style="padding-top: 100px">
+
+ <nav class="navbar navbar-default navbar-fixed-top">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/"><img id="nav-logo" alt="Apache Accumulo" class="img-responsive" src="/images/accumulo-logo.png" width="200"
+ /></a>
+ </div>
+ <div class="collapse navbar-collapse" id="navbar-items">
+ <ul class="nav navbar-nav">
+ <li class="nav-link"><a href="/downloads">Download</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Releases<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/release/accumulo-1.8.1/">1.8.1 (Latest)</a></li>
+ <li><a href="/release/accumulo-1.7.3/">1.7.3</a></li>
+ <li><a href="/release/accumulo-1.6.6/">1.6.6</a></li>
+ <li><a href="/release/">Archive</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/1.8/accumulo_user_manual.html">User Manual (1.8)</a></li>
+ <li><a href="/1.8/apidocs">Javadocs (1.8)</a></li>
+ <li><a href="/1.8/examples">Examples (1.8)</a></li>
+ <li><a href="/features">Features</a></li>
+ <li><a href="/glossary">Glossary</a></li>
+ <li><a href="/external-docs">External Docs</a></li>
+ <li><a href="/docs-archive/">Archive</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/get_involved">Get Involved</a></li>
+ <li><a href="/mailing_list">Mailing Lists</a></li>
+ <li><a href="/people">People</a></li>
+ <li><a href="/related-projects">Related Projects</a></li>
+ <li><a href="/contributor/">Contributor Guide</a></li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav navbar-nav navbar-right">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://www.apache.org">Apache Homepage <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/licenses/LICENSE-2.0">License <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship">Sponsorship <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/security">Security <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/thanks">Thanks <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/policies/conduct">Code of Conduct <i class="fa fa-external-link"></i></a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+</nav>
+
+ <div class="container">
+ <div class="row">
+ <div class="col-md-12">
+
+ <div id="non-canonical" style="display: none; background-color: #F0E68C; padding-left: 1em;">
+ Visit the official site at: <a href="https://accumulo.apache.org">https://accumulo.apache.org</a>
+ </div>
+ <div id="content">
+
+ <div class="row">
+ <div class="col-md-3">
+ <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true" data-spy="affix">
+ <div class="panel panel-default">
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
+ Getting started
+ </a>
+ </h4>
+ </div>
+ <div id="collapsegetting-started" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/design">Accumulo Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/quick-install">Quick Installation</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/clients">Accumulo Clients</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/shell">Accumulo Shell</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/table_design">Table Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/table_configuration">Table Configuration</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
+ Development
+ </a>
+ </h4>
+ </div>
+ <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/iterators">Iterators</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/mapreduce">MapReduce</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/proxy">Proxy</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/development_tools">Development Tools</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/sampling">Sampling</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/summaries">Summary Statistics</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/security">Security</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/high_speed_ingest">High-Speed Ingest</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="false" aria-controls="collapseadministration">
+ Administration
+ </a>
+ </h4>
+ </div>
+ <div id="collapseadministration" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/in-depth-install">In-depth Installation</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/configuration-management">Configuration Management</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/configuration-properties">Configuration Properties</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/monitoring-metrics">Monitoring & Metrics</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/tracing">Tracing</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/fate">FATE</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/multivolume">Multi-Volume Installations</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/ssl">SSL</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/kerberos">Kerberos</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/replication">Replication</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsetroubleshooting" aria-expanded="false" aria-controls="collapsetroubleshooting">
+ Troubleshooting
+ </a>
+ </h4>
+ </div>
+ <div id="collapsetroubleshooting" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/basic">Basic Troubleshooting</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/advanced">Advanced Troubleshooting</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/tools">Troubleshooting Tools</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/system-metadata-tables">System Metadata Tables</a></div>
+
+ </div>
+ </div>
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="col-md-9">
+
+ <p><a href="/docs/unreleased/">Accumulo unreleased docs</a> >> Getting started >> Quick Installation</p>
+
+
+
+ <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Accumulo! <a href="/1.8/accumulo_user_manual.html">View documentation for the latest release</a>.</div>
+
+ <div class="row">
+ <div class="col-md-10"><h1>Quick Installation</h1></div>
+ <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/quick-install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+
+ <!-- IMPORTANT: This file should mirror (with minor differences) INSTALL.md in the Accumulo repo -->
+
+<p>This document provides basic instructions for installing Accumulo. For detailed instructions,
+see the <a href="/docs/unreleased/administration/in-depth-install">in-depth installation guide</a>.</p>
+
+<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
+</code></pre>
+</div>
+
+<p>There are four scripts in the <code class="highlighter-rouge">bin</code> directory of the tarball distribution that are used
+to manage Accumulo:</p>
+
+<ol>
+ <li><code class="highlighter-rouge">accumulo</code> - Runs Accumulo command-line tools and starts Accumulo processes</li>
+ <li><code class="highlighter-rouge">accumulo-service</code> - Runs Accumulo processes as services</li>
+ <li><code class="highlighter-rouge">accumulo-cluster</code> - Manages Accumulo cluster on a single node or several nodes</li>
+ <li><code class="highlighter-rouge">accumulo-util</code> - Accumulo utilities for building native libraries, running jars, etc.</li>
+</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>
+
+<h2 id="configuring-accumulo">Configuring Accumulo</h2>
+
+<p>Accumulo requires running <a href="https://zookeeper.apache.org/">Zookeeper</a> and <a href="https://hadoop.apache.org/">HDFS</a> instances which should be set up
+before configuring Accumulo.</p>
+
+<p>The primary configuration files for Accumulo are <code class="highlighter-rouge">accumulo-env.sh</code> and <code class="highlighter-rouge">accumulo-site.xml</code>
+which are located in the <code class="highlighter-rouge">conf/</code> directory.</p>
+
+<p>Follow the steps below to configure <code class="highlighter-rouge">accumulo-site.xml</code>:</p>
+
+<ol>
+ <li>
+ <p>Run <code class="highlighter-rouge">accumulo-util build-native</code> to build native code. If this command fails, disable
+native maps by setting <code class="highlighter-rouge">tserver.memory.maps.native.enabled</code> to <code class="highlighter-rouge">false</code>.</p>
+ </li>
+ <li>
+ <p>Set <code class="highlighter-rouge">instance.volumes</code> to HDFS location where Accumulo will store data. If your namenode
+is running at 192.168.1.9:8020 and you want to store data in <code class="highlighter-rouge">/accumulo</code> in HDFS, then set
+<code class="highlighter-rouge">instance.volumes</code> to <code class="highlighter-rouge">hdfs://192.168.1.9:8020/accumulo</code>.</p>
+ </li>
+ <li>
+ <p>Set <code class="highlighter-rouge">instance.zookeeper.host</code> to the location of your Zookeepers</p>
+ </li>
+ <li>
+ <p>(Optional) Change <code class="highlighter-rouge">instance.secret</code> (which is used by Accumulo processes to communicate)
+from the default. This value should match on all servers.</p>
+ </li>
+</ol>
+
+<p>Follow the steps below to configure <code class="highlighter-rouge">accumulo-env.sh</code>:</p>
+
+<ol>
+ <li>
+ <p>Set <code class="highlighter-rouge">HADOOP_PREFIX</code> and <code class="highlighter-rouge">ZOOKEEPER_HOME</code> to the location of your Hadoop and Zookeeper
+installations. Accumulo will use these locations to find Hadoop and Zookeeper jars and add
+them to your <code class="highlighter-rouge">CLASSPATH</code> variable. If you you are running a vendor-specific release of
+Hadoop or Zookeeper, you may need to modify how the <code class="highlighter-rouge">CLASSPATH</code> variable is built in
+<code class="highlighter-rouge">accumulo-env.sh</code>. If Accumulo has problems loading classes when you start it, run
+<code class="highlighter-rouge">accumulo classpath -d</code> to debug and print Accumulo’s classpath.</p>
+ </li>
+ <li>
+ <p>Accumulo tablet servers are configured by default to use 1GB of memory (768MB is allocated to
+JVM and 256MB is allocated for native maps). Native maps are allocated memory equal to 33% of
+the tserver JVM heap. The table below can be used if you would like to change tsever memory
+usage in the <code class="highlighter-rouge">JAVA_OPTS</code> section of <code class="highlighter-rouge">accumulo-env.sh</code>:</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th>Native?</th>
+ <th>512MB</th>
+ <th>1GB</th>
+ <th>2GB</th>
+ <th>3GB</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Yes</td>
+ <td>-Xmx384m -Xms384m</td>
+ <td>-Xmx768m -Xms768m</td>
+ <td>-Xmx1536m -Xms1536m</td>
+ <td>-Xmx2g -Xms2g</td>
+ </tr>
+ <tr>
+ <td>No</td>
+ <td>-Xmx512m -Xms512m</td>
+ <td>-Xmx1g -Xms1g</td>
+ <td>-Xmx2g -Xms2g</td>
+ <td>-Xmx3g -Xms3g</td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ <li>
+ <p>(Optional) Review the memory settings for the Accumulo master, garbage collector, and monitor
+in the <code class="highlighter-rouge">JAVA_OPTS</code> section of <code class="highlighter-rouge">accumulo-env.sh</code>.</p>
+ </li>
+</ol>
+
+<h2 id="initialization">Initialization</h2>
+
+<p>Accumulo needs to initialize the locations where it stores data in Zookeeper
+and HDFS. The following command will do this.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo init
+</code></pre>
+</div>
+
+<p>The initialization command will prompt for the following information.</p>
+
+<ul>
+ <li><strong>Instance name</strong> : This is the name of the Accumulo instance and its
+Accumulo clients need to know it inorder to connect.</li>
+ <li><strong>Root password</strong> : Initialization sets up an initial Accumulo root user and
+prompts for its password. This information will be needed to later connect
+to Accumulo.</li>
+</ul>
+
+<h2 id="run-accumulo">Run Accumulo</h2>
+
+<p>There are several methods for running Accumulo:</p>
+
+<ol>
+ <li>
+ <p>Run Accumulo processes using <code class="highlighter-rouge">accumulo</code> command which runs processes in foreground and
+will not redirect stderr/stdout. Useful for creating init.d scripts that run Accumulo.</p>
+ </li>
+ <li>
+ <p>Run Accumulo processes as services using <code class="highlighter-rouge">accumulo-service</code> which uses <code class="highlighter-rouge">accumulo</code>
+command but backgrounds processes, redirects stderr/stdout and manages pid files.
+Useful if you are using a cluster management tool (i.e Ansible, Salt, etc).</p>
+ </li>
+ <li>
+ <p>Run an Accumulo cluster on one or more nodes using <code class="highlighter-rouge">accumulo-cluster</code> (which
+uses <code class="highlighter-rouge">accumulo-service</code> to run services). Useful for local development and
+testing or if you are not using a cluster management tool in production.</p>
+ </li>
+</ol>
+
+<p>Each method above has instructions below.</p>
+
+<h3 id="run-accumulo-processes">Run Accumulo processes</h3>
+
+<p>Start Accumulo processes (tserver, master, moniitor, etc) using command below:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo tserver
+</code></pre>
+</div>
+
+<p>The process will run in the foreground. Use ctrl-c to quit.</p>
+
+<h3 id="run-accumulo-services">Run Accumulo services</h3>
+
+<p>Start Accumulo services (tserver, master, monitor, etc) using command below:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo-service tserver start
+</code></pre>
+</div>
+
+<h3 id="run-an-accumulo-cluster">Run an Accumulo cluster</h3>
+
+<p>Before using the <code class="highlighter-rouge">accumulo-cluster</code> script, additional configuration files need
+to be created. Use the command below to create them:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo-cluster create-config
+</code></pre>
+</div>
+
+<p>This creates five files (<code class="highlighter-rouge">masters</code>, <code class="highlighter-rouge">gc</code>, <code class="highlighter-rouge">monitor</code>, <code class="highlighter-rouge">tservers</code>, & <code class="highlighter-rouge">tracers</code>)
+in the <code class="highlighter-rouge">conf/</code> directory that contain the node names where Accumulo services
+are run on your cluster. By default, all files are configured to <code class="highlighter-rouge">localhost</code>. If
+you are running a single-node Accumulo cluster, theses files do not need to be
+changed and the next section should be skipped.</p>
+
+<h4 id="multi-node-configuration">Multi-node configuration</h4>
+
+<p>If you are running an Accumulo cluster on multiple nodes, the following files
+in <code class="highlighter-rouge">conf/</code> should be configured with a newline separated list of node names:</p>
+
+<ul>
+ <li><code class="highlighter-rouge">masters</code> : Accumulo primary coordinating process. Must specify one node. Can
+ specify a few for fault tolerance.</li>
+ <li><code class="highlighter-rouge">gc</code> : Accumulo garbage collector. Must specify one node. Can specify a
+ few for fault tolerance.</li>
+ <li><code class="highlighter-rouge">monitor</code> : Node where Accumulo monitoring web server is run.</li>
+ <li><code class="highlighter-rouge">tservers</code>: Accumulo worker processes. List all of the nodes where tablet servers
+ should run in this file.</li>
+ <li><code class="highlighter-rouge">tracers</code> : Optional capability. Can specify zero or more nodes.</li>
+</ul>
+
+<p>The Accumulo, Hadoop, and Zookeeper software should be present at the same
+location on every node. Also the files in the <code class="highlighter-rouge">conf</code> directory must be copied
+to every node. There are many ways to replicate the software and configuration,
+two possible tools that can help replicate software and/or config are <a href="https://code.google.com/p/pdsh/">pdcp</a>
+and <a href="https://code.google.com/p/parallel-ssh/">prsync</a>.</p>
+
+<p>The <code class="highlighter-rouge">accumulo-cluster</code> script uses ssh to start processes on remote nodes. Before
+attempting to start Accumulo, <a href="https://www.google.com/search?q=hadoop+passwordless+ssh&ie=utf-8&oe=utf-8">passwordless ssh</a> must be setup on the cluster.</p>
+
+<h4 id="start-cluster">Start cluster</h4>
+
+<p>After configuring and initializing Accumulo, use the following command to start
+the cluster:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo-cluster start
+</code></pre>
+</div>
+
+<h2 id="first-steps">First steps</h2>
+
+<p>Once you have started Accumulo, use the following command to run the Accumulo shell:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo shell -u root
+</code></pre>
+</div>
+
+<p>Use your web browser to connect the Accumulo monitor page on port 9995.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>http://<hostname in conf/monitor>:9995/
+</code></pre>
+</div>
+
+<h2 id="stopping-accumulo">Stopping Accumulo</h2>
+
+<p>When finished, use the following commands to stop Accumulo:</p>
+
+<ul>
+ <li>Stop Accumulo service: <code class="highlighter-rouge">accumulo-service tserver stop</code></li>
+ <li>Stop Accumulo cluster: <code class="highlighter-rouge">accumulo-cluster stop</code></li>
+</ul>
+
+
+
+ <div class="row" style="margin-top: 20px;">
+ <div class="col-md-10"><strong>Find documentation for all releases in the <a href="/docs-archive">archive</strong></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/accumulo-website/edit/master/_docs-unreleased/getting-started/quick-install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+ </div>
+</div>
+
+ </div>
+
+
+<footer>
+
+ <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="100" /></a></p>
+
+ <p>Copyright © 2011-2017 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+
+</footer>
+
+
+ </div>
+ </div>
+ </div>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/eab65f94/docs/unreleased/getting-started/shell.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/getting-started/shell.html b/docs/unreleased/getting-started/shell.html
new file mode 100644
index 0000000..71220f8
--- /dev/null
+++ b/docs/unreleased/getting-started/shell.html
@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/paper/bootstrap.min.css" rel="stylesheet" integrity="sha384-awusxf8AUojygHf2+joICySzB780jVvQaVCAt1clU3QsyAitLGul28Qxb2r1e5g+" crossorigin="anonymous">
+<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+<link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/v/bs/jq-2.2.3/dt-1.10.12/datatables.min.css">
+<link href="/css/accumulo.css" rel="stylesheet" type="text/css">
+
+<title>Accumulo Documentation - Accumulo Shell</title>
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+<script type="text/javascript" src="https://cdn.datatables.net/v/bs/jq-2.2.3/dt-1.10.12/datatables.min.js"></script>
+<script>
+ // show location of canonical site if not currently on the canonical site
+ $(function() {
+ var host = window.location.host;
+ if (typeof host !== 'undefined' && host !== 'accumulo.apache.org') {
+ $('#non-canonical').show();
+ }
+ });
+
+ $(function() {
+ // decorate section headers with anchors
+ return $("h2, h3, h4, h5, h6").each(function(i, el) {
+ var $el, icon, id;
+ $el = $(el);
+ id = $el.attr('id');
+ icon = '<i class="fa fa-link"></i>';
+ if (id) {
+ return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon));
+ }
+ });
+ });
+
+ // fix sidebar width in documentation
+ $(function() {
+ var $affixElement = $('div[data-spy="affix"]');
+ $affixElement.width($affixElement.parent().width());
+ });
+
+ // configure Google Analytics
+ (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','//www.google-analytics.com/analytics.js','ga');
+
+ if (ga.hasOwnProperty('loaded') && ga.loaded === true) {
+ ga('create', 'UA-50934829-1', 'apache.org');
+ ga('send', 'pageview');
+ }
+</script>
+
+</head>
+<body style="padding-top: 100px">
+
+ <nav class="navbar navbar-default navbar-fixed-top">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/"><img id="nav-logo" alt="Apache Accumulo" class="img-responsive" src="/images/accumulo-logo.png" width="200"
+ /></a>
+ </div>
+ <div class="collapse navbar-collapse" id="navbar-items">
+ <ul class="nav navbar-nav">
+ <li class="nav-link"><a href="/downloads">Download</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Releases<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/release/accumulo-1.8.1/">1.8.1 (Latest)</a></li>
+ <li><a href="/release/accumulo-1.7.3/">1.7.3</a></li>
+ <li><a href="/release/accumulo-1.6.6/">1.6.6</a></li>
+ <li><a href="/release/">Archive</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/1.8/accumulo_user_manual.html">User Manual (1.8)</a></li>
+ <li><a href="/1.8/apidocs">Javadocs (1.8)</a></li>
+ <li><a href="/1.8/examples">Examples (1.8)</a></li>
+ <li><a href="/features">Features</a></li>
+ <li><a href="/glossary">Glossary</a></li>
+ <li><a href="/external-docs">External Docs</a></li>
+ <li><a href="/docs-archive/">Archive</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/get_involved">Get Involved</a></li>
+ <li><a href="/mailing_list">Mailing Lists</a></li>
+ <li><a href="/people">People</a></li>
+ <li><a href="/related-projects">Related Projects</a></li>
+ <li><a href="/contributor/">Contributor Guide</a></li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav navbar-nav navbar-right">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://www.apache.org">Apache Homepage <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/licenses/LICENSE-2.0">License <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship">Sponsorship <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/security">Security <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/thanks">Thanks <i class="fa fa-external-link"></i></a></li>
+ <li><a href="https://www.apache.org/foundation/policies/conduct">Code of Conduct <i class="fa fa-external-link"></i></a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+</nav>
+
+ <div class="container">
+ <div class="row">
+ <div class="col-md-12">
+
+ <div id="non-canonical" style="display: none; background-color: #F0E68C; padding-left: 1em;">
+ Visit the official site at: <a href="https://accumulo.apache.org">https://accumulo.apache.org</a>
+ </div>
+ <div id="content">
+
+ <div class="row">
+ <div class="col-md-3">
+ <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true" data-spy="affix">
+ <div class="panel panel-default">
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
+ Getting started
+ </a>
+ </h4>
+ </div>
+ <div id="collapsegetting-started" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/design">Accumulo Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/quick-install">Quick Installation</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/clients">Accumulo Clients</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/shell">Accumulo Shell</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/table_design">Table Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/getting-started/table_configuration">Table Configuration</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
+ Development
+ </a>
+ </h4>
+ </div>
+ <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/iterators">Iterators</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/mapreduce">MapReduce</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/proxy">Proxy</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/development_tools">Development Tools</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/sampling">Sampling</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/summaries">Summary Statistics</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/security">Security</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/development/high_speed_ingest">High-Speed Ingest</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="false" aria-controls="collapseadministration">
+ Administration
+ </a>
+ </h4>
+ </div>
+ <div id="collapseadministration" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/in-depth-install">In-depth Installation</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/configuration-management">Configuration Management</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/configuration-properties">Configuration Properties</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/monitoring-metrics">Monitoring & Metrics</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/tracing">Tracing</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/fate">FATE</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/multivolume">Multi-Volume Installations</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/ssl">SSL</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/kerberos">Kerberos</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/administration/replication">Replication</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsetroubleshooting" aria-expanded="false" aria-controls="collapsetroubleshooting">
+ Troubleshooting
+ </a>
+ </h4>
+ </div>
+ <div id="collapsetroubleshooting" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/basic">Basic Troubleshooting</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/advanced">Advanced Troubleshooting</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/tools">Troubleshooting Tools</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/unreleased/troubleshooting/system-metadata-tables">System Metadata Tables</a></div>
+
+ </div>
+ </div>
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="col-md-9">
+
+ <p><a href="/docs/unreleased/">Accumulo unreleased docs</a> >> Getting started >> Accumulo Shell</p>
+
+
+
+ <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Accumulo! <a href="/1.8/accumulo_user_manual.html">View documentation for the latest release</a>.</div>
+
+ <div class="row">
+ <div class="col-md-10"><h1>Accumulo Shell</h1></div>
+ <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/shell.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+
+ <p>Accumulo provides a simple shell that can be used to examine the contents and
+configuration settings of tables, insert/update/delete values, and change
+configuration settings.</p>
+
+<p>The shell can be started by the following command:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>accumulo shell -u [username]
+</code></pre>
+</div>
+
+<p>The shell will prompt for the corresponding password to the username specified
+and then display the following prompt:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>Shell - Apache Accumulo Interactive Shell
+-
+- version: 2.x.x
+- instance name: myinstance
+- instance id: 00000000-0000-0000-0000-000000000000
+-
+- type 'help' for a list of available commands
+-
+root@myinstance>
+</code></pre>
+</div>
+
+<h2 id="basic-administration">Basic Administration</h2>
+
+<p>The <code class="highlighter-rouge">tables</code> command will list all existings tables.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance> tables
+accumulo.metadata
+accumulo.root
+</code></pre>
+</div>
+
+<p>The <code class="highlighter-rouge">createtable</code> command creates a new table.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance> createtable mytable
+root@myinstance mytable> tables
+accumulo.metadata
+accumulo.root
+mytable
+</code></pre>
+</div>
+
+<p>The <code class="highlighter-rouge">deletetable</code> command deletes a table.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance testtable> deletetable testtable
+deletetable { testtable } (yes|no)? yes
+Table: [testtable] has been deleted.
+</code></pre>
+</div>
+
+<p>The shell can be used to insert updates and scan tables. This is useful for inspecting tables.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance mytable> scan
+
+root@myinstance mytable> insert row1 colf colq value1
+insert successful
+
+root@myinstance mytable> scan
+row1 colf:colq [] value1
+</code></pre>
+</div>
+
+<p>The value in brackets <code class="highlighter-rouge">[]</code> would be the visibility labels. Since none were used, this is empty for this row.
+You can use the <code class="highlighter-rouge">-st</code> option to scan to see the timestamp for the cell, too.</p>
+
+<h2 id="table-maintenance">Table Maintenance</h2>
+
+<p>The <code class="highlighter-rouge">compact</code> command instructs Accumulo to schedule a compaction of the table during which
+files are consolidated and deleted entries are removed.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance mytable> compact -t mytable
+07 16:13:53,201 [shell.Shell] INFO : Compaction of table mytable started for given range
+</code></pre>
+</div>
+
+<p>The <code class="highlighter-rouge">flush</code> command instructs Accumulo to write all entries currently in memory for a given table
+to disk.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance mytable> flush -t mytable
+07 16:14:19,351 [shell.Shell] INFO : Flush of table mytable
+initiated...
+</code></pre>
+</div>
+
+<h2 id="user-administration">User Administration</h2>
+
+<p>The Shell can be used to add, remove, and grant privileges to users.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>root@myinstance mytable> createuser bob
+Enter new password for 'bob': *********
+Please confirm new password for 'bob': *********
+
+root@myinstance mytable> authenticate bob
+Enter current password for 'bob': *********
+Valid
+
+root@myinstance mytable> grant System.CREATE_TABLE -s -u bob
+
+root@myinstance mytable> user bob
+Enter current password for 'bob': *********
+
+bob@myinstance mytable> userpermissions
+System permissions: System.CREATE_TABLE
+Table permissions (accumulo.metadata): Table.READ
+Table permissions (mytable): NONE
+
+bob@myinstance mytable> createtable bobstable
+
+bob@myinstance bobstable>
+
+bob@myinstance bobstable> user root
+Enter current password for 'root': *********
+
+root@myinstance bobstable> revoke System.CREATE_TABLE -s -u bob
+</code></pre>
+</div>
+
+
+ <div class="row" style="margin-top: 20px;">
+ <div class="col-md-10"><strong>Find documentation for all releases in the <a href="/docs-archive">archive</strong></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/accumulo-website/edit/master/_docs-unreleased/getting-started/shell.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+ </div>
+</div>
+
+ </div>
+
+
+<footer>
+
+ <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="100" /></a></p>
+
+ <p>Copyright © 2011-2017 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+
+</footer>
+
+
+ </div>
+ </div>
+ </div>
+</body>
+</html>