18.2. Installing GeoMesa Lambda¶
18.2.1. Installing from the Binary Distribution¶
GeoMesa Lambda 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 (2.3.0) 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-lambda-dist_2.11-$VERSION-bin.tar.gz" $ tar xvf geomesa-lambda-dist_2.11-$VERSION-bin.tar.gz $ cd geomesa-lambda-dist_2.11-$VERSION $ ls bin/ conf/ dist/ docs/ examples/ lib/ LICENSE.txt logs/
18.2.2. Building from Source¶
GeoMesa Lambda 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 Lambda
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.
18.2.3. Installing the Accumulo Distributed Runtime Library¶
The Lambda data store requires the Accumulo data store distributed runtime to be installed. See Installing the Accumulo Distributed Runtime Library.
18.2.4. Setting up the Lambda Command Line Tools¶
GeoMesa comes with a set of command line tools located in
geomesa-lambda_2.11-$VERSION/bin/ of the binary distribution.
You can configure environment variables and classpath settings in geomesa-lambda_2.11-$VERSION/conf/geomesa-env.sh.
geomesa-lambda_2.11-$VERSION directory, run
bin/geomesa-lambda configure to set up the tools.
Please note that the
$GEOMESA_LAMBDA_HOME variable points to the location of the
directory, not the main geomesa binary distribution directory.
geomesa-lambda will read the
$KAFKA_HOME environment variables
to load the runtime dependencies. If possible, we recommend installing the tools on the Accumulo master server,
as you may also need various configuration files from Hadoop/Accumulo in order to run certain commands.
GeoMesa provides the ability to provide additional jars on 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 mapreduce libjars variable.
geomesa classpath command to print the final classpath that will be used when executing geomesa
If you are running the tools on a system without Accumulo, Hadoop, or Kafka, the
install-kafka.sh scripts in the
bin directory may be used to download the required JARs into
lib directory. You should edit this script to match the versions used by your installation.
See Logging Configuration for information about configuring the SLF4J implementation.
Due to licensing restrictions, dependencies for shape file support must be separately installed. Do this with the following commands:
$ bin/install-jai.sh $ bin/install-jline.sh
Test the command that invokes the GeoMesa Tools:
$ geomesa-lambda Usage: geomesa-lambda [command] [command options] Commands: ...
GeoMesa Accumulo command-line tools can be used against features which have been persisted to Accumulo. See Setting up the Accumulo Command Line Tools for details on the Accumulo command-line tools.
18.2.5. Installing GeoMesa Lambda in GeoServer¶
GeoMesa 2.2.0 and later require GeoServer 2.14.0 or later. GeoMesa 2.1.0 and earlier require GeoServer 2.12.5.
As described in section GeoMesa and GeoServer, GeoMesa implements a GeoTools-compatible data store. This makes it possible to use GeoMesa as a data store in GeoServer. GeoServer’s web site includes installation instructions for GeoServer.
After GeoServer is installed, you may install the WPS plugin if you plan to use GeoMesa processes. The GeoServer WPS Plugin must match the version of the 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 \ -server -Djava.awt.headless=true"
The value of
-Xmx should be as large as your system will permit; this
is especially important for the Kafka plugin. You
should also consider passing
as well. Be sure to restart Tomcat for changes to take place.
To install the GeoMesa Lambda data store as a GeoServer plugin, unpack the contents of the
geomesa-lambda-gs-plugin_2.11-$VERSION-install.tar.gz file in
in the binary distribution or
geomesa-$VERSION/geomesa-lambda/geomesa-lambda-gs-plugin/target/ in the source
distribution into your GeoServer’s
lib directory (
$VERSION = 2.3.0):
If you are using Tomcat:
$ tar -xzvf \ geomesa-lambda_2.11-$VERSION/dist/geoserver/geomesa-lambda-gs-plugin_2.11-$VERSION-install.tar.gz \ -C /path/to/tomcat/webapps/geoserver/WEB-INF/lib/
If you are using GeoServer’s built in Jetty web server:
$ tar -xzvf \ geomesa-lambda_2.11-$VERSION/dist/geoserver/geomesa-lambda-gs-plugin_2.11-$VERSION-install.tar.gz \ -C /path/to/geoserver/webapps/geoserver/WEB-INF/lib/
There are additional JARs for Accumulo, Zookeeper, Hadoop, Thrift and Kafka that you will need to copy to GeoServer’s
WEB-INF/lib directory. The versions required will be specific to your installation. For example, GeoMesa only
requires Hadoop 2.6 or later, but if you are using Hadoop 2.5.0 you should use the JARs
that match the version of Hadoop you are running.
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.
There are scripts in the
install-kafka.sh) which will install these dependencies to a target directory
curl (requires an internet connection).
You may have to edit
install-kafka.sh to set the
versions of Accumulo, Zookeeper, Hadoop, Thrift and Kafka that you are running.
If you do no have an internet connection you can download the JARs manually via http://search.maven.org/. These may include the JARs below; the specific JARs needed for some common configurations are listed below:
Accumulo 1.7+ (note the addition of htrace)
Hadoop 2.4-2.7 (adjust versions as needed)
Restart GeoServer after the JARs are installed.
18.104.22.168. Accumulo Versions¶
GeoMesa targets Accumulo 1.8 as a runtime dependency. Most artifacts will work with older versions
of Accumulo without changes, however some artifacts which bundle Accumulo will need to be built manually.
Accumulo 1.8 introduced a dependency on libthrift version 0.9.3 which is not compatible with Accumulo
1.7/libthrift 0.9.1. To target an earlier Accumulo version, modify
<thrift.version> in the main pom.xml and re-build.
22.214.171.124. GeoMesa Process¶
Some GeoMesa-specific WPS processes such as
geomesa:Density, which is used
in the generation of heat maps, also require
This JAR is included in the
geomesa-lambda_2.11-$VERSION/dist/gs-plugins directory of the binary
distribution, or is built in the
geomesa-process module of the source
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.
We strive to maintain backwards compatibility for data ingested with older releases of GeoMesa, and in general data ingested with older releases may be read with newer ones (note that the reverse does not apply). For example, data ingested with GeoMesa 1.2.2 may be read with 1.2.3.
It should be noted, however, that data ingested with older GeoMesa versions may not take full advantage of indexing improvements in newer releases. If it is not feasible to reingest old data, see Updating Existing Data to the Latest Index Format for more information on updating its index format.