Using the DataStax Installer to install using command line or properties file commands
Instructions for installing DataStax Enterprise 5.1 using the DataStax Installer using command line or properties file commands.
SECURITY RISK When DSE is installed, it creates a superuser called |
Prerequisites
-
Root or sudo access.
-
Configure your operating system to use the latest version of Java 8:
-
Recommended. The latest build of a TCK (Technology Compatibility Kit) Certified OpenJDK version 8. For example, OpenJDK 8 (1.8.0_151 minimum). DataStax’s recommendation changed due to the end of public updates for Oracle JRE/JDK 8. See Oracle Java SE Support Roadmap.
-
Supported. Oracle Java SE 8 (JRE or JDK) (1.8.0_151 minimum)
-
-
Python 2.7.x or 3.6+. Both are supported for
cqlsh
. For older RHEL distributions, see Installing Python 2.7 on older RHEL-based package installations.
About the installer
The DataStax installer installs DataStax Enterprise and the DataStax Agent.
If developer_install
is specified, it installs DataStax Studio.
It does not install OpsCenter.
You can use this installer to set cassandra.yaml
and dse.yaml
properties with the following template files:
-
cassandra_yaml_template
-
dse_yaml_template
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 |
|
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 |
|
The DataStax Enterprise download page provides a sample_install_5.1.prop
file.
Procedure
End User License Agreement (EULA). By downloading this DataStax product, you agree to the terms of the EULA. |
In a terminal window:
-
Download the installer for your computer from the DataStax download page or use the following command:
curl -O https://downloads.datastax.com/enterprise/DataStaxEnterprise-5.1-linux-x64-installer.run
To install earlier versions, replace the version number in the above command. To view the available versions, see the Release notes.
-
From the directory where you downloaded the install file, change the permission to executable:
chmod +x DataStaxEnterprise-5.1-linux-x64-installer.run
-
You can either use the command line or a properties file:
-
sudo ./DataStaxEnterprise-5.1-linux-x64-installer.run --option argument --option argument ... --option argument --mode unattended
For available options, see the table below. Be sure to add "--" to the option. For example:
sudo ./DataStaxEnterprise-5.1-linux-x64-installer.run --enable_vnodes 0 --mode unattended
The installer uses the default value for any unspecified option.
-
sudo ./DataStaxEnterprise-5.1-linux-x64-installer.run --optionfile option_file_name --mode unattended
where
option_file_name
is the name of the file containing the installation options. For example:sudo ./DataStaxEnterprise-5.1-linux-x64-installer.run --optionfile ../datastax/DC4-analytics.prop --mode unattended
Properties file format:
option=argument
. For example:install_type=simple update_system=1
The properties file options are the same as the command line options without the
--
.Custom installation location example:
sudo ./DataStaxEnterprise-5.1-linux-x64-installer.run --optionfile ../datastax/custom_location.prop --mode unattended
system_install=no_services prefix=/home/dse
Table 1. Unattended install options Option Argument Description Install options
prefix
(No services installations only)
<installation_location>
Set installation location available only for No Services installations.
For upgrade installations, No Services installations use the previous installation location.
file_name
Template for
cassandra.yaml
file.dse_yaml_template
file_name
Template for
dse.yaml
file.logs_dir
log_location
Set the log directory for the database and Spark data.
developer_install
developer_install
Install demos and Javadoc.
do_drain
0 (no) or 1 (yes)
Drain existing node before installing.
Default: 1
start_services
0 (no) or 1 (yes)
Start services after installation.
Default: 1
update_system
0 (no) or 1 (yes)
Update some system packages and dependencies. Does not upgrade or install major components such as Java.
Default: 1 for root user, 0 for others.
Set up node type options
install_type
simple or advanced
Set install type:
-
simple - installs DataStax Enterprise using the default path names and options.
-
advanced - configure path names and options. See Install Type.
Default: simple
system_install
Use one of the following:
-
no_services
-
services_and_utilities
Set up DataStax Enterprise as a service or standalone process. If installed as a service, installs DataStax Enterprise in system locations. Default: services_and_utilities for root user, no_services for others.
For Services installations, the installer puts DataStax Enterprise in system locations and
/usr/share/dse
.For upgrade installations, No Services installations use the previous installation location. For Services installations, the installer puts DataStax Enterprise in system locations and
/usr/share/dse
.enable_analytics
0 (no) or 1 (yes)
Enable or disable DSE Analytics.
Default: 0
enable_search
0 (no) or 1 (yes)
DSE Search includes integration with Apache Solr™.
Default: 0
enable_graph
0 (no) or 1 (yes)
DSE Graph is a graph database for managing, analyzing, and searching highly-connected data.
Default: 0
enable_advrepl
0 (no) or 1 (yes)
DSE Advanced Replication supports configurable distributed data replication from source clusters to destination clusters bi-directionally that can experience sporadic connectivity.
Default: 0
opscenter_address
opscenter_address
Optional. The server name or IP address for OpsCenter.
Preflight check options
run_pfc
(Services installations only)
0 (no) or 1 (yes)
Preflight tool is a collection of tests that can be run on a node to detect and fix a configuration. The tool can detect and fix many invalid or suboptimal configuration settings. Not available for No Services installations.
pfc_fix_issues
(Services installations only)
0 (no) or 1 (yes)
Attempt to fix invalid or suboptimal configuration settings. Not available for No Services installations.
pfc_ssd
(Services installations only)
paths_to_SSDs
Paths to the Solid State Drives. Separate the drives by a comma. Not available for No Services installations.
pfc_devices
(Services installations only)
paths_to_hard_drives
Paths to your hard drives. Separate the drives by a comma. Not available for No Services installations.
pfc_disk_duration
(Services installations only)
Set to simulate a normal load. Not available for No Services installations.
pfc_disk_threads
(Services installations only)
Set to simulate a normal load. Not available for No Services installations.
User and user group options
cassandra_user
user_name
User name for running service. 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.
cassandra_group
group_name
Group name for running service. See above.
cassandra.yaml options
These values override options set in the
cassandra_yaml_template
.cassandra_commitlog_dir
directory
cassandra_data_dir
directory
cassandra_hints_dir
directory
cassandra_saved_caches_dir
directory
enable_vnodes
0 (no) or 1 (yes)
Enable or disable virtual nodes (vnodes). Default: 1 for transactional nodes, 0 for others.
interface
IP_address
Default interface to use for listening on all services.
listen_address
IP_address
num_tokens
number_of_tokens
ring_name
name
Name of ring.
rpc_address
IP_address
rpc_port
port_number
seeds
Comma separated list of seed IP_addresses
Seed list for this node. Do not make all nodes seed nodes. See Internode communications (gossip).
ssl_storage_port
port_number
storage_port
port_number
-
Results
DataStax Enterprise is ready for additional configuration.
Next steps
-
You must change or delete the
cassandra
user created on installation. See Creating superuser accounts. -
Configure startup options: service | stand-alone.
-
If performing an upgrade, go to the next step in the Upgrade Guide.
-
Configuring DataStax Enterprise- Settings for DSE Advanced Security, In-Memory, DSE Advanced Replication, DSE Multi-Instance, DSE Tiered Storage, and more.
-
Configuration and log file locations - Services and package installations.
-
Configuration and log file locations - No Services and tarball installations.
-
Changing logging locations after installation.
-
Planning and testing DSE and Apache Cassandra™ cluster deployments.
-
Configuring the heap dump directory to avoid server crashes.
-
DataStax Studio documentation.