Install DataStax Enterprise (DSE) 5.1 with a binary tarball
You can use a binary tarball to install DataStax Enterprise (DSE) 5.1 on bare metal or a virtual machine (VM) running a supported Linux platform.
For new deployments, DataStax recommends the latest patch release. If you are scaling an existing deployment, install the same patch release as the existing nodes. For a summary of features and changes in each release, see the DSE 5.1 release notes.
When installed from a tarball, DSE runs as a standalone process, with or without root permissions.
|
When you install DSE, it automatically creates a |
For other installation options, see Which install method should I use?.
Prerequisites
-
Prepare an environment where you want to install DSE, including sufficient hardware and a supported platform.
-
For RHEL-compatible platforms, enable Extra Packages for Enterprise Linux (EPEL).
-
Install a supported Java runtime: OpenJDK 8 (recommended) or Oracle Java SE 8 (JDK).
If you install multiple Java versions, set your
$JAVA_HOMEenvironment variable to Java 8. -
To run the CQL shell (
cqlsh), install a supported Python version. DataStax recommends 3.8 to 3.11. Later versions aren’t supported.Use earlier versions (2.7, 3.6, or 3.7) only if required to support a legacy deployment running an early patch release of DSE 5.1 where the OS or included
cqlshbinary doesn’t support a recommended Python version. -
For production installations and simulated production test environments, review the recommended settings.
Some settings can be applied before installing DSE. For settings that require a running DSE instance, plan to apply them after the installation.
Download and extract the tarball
-
From a terminal window, install the
libaiopackage that matches your environment:- RHEL
-
sudo yum install libaio - Debian
-
sudo apt-get install libaio1 - Ubuntu 24.04 and later
-
On Ubuntu 24.04 and later, the
libaiolibrary was renamed tolibaio1t64. DSE requires a symlink from the old library name to the new one to detect it properly. Without this link, DSE issues a warning about the missing library and performance is significantly degraded.sudo apt-get install libaio1t64sudo ln -s /lib/x86_64-linux-gnu/libaio.so.1t64 /lib/x86_64-linux-gnu/libaio.so.1
-
Find DSE 5.1 on IBM Fix Central:
-
Go to Fix Central.
-
In the Product selector field, begin typing
IBM DataStax Enterprise, and then select that option from the menu. -
In the Release field, select the version that you want to install.
-
Click Continue.
-
On the Identify fixes page, click Continue to use the default Browse for fixes option.
-
On the Select fixes page, select the fix pack (DSE version) you want to install, and then click Continue.
Depending on the product and version, more fix packs might be available if you set the Platform filter to All, and then click Submit.
-
If prompted, sign in with your IBMid.
An IBMid account with MFA enabled is required. If you don’t have one, create an IBMid account. If your organization uses Enterprise Federation (EF) for authentication with corporate credentials, see the IBMid EF documentation.
-
On the Download options page, select Download using your browser (HTTPS), and then click Continue.
-
Review the terms and conditions, and then click I agree to activate the download links.
-
-
Click the DSE tarball link to download the file, for example,
dse-5.1.48-bin.tar.gz. -
Extract the tarball file into the directory where you want to install DSE:
sudo tar -xzvf dse-5.1.48-bin.tar.gz -C INSTALLATION_DIRECTORY -
Change to the directory where you extracted the tarball:
cd INSTALLATION_DIRECTORY/dse-5.1.48
Configure data and log directories
-
Use either the default DSE data and log directory locations, or define your own custom directory locations:
- Default directory locations
-
DSE stores its runtime data and logs in default locations unless otherwise configured in
cassandra.yaml. Make sure these directories exist and have the correct ownership before starting DSE.Run the following commands to create and change ownership for the default DSE data and log directories:
sudo mkdir -p /var/lib/cassandra /var/log/cassandrasudo chown -R cassandra:cassandra /var/lib/cassandra /var/log/cassandraIf you plan to run DSE as a different user, replace
cassandra:cassandrawith that user and group. - Custom directory locations
-
To store DSE data and logs in custom locations, create and change ownership for your custom DSE data and log directories, replacing
CUSTOM_DIRECTORYwith the absolute path to your custom directory locations. For example:sudo mkdir -p \ CUSTOM_DIRECTORY/dse-data/commitlog \ CUSTOM_DIRECTORY/dse-data/saved_caches \ CUSTOM_DIRECTORY/dse-data/hints \ CUSTOM_DIRECTORY/cdc_rawsudo chown -R cassandra:cassandra \ CUSTOM_DIRECTORY/dse-data \ CUSTOM_DIRECTORY/cdc_rawIf you plan to run DSE as a different user, replace
cassandra:cassandrawith that user and group.Then, update the following settings in the
cassandra.yamlfile to point to your custom directory locations. For tarball installations, the default location of thecassandra.yamlfile is<installation_location>/resources/cassandra/conf/cassandra.yaml.data_file_directories: - CUSTOM_DIRECTORY/dse-data commitlog_directory: CUSTOM_DIRECTORY/dse-data/commitlog saved_caches_directory: CUSTOM_DIRECTORY/dse-data/saved_caches hints_directory: CUSTOM_DIRECTORY/dse-data/hints cdc_raw_directory: CUSTOM_DIRECTORY/cdc_raw
-
Optional: If you plan to use DSE Analytics, you can use either the default Spark data and log directory locations or define your own custom directory locations:
- Default directory locations
-
When you enable DSE Analytics, the Spark components write temporary data and logs to specific directories unless otherwise configured in
spark-env.shordse.yaml. Make sure these directories exist and have the correct ownership before starting DSE.Run the following commands to create and change ownership for the default Spark data and log directories:
sudo mkdir -p \ /var/lib/dsefs \ /var/lib/spark \ /var/lib/spark/rdd \ /var/lib/spark/worker \ /var/log/spark \ /var/log/spark/master \ /var/log/spark/alwayson_sqlsudo chown -R cassandra:cassandra /var/lib/dsefs /var/lib/spark /var/log/sparkIf you plan to run DSE as a different user, replace
cassandra:cassandrawith that user and group. - Custom directory locations
-
Follow these steps to store Spark data and logs in custom locations:
-
Create and change ownership for your custom Spark data and log directories. For example:
sudo mkdir -p \ CUSTOM_DIRECTORY/dsefs \ CUSTOM_DIRECTORY/spark/rdd \ CUSTOM_DIRECTORY/spark/worker \ CUSTOM_DIRECTORY/spark/log/worker \ CUSTOM_DIRECTORY/spark/log/master \ CUSTOM_DIRECTORY/spark/log/alwayson_sqlsudo chown -R cassandra:cassandra \ CUSTOM_DIRECTORY/dsefs \ CUSTOM_DIRECTORY/sparkReplace
CUSTOM_DIRECTORYwith the absolute path to your custom directory locations.If you plan to run DSE as a different user, replace
cassandra:cassandrawith that user and group. -
Update the following environment variables in the
spark-env.shfile to point to your custom directory locations:export SPARK_WORKER_DIR="CUSTOM_DIRECTORY/spark/worker" export SPARK_EXECUTOR_DIRS="CUSTOM_DIRECTORY/spark/rdd" export SPARK_WORKER_LOG_DIR="CUSTOM_DIRECTORY/spark/log/worker" export SPARK_MASTER_LOG_DIR="CUSTOM_DIRECTORY/spark/log/master" export ALWAYSON_SQL_LOG_DIR="CUSTOM_DIRECTORY/spark/log/alwayson_sql"Replace
CUSTOM_DIRECTORYwith the absolute path to your custom directory locations.The default location of the
spark-env.shfile depends on the type of installation:-
Package installations and Installer-Services installations:
/etc/dse/spark/spark-env.sh -
Tarball installations and Installer-No Services installations:
<installation_location>/resources/spark/conf/spark-env.sh
-
-
In the
dse.yamlfile, update the location of the DataStax Enterprise file system (DSEFS) work directory to point to your custom location:dsefs_options: work_dir: CUSTOM_DIRECTORY/dsefsReplace
CUSTOM_DIRECTORYwith the absolute path to your custom directory location.The location of the
dse.yamlfile depends on the type of installation:-
Package installations and Installer-Services installations:
/etc/dse/dse.yaml -
Tarball installations and Installer-No Services installations:
<installation_location>/resources/dse/conf/dse.yaml
-
-
Start DSE
-
From the directory where you extracted the tarball files, run the following command to start DSE as a standalone process:
DSE_DIRECTORY/bin/dse cassandraFor other startup options, see Starting DataStax Enterprise as a stand-alone process.
-
Verify that DSE is running:
DSE_DIRECTORY/bin/nodetool statusResultDatacenter: Cassandra ===================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns Host ID Rack UN 127.0.0.1 82.43 KB 128 ? 40725dc8-7843-43ae-9c98-7c532b1f517e rack1
Next steps
-
For upgrades, go to the next step in the upgrade guide
-
Default file locations for tarball and Installer-No Services installations
-
Change the logging locations after installation