OSX: Install GemFire XD from a Homebrew Package

If your operating system is Mac OSX, you can install GemFire XD from a Homebrew package.



  1. From the OSX computer on which you will install GemFire XD, open a terminal window.
  2. In the terminal window, enter this command to install Homebrew, if you have not already installed it:
    $ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
  3. After Homebrew is installed, execute this command to install Pivotal GemFire XD:
    $ brew tap pivotal/tap && brew install gemfirexd

    This command downloads and installs the software, and displays the basic usage and documentation links for the product. The GemFire XD software is installed into the /usr/local/Cellar/gemfirexd/1.3.0/libexec directory. A stub for the gfxd executable is created in /usr/local/Cellar/gemfirexd/1.3.0/bin/gfxd and is linked to /usr/local/bin/gfxd.

  4. If you have not already done so, download and install a compatible JDK or JRE on the computer or VM.
  5. GemFire XD requires libraries from Pivotal HD Enterprise in order to create HDFS tables or use the MapReduce API. If you installed GemFire XD on the same machine as Pivotal HD, then GemFire XD will automatically locate the required libraries in the default locations:
    • /usr/lib/gphd/hadoop
    • /usr/lib/gphd/hadoop-mapreduce
    • /usr/lib/gphd/hadoop-hdfs/
    If you installed GemFire XD on a machine that does not have a Pivotal HD installation, then you can use the create_hdfsclient_dist.sh script to create a ZIP file of the necessary libraries, which you can then add to the local GemFire XD installation. Follow these steps to use the script:
    1. Copy the create_hdfsclient_dist.sh script to a machine that has a Pivotal HD installation. The script is installed with GemFire XD as /opt/pivotal/gemfirexd/bin/create_hdfsclient_dist.sh.
    2. Execute the create_hdfsclient_dist.sh on the Pivotal HD machine:
      $ ./create_hdfsclient_dist.sh

      The script packages the necessary library files into a ZIP file named gfxd_hdfsclient_dist.zip in the directory where you executed the script.

    3. Copy the gfxd_hdfsclient_dist.zip back to the machine where you installed GemFire XD.
    4. Unzip the gfxd_hdfsclient_dist.zip file's contents into the /usr/local/Cellar/gemfirexd/1.3.0/ext-lib directory. GemFire XD will now automatically load the necessary Pivotal HD libraries when you start the local member.
  6. Execute gfxd version at the command line to verify that the output shows the version of Pivotal GemFire XD that you installed. For example:
    # gfxd version
    GemFire XD product directory: /usr/local/Cellar/gemfirexd/1.3.0/libexec
    Java version:   1.3.0 build 48393 05/28/2014 15:41:19 PDT javac 1.6.0_26
    Native version: gemfirexd native code unavailable
    Running on: ward-3.local/, 8 cpu(s), x86_64 Mac OS X 10.9.3

Post-Install Configuration

Although the GemFire XD software is installed on each machine, you must perform additional steps to configure and run GemFire XD member(s) on the machine:

  1. Follow the instructions in Steps to Plan and Configure a GemFire XD Deployment to configure one or more GemFire XD members on each machine, and to start those members in a new distributed system.
  2. If you configured Kerberos for security with Pivotal HD, follow the instructions in Configuration Requirements for Secure HDFS to ensure that your GemFire XD members can authenticate with Pivotal HD and persist table data in HDFS.
  3. If you intend to use HAWQ to to access data from HDFS-persistent GemFire XD tables, follow the instructions in Using HAWQ to Access HDFS Table Data to ensure that the Pivotal Extension Framework (PXF) includes the gemfirexd.jar library in its list of dependencies.

Uninstalling GemFire XD

To uninstall the Pivotal GemFire XD Homebrew package, enter the command:
# brew uninstall gemfirexd