Apache Accumulo Proxy

Clone this repo:


  1. 03865fb Bump guava from 31.1-jre to 32.0.0-jre (#80) by dependabot[bot] · 10 months ago main
  2. 0f92cb3 Simplify logic in attachIteratorsWithScans() test (#79) by Dom G · 1 year, 2 months ago
  3. 29d6068 Make sure sharedSecret is set in ProxyServer (#78) by Dom G · 1 year, 2 months ago
  4. 6b1f549 Make TestProxyClient AutoClosable (#76) by Dom G · 1 year, 2 months ago
  5. 59c4870 Remove Kerberos from ITs (#75) by Dom G · 1 year, 2 months ago

Apache Accumulo Proxy

Build Status Maven Central Javadoc Apache License

This application acts as an Apache Accumulo Java client, and exposes its API as an Apache Thrift service so that users can use their preferred programming language to communicate with Accumulo (provided that language has a supported Thrift language binding).

Running the Accumulo proxy

  1. Build the proxy tarball and install it.

    cd /path/to/accumulo-proxy
    mvn clean package -Ptarball
    tar xzvf ./target/accumulo-proxy-2.0.0-SNAPSHOT-bin.tar.gz -C /path/to/install
  2. Edit proxy.properties and run the proxy.

    cd /path/to/install/accumulo-proxy-2.0.0-SNAPSHOT
    ./bin/accumulo-proxy -p conf/proxy.properties

Docker Environment

The Accumulo Proxy can also now be packaged and started in a Docker container, see the DOCKER.md for full details.

Build language specific bindings

Bindings have been built in src/main/ for Java, Python, and Ruby.

Bindings for other languages can be built using the Thrift compiler. Follow the Thrift tutorial to install a Thrift compiler and use the following command to generate language bindings.

thrift -r --gen <language> <Thrift filename>

Create an Accumulo client using Python

Run the commands below to install the Python bindings and create an example Python client:

mkdir accumulo-client/
cd accumulo-client/
pipenv --python 2.7
pipenv install thrift
pipenv install -e /path/to/accumulo-proxy/src/main/python
cp /path/to/accumulo-proxy/src/main/python/basic_client.py .
# Edit credentials if needed
vim basic_client.py
pipenv run python2 basic_client.py

Create an Accumulo client using Ruby

Run the command below to create an example Ruby client:

mkdir accumulo-client/
cd accumulo-client/
cp /path/to/accumulo-proxy/src/main/ruby/Gemfile .
vim Gemfile # Set correct path
cp /path/to/accumulo-proxy/src/main/ruby/client.rb .
gem install bundler
bundle install
bundle exec ruby client.rb

Java clients to Proxy

Java clients to the Proxy can be written to limit access to the cluster. The proxy can be placed on a server in the cluster and clients can communicate with proxy from outside of the cluster.