Using the DataStax Installer to install (root permissions required)

Instructions for installing or upgrading DataStax Enterprise (DSE) 5.1 using the DataStax Installer when you have root permissions.

If you don’t have root permissions or want to install in a custom directory, see Using the DataStax Installer to install (root permissions not required) or use the binary tarball.


When DSE is installed, it creates a superuser called cassandra in the database and runs as this user. It also creates this same superuser in the operating system. Do not use the cassandra superuser in production. Using the cassandra superuser is a security risk. See Adding a superuser login.


About DataStax installer

The DataStax installer installs DataStax Enterprise and DataStax Agent. It does not install OpsCenter. If you select Developer Related Tools during installation, DataStax Studio is installed.

The installer sets some but not all cassandra.yaml parameters.

Where is the cassandra.yaml file?

The location of the cassandra.yaml file depends on the type of installation:

Installation Type Location

Package installations + Installer-Services installations


Tarball installations + Installer-No Services installations


The installer does not set dse.yaml properties.

Where is the dse.yaml file?

The location of the dse.yaml file depends on the type of installation:

Installation Type Location

Package installations + Installer-Services installations


Tarball installations + Installer-No Services installations


Set the remaining parameters in the following ways:


End User License Agreement (EULA). By downloading this DataStax product, you agree to the terms of the EULA.

In a terminal window:

  1. Download the installer for your computer from the DataStax download page or use the following command:

    curl -O

    To install earlier versions, replace the version number in the above command. To view the available versions, see the Release notes.

  2. From the directory where you downloaded the install file, change the permission to executable:

    chmod +x
  3. To view the installer help:

    ./ --help

    Help displays a list of the available options and their default settings.

  4. Start the installation:

    • No configuration parameters:

      sudo ./
      sudo ./ --mode text
    • Configuration parameters:

      sudo ./ --enable_vnodes 0 ## Command line option.
      sudo ./ --optionfile ../datastax/DC4-analytics.prop ## Property file option.

      For configuration parameter information, see the installer options described in Using the DataStax Installer to install using command line or properties file commands.

    The installer launches.

    install GUIstart
    Launching the DSE installer
  5. After accepting the License Agreement, select the type of install. In Service Setup, select Services and Utilities.

    • Services and Utilities: Sets up DataStax Enterprise as a service. It installs DataStax Enterprise in system locations.

    • No Services: Sets up DataStax Enterprise as a standalone process. It does not require root or sudo access.

  6. Select the Install Type:

  7. Set up the node:

    Node setup

    Default Interface

    Network interface for the DataStax Enterprise server. Single node clusters: use

    Cluster Name

    Name of the cluster. You must use the same cluster name for each node in the cluster.


    All nodes use the seed node list for finding each other and learning the topology of the ring.

    Single node clusters: Set to empty.

    Multiple node clusters: List of seed nodes. (Do not make all nodes seed nodes.)

    Additional information:

    Install developer related tools

    Includes the following:

DataStax Enterprise demos

Running the Wikipedia demo with SearchAnalytics

Running the Weather Sensor demo

Term and phrase searches using the wikipedia demo

