Third-party Under Storage Extensions

    This page is intended for users of under storage extensions. Please look at developing extensions for an extension development guide.

    Alluxio can be extended with the addition of under storage modules at runtime. Under storage extensions (built as JARs) can be included at a specific location to be picked up by core Alluxio without the need to restart any running processes. Adding new under storage connectors to Alluxio can be used to enable Alluxio to work with new storage systems which may not have existing support.

    Following is a list of under storage extension projects:

    A command line utility is provided to aid extension manangement.

    Install

    The install command copies the provided JAR to Alluxio servers listed in conf/masters and using rsync and ssh. However, these tools may not be available in all environments. In such a scenario, use other more suitable tools to place the JAR at the location specified in the property alluxio.extensions.dir on Alluxio servers.

    List

    To list the installed extensions on any given host running the Alluxio processes, use the command. The utility lists any installed extensions by scanning the local extensions directory.

    Uninstall

    Installing from a Maven Coordinate

    To install an extension from maven, download the JAR first and then install as follows:

    Once the extension JAR has been distributed, you should be able to mount your under storage using the Alluxio CLI as follows:

    where, <key>=<value> can be replaced with any required configuration for the under storage.