Apache Accumulo Proxy

Clone this repo:

Branches

  1. 95f9c90 Merge pull request #29 from apache/dependabot/maven/org.apache.accumulo-accumulo-core-2.0.1 by Mike Miller · 2 months ago main
  2. 60a8d9a Merge pull request #30 from apache/dependabot/maven/commons-io-commons-io-2.7 by Mike Miller · 2 months ago
  3. d07a64a Bump commons-io from 2.6 to 2.7 by dependabot[bot] · 2 months ago
  4. caf6e13 Bump accumulo-core from 2.0.0 to 2.0.1 by dependabot[bot] · 2 months ago
  5. a1905be Bump guava from 28.2-jre to 29.0-jre (#28) by dependabot[bot] · 1 year, 4 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 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.