Using secure cluster

  1. If an installation of DataStax Enterprise already exists, the installer displays upgrade information and installs DSE in the following locations:

    • Installer-Services installations: /usr/share/dse

    • No Services installations: Previous installation location

    Before upgrading an existing cluster, see the DataStax Upgrade Guide.

    The important files to review for upgrade are dse.yaml, cassandra.yaml, and for service installs /etc/default/dse.

    If or have been modified, make modifications to the or the instead. Changing these files is not recommended.

  2. Set up the node type:

    DSE Setup

    DSE Analytics

    DSE Analytics includes integration with Apache Spark™.

    DSE Search

    DSE Search includes integration with Apache Solr™.

    DSE Graph

    DSE Graph is a graph database for managing, analyzing, and searching highly-connected data.

    DSE Advanced Replication

    DSE Advanced Replication supports configurable distributed data replication from source clusters to destination clusters bi-directionally that can experience sporadic connectivity.

  3. Set the ring options:

    Ring Options

    Enable Virtual Nodes (vnodes)

    Enable or disable Virtual nodes.

    Number of tokens

    Token recommendations for vnodes:

    • Transactional nodes: 128

    • Analytical nodes (Spark): 128

    • Search nodes: 8

    • DSE Graph: 128. When used with DSE Search: 8

    Listen Address

    cassandra.yaml: listen_address

    RPC Address

    cassandra.yaml: rpc_address

  4. Set up the miscellaneous options:

    Misc Options

    Update Operating System

    Update some system packages and dependencies. Does not upgrade or install major components such as Java.

    Start services

    • Yes starts all services when the installation is complete.

    • No, select when additional configuration is needed after installation.

    OpsCenter Address

    Optional. The server name or IP address for OpsCenter.

    If performing a Simple installation, go to step 16.

The following steps are displayed when Advanced is selected in step 5.

  1. Optional: Set up the Preflight Check (Advanced Installations only):

    Preflight Check Options

    Run Preflight Check

    A collection of tests that can detect and fix a node’s configuration. The tool can detect and fix many invalid or suboptimal configuration settings. It is not available in No Services installations.

    Attempt to Fix Issues

    Enable DataStax Enterprise to attempt to fix invalid or suboptimal configuration settings.

    SSD Drives

    Enter the paths to the Solid State Drives. Separate the drives by a comma.


    Enter the paths to the hard drives. Separate the drives by a comma.

    Time to run Disk Benchmarks

    Set to simulate a normal load.

    Threads per Disk Benchmark

    Set to simulate a normal load.

  2. Change the default user and user group (Advanced Installations only):

    User Setup

    OS User ID for Service

    Default: cassandra. Because the DataStax Agent relies on user cassandra, DataStax does not recommend changing the default. If changed, you must manually install, update, and configure the DataStax Agent.

    OS User Group for Service

    Default: cassandra. See above.

  3. Change the default directory locations (Advanced Installations only):

    Directory Locations

    Data Directory

    cassandra.yaml: data_file_directories

    Commitlog Directory

    cassandra.yaml: commitlog_directory

    Saved Caches Directory

    cassandra.yaml: saved_caches_directory

    Hints Directory

    cassandra.yaml: hints_directory

    Logs Directory

    Log data for the database, Spark, and Tomcat. See the default file locations for Installer-Services and package installations or Installer-No Services and tarball installations.

  4. Change the default ports (Advanced Installations only):


    Storage Port

    cassandra.yaml: storage_port

    SSL Storage Port

    cassandra.yaml: ssl_storage_port

    RPC Port

    cassandra.yaml: rpc_port

  5. In System Configuration, review any warnings about potential issues.

  6. After the installation completes, review the installation logs to verify the installation.

    If you have closed the logs, see Services or No-Services installer locations.

    DataStax Enterprise is ready for additional configuration.

  7. Optional: Single-node cluster installations only:

    1. If DataStax Enterprise is not already running:

    2. Verify that DataStax Enterprise is running:

      • Package and Installer-Services installations:

        nodetool status
      • Tarball and Installer-No Services installations:

        <installation_location>/bin/nodetool status

      Results using vnodes:

      Datacenter: Cassandra
      |/ State=Normal/Leaving/Joining/Moving
      --  Address    Load       Tokens  Owns    Host ID                               Rack
      UN  82.43 KB   128     ?       40725dc8-7843-43ae-9c98-7c532b1f517e  rack1

      Results not using vnodes:

      Datacenter: Analytics
      |/ State=Normal/Leaving/Joining/Moving
      --  Address         Load       Owns    Host ID                               Token                 Rack
      UN  103.24 KB  ?       3c1d0657-0990-4f78-a3c0-3e0c37fc3a06  1647352612226902707   rack1

Next steps

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000,