15.1. Installing GeoMesa Accumulo¶
GeoMesa currently supports Accumulo versions 1.7.x, 1.8.x, 1.9.x and 2.0.x.
15.1.1. Installing from the Binary Distribution¶
GeoMesa Accumulo artifacts are available for download or can be built from source. The easiest way to get started is to download the most recent binary version (3.2.2) from GitHub.
Extract it somewhere convenient:
# download and unpackage the most recent distribution:
$ wget "https://github.com/locationtech/geomesa/releases/download/geomesa_2.11-$VERSION/geomesa-accumulo_2.11-$VERSION-bin.tar.gz"
$ tar xvf geomesa-accumulo_2.11-$VERSION-bin.tar.gz
$ cd geomesa-accumulo_2.11-$VERSION
bin/ conf/ dist/ docs/ examples/ lib/ LICENSE.txt logs/
15.1.2. Building from Source¶
GeoMesa Accumulo may also be built from source. For more information refer to Building from Source
in the developer manual, or to the
README.md file in the the source distribution.
The remainder of the instructions in this chapter assume the use of the binary GeoMesa Accumulo
distribution. If you have built from source, the distribution is created in the
target directory of
More information about developing with GeoMesa may be found in the Developer Manual.
15.1.3. Installing the Accumulo Distributed Runtime Library¶
geomesa-accumulo_2.11-$VERSION/dist/accumulo/ directory contains the distributed
runtime JAR that contains server-side code for Accumulo that must be made
available on each of the Accumulo tablet servers in the cluster. This JAR
contains GeoMesa code and the Accumulo iterators required for querying GeoMesa data.
GeoMesa requires commons-vfs2.jar 2.1 or later. This JAR ships with Accumulo 1.7.2+, but for older
installations the JAR needs to be updated in
$ACCUMULO_HOME/lib on all Accumulo servers.
The version of the distributed runtime JAR must match the version of the GeoMesa data store client JAR (usually installed in GeoServer; see below). If not, queries might not work correctly or at all.
126.96.36.199. Namespace Install¶
GeoMesa leverages namespaces and classpath contexts to isolate the GeoMesa classpath from the rest of Accumulo.
To install the distributed runtime JAR, first copy it into HDFS:
$ hadoop fs -mkdir /accumulo/classpath/myNamespace
$ hadoop fs -put \
Then configure the namespace classpath through the Accumulo shell:
$ accumulo shell -u root
> createnamespace myNamespace
> grant NameSpace.CREATE_TABLE -ns myNamespace -u myUser
> config -s general.vfs.context.classpath.myNamespace=hdfs://NAME_NODE_FDQN:9000/accumulo/classpath/myNamespace/[^.].*.jar
> config -ns myNamespace -s table.classpath.context=myNamespace
The path above is just an example; you can included nested folders with project
names, version numbers, and other information in order to have different versions of GeoMesa on
the same Accumulo instance. You should remove any GeoMesa JARs under
$ACCUMULO_HOME/lib/ext to prevent classpath conflicts.
When connecting to a data store using Accumulo namespaces, you must prefix
accumulo.catalog parameter with the namespace. For example, refer to the
my_catalog table as
188.8.131.52. System Install¶
Alternatively, the GeoMesa runtime JAR can be copied into the
$ACCUMULO_HOME/lib/ext folder on
each tablet server.
This approach is not recommended, as the GeoMesa classes will be on the global Accumulo classpath, and may conflict with other custom JARs installed in Accumulo.
$ for tserver in $(cat $ACCUMULO_HOME/conf/tservers); do \
scp dist/accumulo/geomesa-accumulo-distributed-runtime_2.11-$VERSION.jar \
15.1.4. Setting up the Accumulo Command Line Tools¶
To use the Accumulo data store with the command line tools, you need to install the distributed runtime first. See Installing the Accumulo Distributed Runtime Library.
GeoMesa comes with a set of command line tools for managing Accumulo features located in
geomesa-accumulo_2.11-$VERSION/bin/ of the binary distribution.
java to be available on the default path.
184.108.40.206. Configuring the Classpath¶
GeoMesa needs Accumulo and Hadoop JARs on the classpath. These are not bundled by default, as they should match the versions installed on the target system.
If the environment variables
HADOOP_HOME are set, then GeoMesa will load the appropriate
JARs and configuration files from those locations and no further configuration is required. Otherwise, you will
be prompted to download the appropriate JARs the first time you invoke the tools. Environment variables can be
conf/*-env.sh and dependency versions can be specified in
In order to run map/reduce jobs, the Hadoop
*-site.xml configuration files from your Hadoop installation
must be on the classpath. If
HADOOP_HOME is not set, then copy them into
GeoMesa also provides the ability to add additional JARs to the classpath using the environmental variable
$GEOMESA_EXTRA_CLASSPATHS. GeoMesa will prepend the contents of this environmental variable to the computed
classpath, giving it highest precedence in the classpath. Users can provide directories of jar files or individual
files using a colon (
:) as a delimiter. These entries will also be added the the map-reduce libjars variable.
Due to licensing restrictions, dependencies for shape file support must be separately installed. Do this with the following command:
For logging, see Logging Configuration for information about configuring the SLF4J implementation.
geomesa-accumulo classpath command to print the final classpath that will be used when executing GeoMesa
15.1.5. Installing GeoMesa Accumulo in GeoServer¶
See GeoServer Versions to ensure that GeoServer is compatible with your GeoMesa version.
220.127.116.11. Installing GeoServer¶
As described in GeoMesa and GeoServer, GeoMesa implements a GeoTools-compatible data store. This makes it possible to use GeoMesa Accumulo as a data store in GeoServer. GeoServer’s web site includes installation instructions for GeoServer.
After GeoServer is running, you may optionally install the WPS plugin. The GeoServer WPS Plugin must match the version of your GeoServer instance. The GeoServer website includes instructions for downloading and installing the WPS plugin.
If using Tomcat as a web server, it will most likely be necessary to pass some custom options:
export CATALINA_OPTS="-Xmx8g -XX:MaxPermSize=512M -Duser.timezone=UTC \
The value of
-Xmx should be as large as your system will permit. Be sure to
restart Tomcat for changes to take place.
18.104.22.168. Installing the GeoMesa Accumulo Data Store¶
To install the GeoMesa data store, extract the contents of the
geomesa-accumulo-gs-plugin_2.11-$VERSION-install.tar.gz file in
in the binary distribution or
geomesa-accumulo/geomesa-accumulo-gs-plugin/target/ in the source
distribution into your GeoServer’s
$ tar -xzvf \
Next, install the JARs for Accumulo and Hadoop. By default, JARs will be downloaded from Maven central. You may
override this by setting the environment variable
GEOMESA_MAVEN_URL. If you do no have an internet connection
you can download the JARs manually via http://search.maven.org/.
Edit the file
geomesa-accumulo_2.11-$VERSION/conf/dependencies.sh to set the versions of Accumulo and Hadoop
to match the target environment, and then run the script:
$ ./bin/install-dependencies.sh /path/to/geoserver/webapps/geoserver/WEB-INF/lib
Due to a classpath conflict with GeoServer, the version of Accumulo client JARs installed must be 1.9.2 or later. Note that newer Accumulo clients can talk to older Accumulo instances, so it is only necessary to upgrade the client JARs in GeoServer, but not the entire Accumulo cluster.
GeoServer ships with an older version of commons-text, 1.4. The
install-dependencies.sh script will
remove it, but if you don’t use the script you will need to delete it manually.
The specific JARs needed for some common configurations are listed below:
Restart GeoServer after the JARs are installed.
To upgrade between minor releases of GeoMesa, the versions of all GeoMesa components
must match. This means that the version of the
JAR installed on Accumulo tablet servers must match the version of the
geomesa-plugin JARs installed in the
WEB-INF/lib directory of GeoServer.
See Upgrade Guide for more details on upgrading between versions.