DataStax Enterprise 1.0 Documentation

Quick Start with DataStax Enterprise

This document corresponds to an earlier product version. Make sure you are using the version that corresponds to your version.

Latest DSE documentation | Earlier DSE documentation

The fastest way to get up and running quickly with DataStax Enterprise (DSE) is to install the DSE tarball distributions and start a single-node analytics instance. DSE is intended to be run on multiple nodes, however installing a single-node cluster is a great way to get started.

Getting up and running takes just four simple steps:

  1. Register with DataStax. DataStax Enterprise is available to DataStax registered users and support customers. To download DSE, you will need the username and password provided in your DataStax registration confirmation email. If you are a DataStax support customer and are not sure of your login credentials, contact DataStax Customer Support.
  2. Make sure you have Java installed
  3. Install DataStax Enterprise
  4. Set a couple of configuration properties and start the DSE server

Checking for a Java Installation

DSE is a Java program and requires a Java Virtual Machine (JVM) to be installed before you can start the server. For production deployments, you will need the Sun Java Runtime Environment 1.6.0_19 or later, but if you are just kicking the tires, any JVM should do.

To check for Java, run the following command:

# java -version

If you do not have Java installed, see Installing the JRE on RHEL or CentOS Systems or Installing the JRE on Debian or Ubuntu Systems for instructions.

Installing the DataStax Enterprise Binaries

The quickest way to get going on a single node with DataStax Enterprise (DSE) is to install the DSE binary tarball packages. This allows you to install everything in a single location (such as your home directory), and does not require root permissions.

DataStax Enterprise is comprised of two components - The DSE server (Cassandra and CassandraFS-enabled Hadoop plus a sample demo application) and DataStax OpsCenter (a web-based monitoring application for Cassandra and DSE Analytics).

These instructions will walk you through setting up a self-contained, single-node instance of DataStax Enterprise in your home directory (does not require root permissions).


The instructions in this section are not intended for production installations, just for a quick start. See Installing DataStax Enterprise Packaged Releases or Tarball Distribution and init-dse for DSE cluster installation best practices.


By downloading DSE software from DataStax you agree to the terms of the DataStax Enterprise EULA (end user license agreement) posted on the DataStax web site.

  1. In your home directory, create a directory called datastax. In that directory download the DSE package (required), plus the OpsCenter package (optional). Substitute <username>:<password> with your correct DataStax login credentials.

    $ cd $HOME
    $ mkdir datastax
    $ cd datastax
    $ wget http://<username>:<password>
    $ wget http://<username>:<password>
  2. Unpack the distributions:

    $ tar -xzvf dse-1.0.1-bin.tar.gz
    $ tar -xzvf opscenter-1.4.tar.gz
    $ rm *.tar.gz
  3. For convenience, set the following environment variables in your user environment. For example, to configure your environment in your $HOME/.bashrc file:

    1. Open your .bashrc file in a text editor (such as vi):

      vi $HOME/.bashrc
    2. Add the following lines to bottom of the file:

      export DSE_HOME=$HOME/datastax/dse-1.0.1
      export CASSANDRA_HOME=$DSE_HOME/resources/cassandra
      export OPSC_HOME=$HOME/datastax/opscenter-1.4
      export PATH="$PATH:$DSE_HOME/bin:$CASSANDRA_HOME/bin:$OPSC_HOME/bin"
    3. Save and close the file.

    4. Source the file.

      source $HOME/.bashrc
  4. Create the data and logging directories needed by DSE.

    $ mkdir $HOME/datastax/dse-data

Configuring and Starting a Single-Node DataStax Enterprise Cluster

DSE is intended to be run on multiple nodes, however a single node cluster is great for evaluation purposes. To configure and start a single DSE analytics node:

  1. Set the configuration properties needed to start your cluster in the $DSE_HOME/resources/cassandra/conf/cassandra.yaml file. This will configure DSE to run a single-node cluster on the localhost and store all of its data files in your home directory.

    $ sed -i -e "s,initial_token:,initial_token: 0," \
    $ sed -i -e "s,listen_address:,listen_address:," \
    $ sed -i -e "s,- /var/lib/cassandra/data,- $HOME/datastax/dse-data," \
    $ sed -i -e "s,saved_caches_directory: /var/lib/cassandra/saved_caches, \
      saved_caches_directory: $HOME/datastax/dse-data/saved_caches," \
    $ sed -i -e "s,commitlog_directory: /var/lib/cassandra/commitlog,commitlog_directory: \
      $HOME/datastax/dse-data/commitlog," $DSE_HOME/resources/cassandra/conf/cassandra.yaml
  2. Set the DSE server log location in the $DSE_HOME/resources/cassandra/conf/ file to the log directory you created earlier:

    $ sed -i -e "s,log4j.appender.R.File=/var/log/cassandra/system.log, \
      log4j.appender.R.File=$HOME/datastax/dse-data/system.log," \
  3. Configure the DataStax demo application to point to the correct Cassandra installation location:

    $ sed -i -e "s,/usr/share/cassandra,$HOME/datastax/dse-1.0.1/resources/cassandra," \
  4. Start DSE (as an analytics node). The -t option starts Cassandra plus CassandraFS and the Hadoop JobTracker and TaskTracker processes. Because there is no Hadoop NameNode with CassandraFS, there is no additional configuration to run MapReduce jobs in single mode versus distributed mode when using DataStax Enterprise.

    $ dse cassandra -t

    When running on a single node, the Cassandra seed node and DSE job tracker node are automatically set to localhost.

  5. Check that your DSE ring is up and running:

    $ nodetool ring -h localhost
  6. For the next hands-on steps, run the Portfolio Demo example application.

Configuring and Starting DataStax OpsCenter

DataStax OpsCenter is a graphical web application that can be used to manage and monitor a DataStax Enterprise cluster.


The machines on which you install OpsCenter must have:

  • Sun Java Runtime Environment version 1.6.0_19 or higher.
  • Python 2.5 or higher.
  • OpenSSL

To check for these prerequisites:

$ java -version
$ python -V
$ which openssl

Installing OpsCenter

This instructions assume that you have previosusly unpacked opscenter.tar.gz as described above.


For instructions about installing OpsCenter on various platforms, see OpsCenter Installation Guide.

  1. For convenience, set the following environment variables in your user environment (such as in your $HOME/.bashrc file):

    export OPSC_HOME=<install_location>/opscenter-1.4
    export PATH="$PATH:$OPSC_HOME/bin"
  2. Set the required configuration properties for your environment in the opscenterd.conf file located in $OPSC_HOME/conf/opscenterd.conf. See OpsCenter Configuration Properties

  3. From the OpsCenter home directory, run the bin/ script. This sets up SSL for OpsCenter and creates a agent.tar.gz file for installing the agents (may take a couple of minutes to return). On Linux, for example:

    $ cd $OPSC_HOME
    $ ./bin/
  4. Start OpsCenter.

    $ opscenter

    By default OpsCenter starts in the background. To start OpsCenter in the foreground, use the -f option.

    $ opscenter -f
  5. Use the agent.tar.gz file that gets created to manually install the OpsCenter agents on the nodes in your Cassandra or DSE cluster. See Manually Installing Agents - Packaged Installations.

    The tar installation does not support automatic agent installs.

This will open the OpsCenter Dashboard. If you select Cluster > Ring View, you should see your single DSE Analytics node running on the localhost.