You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by el...@apache.org on 2015/07/02 05:45:37 UTC

svn commit: r1688761 - /accumulo/site/trunk/content/1.7/accumulo_user_manual.html

Author: elserj
Date: Thu Jul  2 03:45:37 2015
New Revision: 1688761

URL: http://svn.apache.org/r1688761
Log:
ACCUMULO-3851 Update the 1.7 user manual with ClientConfiguration instructions

Modified:
    accumulo/site/trunk/content/1.7/accumulo_user_manual.html

Modified: accumulo/site/trunk/content/1.7/accumulo_user_manual.html
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/1.7/accumulo_user_manual.html?rev=1688761&r1=1688760&r2=1688761&view=diff
==============================================================================
--- accumulo/site/trunk/content/1.7/accumulo_user_manual.html (original)
+++ accumulo/site/trunk/content/1.7/accumulo_user_manual.html Thu Jul  2 03:45:37 2015
@@ -721,7 +721,7 @@ body.book #toc,body.book #preamble,body.
 <li><a href="#_native_map">16.5.2. Native Map</a>
 <ul class="sectlevel4">
 <li><a href="#_building">Building</a></li>
-<li><a href="#_configuration_5">Configuration</a></li>
+<li><a href="#_native_maps_configuration">Native Maps Configuration</a></li>
 </ul>
 </li>
 <li><a href="#_cluster_specification">16.5.3. Cluster Specification</a></li>
@@ -730,7 +730,8 @@ body.book #toc,body.book #preamble,body.
 <li><a href="#_deploy_configuration">16.5.6. Deploy Configuration</a></li>
 <li><a href="#_sensitive_configuration_values">16.5.7. Sensitive Configuration Values</a></li>
 <li><a href="#_using_a_javakeystorecredentialprovider_for_storage">16.5.8. Using a JavaKeyStoreCredentialProvider for storage</a></li>
-<li><a href="#_custom_table_tags">16.5.9. Custom Table Tags</a></li>
+<li><a href="#_client_configuration_2">16.5.9. Client Configuration</a></li>
+<li><a href="#_custom_table_tags">16.5.10. Custom Table Tags</a></li>
 </ul>
 </li>
 <li><a href="#_initialization">16.6. Initialization</a></li>
@@ -1829,7 +1830,10 @@ for(Entry&lt;Key,Value&gt; entry : scan)
 <h3 id="_proxy">4.5. Proxy</h3>
 <div class="paragraph">
 <p>The proxy API allows the interaction with Accumulo with languages other than Java.
-A proxy server is provided in the codebase and a client can further be generated.</p>
+A proxy server is provided in the codebase and a client can further be generated.
+The proxy API can also be used instead of the traditional ZooKeeperInstance class to
+provide a single TCP port in which clients can be securely routed through a firewall,
+without requiring access to all tablet servers in the cluster.</p>
 </div>
 <div class="sect3">
 <h4 id="_prequisites">4.5.1. Prequisites</h4>
@@ -1937,8 +1941,22 @@ Let&#8217;s create a table, add some dat
 <pre class="highlightjs highlight"><code class="language-java" data-lang="java">// first, create a writer on the server
 String writer = client.createWriter(token, "myTable", new WriterOptions());
 
+//rowid
+ByteBuffer rowid = ByteBuffer.wrap("UUID".getBytes());
+
+//mutation like class
+ColumnUpdate cu = new ColumnUpdate();
+cu.setColFamily("MyFamily".getBytes());
+cu.setColQualifier("MyQualifier".getBytes());
+cu.setColVisibility("VisLabel".getBytes());
+cu.setValue("Some Value.".getBytes());
+
+List&lt;ColumnUpdate&gt; updates = new ArrayList&lt;ColumnUpdate&gt;();
+updates.add(cu);
+
 // build column updates
-Map&lt;ByteBuffer, List&lt;ColumnUpdate&gt; cells&gt; cellsToUpdate = //...
+Map&lt;ByteBuffer, List&lt;ColumnUpdate&gt;&gt; cellsToUpdate = new HashMap&lt;ByteBuffer, List&lt;ColumnUpdate&gt;&gt;();
+cellsToUpdate.put(rowid, updates);
 
 // send updates to the server
 client.updateAndFlush(writer, "myTable", cellsToUpdate);
@@ -6230,7 +6248,7 @@ also locate the native maps shared libra
 </div>
 </div>
 <div class="sect4">
-<h5 id="_configuration_5">Configuration</h5>
+<h5 id="_native_maps_configuration">Native Maps Configuration</h5>
 <div class="paragraph">
 <p>As mentioned, Accumulo will use the native libraries if they are found in the expected
 location and if it is not configured to ignore them. Using the native maps over JVM
@@ -6433,7 +6451,45 @@ will expect the KeyStore in the same loc
 </div>
 </div>
 <div class="sect3">
-<h4 id="_custom_table_tags">16.5.9. Custom Table Tags</h4>
+<h4 id="_client_configuration_2">16.5.9. Client Configuration</h4>
+<div class="paragraph">
+<p>In version 1.6.0, Accumulo includes a new type of configuration file known as a client
+configuration file. One problem with the traditional "site.xml" file that is prevalent
+through Hadoop is that it is a single file used by both clients and servers. This makes
+is very difficult to protect secrets that are only meant for the server processes while
+allowing the clients to connect to the servers.</p>
+</div>
+<div class="paragraph">
+<p>The client configuration file is a subset of the information stored in accumulo-site.xml
+meant only for consumption by clients of Accumulo. By default, Accumulo checks a number
+of locations for a client configuration by default:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>${ACCUMULO_CONF_DIR}/client.conf</code></p>
+</li>
+<li>
+<p><code>/etc/accumulo/client.conf</code></p>
+</li>
+<li>
+<p><code>/etc/accumulo/conf/client.conf</code></p>
+</li>
+<li>
+<p><code>~/.accumulo/config</code></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>These files are <a href="https://en.wikipedia.org/wiki/.properties">Java Properties files</a>. These files
+can currently contain information about ZooKeeper servers, RPC properties (such as SSL or SASL
+connectors), distributed tracing properties. Valid properties are defined by the
+<a href="https://github.com/apache/accumulo/blob/f1d0ec93d9f13ff84844b5ac81e4a7b383ced467/core/src/main/java/org/apache/accumulo/core/client/ClientConfiguration.java#L54">ClientProperty</a>
+enum contained in the client API.</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_custom_table_tags">16.5.10. Custom Table Tags</h4>
 <div class="paragraph">
 <p>Accumulo has the ability for users to add custom tags to tables.  This allows
 applications to set application-level metadata about a table.  These tags can be
@@ -10876,7 +10932,7 @@ An example is <em>java.lang.String</em>,
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2015-05-18 17:01:54 EDT
+Last updated 2015-07-01 23:36:57 EDT
 </div>
 </div>
 </body>