Permalink
Browse files

ACCUMULO-242 added many references to apache accumulo - merged to tru…

…nk and site

git-svn-id: https://svn.apache.org/repos/asf/incubator/accumulo/trunk@1245682 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent be2fdba commit 46f55d30acfe458d64197fb1d0979698d458e58a Billie Rinaldi committed Feb 17, 2012
Showing with 142 additions and 94 deletions.
  1. +1 −1 CHANGES
  2. +36 −20 README
  3. +5 −5 bin/etc_initd_accumulo
  4. +2 −2 docs/administration.html
  5. +4 −6 docs/bulkIngest.html
  6. +3 −3 docs/combiners.html
  7. +2 −2 docs/constraints.html
  8. +11 −1 docs/distributedTracing.html
  9. +2 −2 docs/examples/README
  10. +1 −1 docs/examples/README.batch
  11. +4 −4 docs/examples/README.bloom
  12. +1 −1 docs/examples/README.bulkIngest
  13. +2 −2 docs/examples/README.combiner
  14. +2 −2 docs/examples/README.constraints
  15. +1 −1 docs/examples/README.dirlist
  16. +1 −1 docs/examples/README.filedata
  17. +1 −1 docs/examples/README.filter
  18. +1 −1 docs/examples/README.helloworld
  19. +2 −2 docs/examples/README.isolation
  20. +2 −2 docs/examples/README.mapred
  21. +2 −2 docs/examples/README.shard
  22. +1 −1 docs/examples/README.visibility
  23. +1 −1 docs/index.html
  24. +2 −2 docs/isolation.html
  25. +2 −2 docs/lgroups.html
  26. +4 −2 docs/metrics.html
  27. +11 −2 docs/mockAccumulo.html
  28. +2 −2 docs/src/developer_manual/developer_manual.tex
  29. +1 −1 docs/src/user_manual/accumulo_user_manual.tex
  30. +1 −1 docs/src/user_manual/chapters/introduction.tex
  31. +1 −1 docs/src/user_manual/chapters/shell.tex
  32. +2 −2 docs/timestamps.html
  33. +17 −7 pom.xml
  34. +3 −3 src/assemble/pom.xml
  35. +1 −1 src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java
  36. +3 −3 src/core/src/main/resources/org/apache/accumulo/core/conf/config.html
  37. +1 −0 src/examples/wikisearch/README
  38. +1 −0 src/examples/wikisearch/README.parallel
  39. +1 −1 test/system/auto/README
  40. +1 −0 test/system/randomwalk/README
View
@@ -1,4 +1,4 @@
-Release notes for Accumulo 1.3.5
+Release notes for Apache Accumulo 1.3.5
Fixed prior to incubation:
View
56 README
@@ -1,4 +1,13 @@
******************************************************************************
+0. Introduction
+
+Apache Accumulo is a sorted, distributed key/value store based on Google's
+BigTable design. It is built on top of Apache Hadoop, Zookeeper, and Thrift. It
+features a few novel improvements on the BigTable design in the form of
+cell-level access labels and a server-side programming mechanism that can modify
+key/value pairs at various points in the data management process.
+
+******************************************************************************
1. Building
In the normal tarball or RPM release of accumulo, everything is built and
@@ -19,8 +28,8 @@ but having them available suppresses a runtime warning:
******************************************************************************
2. Deployment
-Copy the accumulo tar file produced by mvn package
-from the src/assemble/target/ directory to the desired destination, then untar it (e.g.
+Copy the accumulo tar file produced by mvn package from the src/assemble/target/
+directory to the desired destination, then untar it (e.g.
tar xvzf accumulo-1.5.0-incubating-SNAPSHOT-dist.tar.gz).
If you are using the RPM, install the RPM on every machine that will run
@@ -33,10 +42,10 @@ accumulo.
******************************************************************************
4. Configuring
-Accumulo has two prerequisites, hadoop and zookeeper. Zookeeper must be at
-least version 3.3.0. Both of these must be installed and configured. Zookeeper
-normally only allows for 10 connections from one computer. On a single-host
-install, this number is a little two low. Add the following to the
+Apache Accumulo has two prerequisites, hadoop and zookeeper. Zookeeper must be
+at least version 3.3.0. Both of these must be installed and configured.
+Zookeeper normally only allows for 10 connections from one computer. On a
+single-host install, this number is a little two low. Add the following to the
$ZOOKEEPER_HOME/conf/zoo.cfg file:
maxClientCnxns=100
@@ -56,8 +65,14 @@ Create a "masters" file in $ACCUMULO_HOME/conf/. This is a list of
machines where the master server will run.
Create conf/accumulo-env.sh following the template of
-conf/accumulo-env.sh.*-example. Set JAVA_HOME, HADOOP_HOME, and ZOOKEEPER_HOME.The example accumulo-env files are named based on the memory footprint for the accumulo processes, and if that footprint is during standalone or cluster use. Please note that the footprints are for only the Accumulo system processes, so ample space should be left for other processes like hadoop, zookeeper, and the accumulo client code.
-These directories must be at the same location on every node in the cluster.
+conf/accumulo-env.sh.*-example. Set JAVA_HOME, HADOOP_HOME, and ZOOKEEPER_HOME.
+The example accumulo-env files are named based on the memory footprint for the
+accumulo processes, and if that footprint is during standalone or cluster use.
+Please note that the footprints are for only the Accumulo system processes, so
+ample space should be left for other processes like hadoop, zookeeper, and the
+accumulo client code. These directories must be at the same location on every
+node in the cluster.
+
Note that zookeeper must be installed on every machine, but it should not be
run on every machine.
@@ -91,7 +106,7 @@ against mis-configured systems, servers using different configuration files
will not communicate with the rest of the cluster.
******************************************************************************
-5. Running Accumulo
+5. Running Apache Accumulo
Make sure hadoop is configured on all of the machines in the cluster, including
access to a shared hdfs instance. Make sure hdfs is running.
@@ -115,7 +130,7 @@ scanned.
$ ./bin/accumulo shell -u root
Enter current password for 'root'@'accumulo': ******
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
-
- version: 1.5.0-incubating-SNAPSHOT
- instance name: accumulo
@@ -136,7 +151,7 @@ certain column.
$ ./bin/accumulo shell -u root
Enter current password for 'root'@'accumulo': ******
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
-
- version: 1.5.0-incubating-SNAPSHOT
- instance name: accumulo
@@ -152,7 +167,7 @@ certain column.
******************************************************************************
-6. Monitoring Accumulo
+6. Monitoring Apache Accumulo
You can point your browser to the master host, on port 50095 to see the status
of accumulo across the cluster. You can even do this with the text-based
@@ -165,7 +180,7 @@ tablet servers are up. You can monitor query and ingest rates across the
cluster.
******************************************************************************
-7. Stopping Accumulo
+7. Stopping Apache Accumulo
Do not kill the tabletservers or run bin/tdown.sh unless absolutely necessary.
Recovery from a catastrophic loss of servers can take a long time. To shutdown
@@ -184,19 +199,20 @@ redirected to the log dir.
******************************************************************************
9. API
-The public accumulo API is composed of everything in the org.apache.accumulo.core.client
-package (excluding the org.apache.accumulo.core.client.impl package) and the following
-classes from org.apache.accumulo.core.data : Key, Mutation, Value, and Range. To get
+The public accumulo API is composed of everything in the
+org.apache.accumulo.core.client package (excluding the
+org.apache.accumulo.core.client.impl package) and the following classes from
+org.apache.accumulo.core.data : Key, Mutation, Value, and Range. To get
started using accumulo review the example and the javadoc for the packages and
classes mentioned above.
******************************************************************************
10. Performance Tuning
-Accumulo has exposed several configuration properties that can be changed.
-These properties and configuration management are described in detail in
-docs/config.html. While the default value is usually optimal, there are cases
-where a change can increase query and ingest performance.
+Apache Accumulo has exposed several configuration properties that can be
+changed. These properties and configuration management are described in detail
+in docs/config.html. While the default value is usually optimal, there are
+cases where a change can increase query and ingest performance.
Before changing a property from its default in a production system, you should
develop a good understanding of the property and consider creating a test to
View
@@ -16,16 +16,16 @@
# limitations under the License.
#
-# accumulo This shell script takes care of stoping and starting
-# accumulo on a single server
+# accumulo This shell script takes care of stopping and starting
+# accumulo on a single server
# chkconfig: - 60 20
-# description: Accumulo: an implementation of Google's BigTable
+# description: Apache Accumulo: an implementation of Google's BigTable
# probe: false
. /etc/rc.d/init.d/functions
-# lets assume this file is symlinked in from accumulo distro bin directory
-# otherwise reset the ACCUMULO_HOME settting
+# let's assume this file is symlinked in from accumulo distro bin directory
+# otherwise reset the ACCUMULO_HOME setting
pwd=`pwd -P`
ACCUMULO_HOME=`cd $pwd/.. ; pwd -P`
View
@@ -16,12 +16,12 @@
-->
<html>
<head>
-<title>Accumulo Documentation : Administration</title>
+<title>Accumulo Administration</title>
<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
</head>
<body>
-<h1>Administration</h1>
+<h1>Apache Accumulo Documentation : Administration</h1>
<h3>Starting accumulo for the first time</h3>
View
@@ -16,14 +16,12 @@
-->
<html>
<head>
-<title>Accumulo Documentation : Bulk Ingest</title>
+<title>Accumulo Bulk Ingest</title>
<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
</head>
<body>
-<h1>Accumulo Documentation</h1>
-
-<h2>Bulk Ingest</h2>
+<h1>Apache Accumulo Documentation : Bulk Ingest</h2>
<p>Accumulo supports the ability to import map files produced by an
external process into an online table. Often, it is much faster to churn
@@ -37,8 +35,8 @@
using map/reduce, the following high level steps should be taken.
<ul>
-<li>Construct a <code>org.apache.accumulo.core.client.Connector</core> instance</li>
-<li>Call <code>connector.tableOperations().getSplits()</core></li>
+<li>Construct an <code>org.apache.accumulo.core.client.Connector</code> instance</li>
+<li>Call <code>connector.tableOperations().getSplits()</code></li>
<li>Run a map/reduce job using <a href='apidocs/org/apache/accumulo/core/client/mapreduce/lib/partition/RangePartitioner.html'>RangePartitioner</a> with splits from the previous step</li>
<li>Call <code>connector.tableOperations().importDirectory()</code> passing the output directory of the MapReduce job</li>
</ul>
View
@@ -16,20 +16,20 @@
-->
<html>
<head>
-<title>Accumulo Documentation : Combiners</title>
+<title>Accumulo Combiners</title>
<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
</head>
<body>
-<h1>Combiners</h1>
+<h1>Apache Accumulo Documentation : Combiners</h1>
<p>Accumulo supports on the fly lazy aggregation of data using Combiners. Aggregation is done at compaction and scan time. No lookup is done at insert time, which` greatly speeds up ingest.
<p>Combiners are easy to use. You use the setiters command to configure a combiner for a table. Allowing a Combiner to apply to a whole column family is an interesting twist that gives the user great flexibility. The example below demonstrates this flexibility.
<p><pre>
-Shell - Accumulo Interactive Shell
+Shell - Apache Accumulo Interactive Shell
- version: 1.5.0-incubating-SNAPSHOT
- instance id: 863fc0d1-3623-4b6c-8c23-7d4fdb1c8a49
-
View
@@ -16,12 +16,12 @@
-->
<html>
<head>
-<title>Accumulo Documentation : Constraints</title>
+<title>Accumulo Constraints</title>
<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
</head>
<body>
-<h1>Constraints</h1>
+<h1>Apache Accumulo Documentation : Constraints</h1>
Accumulo supports constraints. Constraints are applied to mutations at ingest time.
@@ -14,7 +14,14 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<h2>Distributed Tracing</h2>
+<html>
+<head>
+<title>Accumulo Distributed Tracing</title>
+<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
+</head>
+<body>
+
+<h1>Apache Accumulo Documentation : Distributed Tracing</h1>
<p>It can be difficult to determine why some operations are taking longer than expected. For example, you may be looking up items with
very low latency, but sometimes the lookups take much longer. Determining the cause of the delay is difficult because the system is
@@ -87,3 +94,6 @@
}
});
</pre>
+
+</body>
+</html>
View
@@ -1,4 +1,4 @@
-Title: Examples
+Title: Apache Accumulo Examples
Notice: 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
@@ -16,7 +16,7 @@ Notice: Licensed to the Apache Software Foundation (ASF) under one
specific language governing permissions and limitations
under the License.
-Each README in the examples directory highlights the use of particular features of Accumulo.
+Each README in the examples directory highlights the use of particular features of Apache Accumulo.
Before running any of the examples, the following steps must be performed.
@@ -1,4 +1,4 @@
-Title: Batch Writing and Scanning Example
+Title: Apache Accumulo Batch Writing and Scanning Example
Notice: 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
@@ -1,4 +1,4 @@
-Title: Bloom Filter Example
+Title: Apache Accumulo Bloom Filter Example
Notice: 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
@@ -23,7 +23,7 @@ do not exist in a table.
Below table named bloom_test is created and bloom filters are enabled.
$ ./bin/accumulo shell -u username -p password
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
- version: 1.5.x-incubating
- instance name: instance
- instance id: 00000000-0000-0000-0000-000000000000
@@ -101,7 +101,7 @@ million inserts. If not, then more map files will be created.
The commands for creating the first table without bloom filters are below.
$ ./bin/accumulo shell -u username -p password
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
- version: 1.4.x-incubating
- instance name: instance
- instance id: 00000000-0000-0000-0000-000000000000
@@ -123,7 +123,7 @@ The commands for creating the first table without bloom filters are below.
The commands for creating the second table with bloom filers are below.
$ ./bin/accumulo shell -u username -p password
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
- version: 1.4.x-incubating
- instance name: instance
- instance id: 00000000-0000-0000-0000-000000000000
@@ -1,4 +1,4 @@
-Title: Bulk Ingest Example
+Title: Apache Accumulo Bulk Ingest Example
Notice: 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
@@ -1,4 +1,4 @@
-Title: Combiner Example
+Title: Apache Accumulo Combiner Example
Notice: 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
@@ -23,7 +23,7 @@ tar distribution.
$ bin/accumulo shell -u username
Enter current password for 'username'@'instance': ***
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
-
- version: 1.5.x-incubating
- instance name: instance
@@ -1,4 +1,4 @@
-Title: Constraints Example
+Title: Apache Accumulo Constraints Example
Notice: 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
@@ -24,7 +24,7 @@ the end shows the inserts were not allowed.
$ ./bin/accumulo shell -u username -p password
- Shell - Accumulo Interactive Shell
+ Shell - Apache Accumulo Interactive Shell
-
- version: 1.5.x-incubating
- instance name: instance
@@ -1,4 +1,4 @@
-Title: File System Archive
+Title: Apache Accumulo File System Archive
Notice: 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
@@ -1,4 +1,4 @@
-Title: File System Archive (Data Only)
+Title: Apache Accumulo File System Archive Example (Data Only)
Notice: 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
@@ -1,4 +1,4 @@
-Title: Filter Example
+Title: Apache Accumulo Filter Example
Notice: 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
@@ -1,4 +1,4 @@
-Title: Hello World Example
+Title: Apache Accumulo Hello World Example
Notice: 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
@@ -1,4 +1,4 @@
-Title: Isolation Example
+Title: Apache Accumulo Isolation Example
Notice: 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
@@ -17,7 +17,7 @@ Notice: Licensed to the Apache Software Foundation (ASF) under one
under the License.
-Accumulo has an isolated scanners that ensures partial changes to rows are not
+Accumulo has an isolated scanner that ensures partial changes to rows are not
seen. Isolation is documented in ../docs/isolation.html and the user manual.
InterferenceTest is a simple example that shows the effects of scanning with
Oops, something went wrong.

0 comments on commit 46f55d3

Please sign in to comment.