Getting started
Information about using the Administrator Guide, plus new and key features in DataStax Enterprise.
About this guide
Information for capacity planning, installation, configuration, migration, performance monitoring, security, backup, data recovery, key topics, and more.
New features
Features released in DataStax Enterprise 5.1.
Key features
A brief description of the DataStax Enterprise, its key features, and integrated tools.
Release notes
Required planning, components, changes and enhancements, known issues, and resolved issues for DataStax Enterprise 5.1.
DSE 5.1.1
Release notes for DataStax Enterprise 5.1.1.
DSE 5.1.0
Installing DSE
DataStax Enterprise can be installed in a number of ways, depending on the purpose of the installation, the type of operating system, and the available permissions.
Which install method should I use?
Guidance for choosing the best DataStax Enterprise installation method for your purposes.
DataStax Installers
DataStax provides several methods for installing DSE from the DataStax Installer.
Installing a cluster using Lifecycle Manager
Lifecycle Manager (LCM) allows you to easily provision, configure, and install DataStax Enterprise clusters.
Package installer using Yum
Instructions for installing DataStax Enterprise 5.1 using Yum repositories on RHEL-based systems. Root permissions are required.
Package installer using APT
Instructions for installing DataStax Enterprise 5.1 using APT repositories on Debian-based systems. Root permissions are required.
Binary tarball installer
Instructions for installing DataStax Enterprise 5.1 on any supported Linux-based platform.
Installing patch releases
DataStax provides GUI/Text installers, binary tarballs, and Debian and RHEL packages for installing previous patch releases of DataStax Enterprise 5.1.x.
Installing on cloud providers
Information for installing DataStax Enterprise on CenturyLink Cloud, Google Compute Engine, Microsoft Azure, and Amazon EC2.
Installing supporting software
Installing the JDK on supported platforms and installing Python 2.7 on older RHEL-based package installations.
Uninstalling DSE
Launch the uninstaller in the installation directory to uninstall DataStax Enterprise.
Default file locations
Default file locations when installing from DataStax Enterprise.
Configuration
Information about configuring DataStax Enterprise, such as recommended production setting, configuration files, snitch configuration, start-up parameters, heap dump settings, using virtual nodes, and more.
Recommended production settings
Recommended settings for Linux platforms on DataStax Enterprise.
YAML and configuration properties
Information on how to configure DataStax Enterprise using the cassandra.yaml, dse.yaml, cassandra-rackdc.properties, and cassandra-topology.properties files.
Configuring snitches for cloud providers
Information about the Ec2Snitch, Ec2MultiRegionSnitch, GoogleCloudSnitch and CloudstackSnitch.
Special start-up parameters
Special parameters to start DataStax Enterprise.
Choosing a compaction strategy
Information on how to select the best compaction strategy.
Using multiple network interfaces
Steps for configuring DataStax Enterprise for multiple network interfaces or when using different regions in cloud implementations.
Configuring gossip settings
Using the cassandra.yaml file to configure gossip.
Configuring the heap dump directory
Analyzing the heap dump file can help troubleshoot memory problems.
Configuring Virtual Nodes
Topics about setting up and enabling virtual nodes (vnodes).
Logging configuration
Topics about changing logging locations, setting logging levels, archiving logs, and CDC logging.
Initializing a cluster
Initializing a DataStax Enterprise cluster includes configuring, and choosing how the data is divided across the nodes in the cluster.
Initializing a single datacenter per workload type
Steps for configuring nodes in a mixed-workload cluster that has only one datacenter for each type of workload.
Initializing multiple datacenters per workload type
Steps for configuring nodes in a mixed-workload cluster that has more than one datacenter for each type of node.
Initializing single-token architecture datacenters
Steps for deploying when not using virtual nodes (vnodes).
Security
DataStax Enterprise includes advanced data protection for enterprise-grade databases including DSE Unified Authentication, role-based access control (authorization), encryption, and auditing.
Security checklists
Lists of security measures required for protecting a DataStax Enterprise database.
Securing the environment
To fully protect your data, ensure that your network is secure and temporary files are secure.
Configuring DSE Unified Authentication
Detailed steps to set up authentication and authorization in a DataStax Enterprise environment.
Connecting to authentication enabled clusters
Setting up local or DSE managed JMX user authentication.
Managing roles
Manage access to database objects using role-based access control (RBAC).
Authorizing access to database resources
Configure roles and assign permissions to manage access to database resources for authenticated users.
Auditing activity
Information about enabling and configuring data auditing in DataStax Enterprise.
Transparent data encryption
Configure transparent data encrypt (TDE) on different types of data at-rest.
Configuring SSL
Securing data inflight for DataStax Enterprise components.
Security FAQs
DataStax Enterprise security features frequently asked questions.
DSE advanced functionality
Information on using DSE Analytics, DSEFS, DSE Search, DSE Graph, DSE Advanced Replication, DSE In-Memory, DSE Multi-Instance, DSE Tiered Storage and DSE Performance services.
DSE Analytics
DataStax Enterprise 5.1 Analytics includes integration with Apache Spark.
DSE Search
DSE Search is a high performance real-time live indexing engine with powerful search capabilities tightly integrated with DataStax Enterprise.
DSE Graph
Documentation for developers and administrators on installing, configuring, and using the features and capabilities of DSE Graph.
DSE Management Services
DSE Management Services automatically handle administration and maintenance tasks and assist with overall database cluster management.
DSE Advanced Replication
Documentation for configuring and using configurable distributed data replication.
DSE In-Memory
DataStax Enterprise includes DSE In-Memory for storing data to and accessing data exclusively from memory.
DSE Multi-Instance
Documentation for running multiple DataStax Enterprise nodes on a single host machine.
DSE Tiered Storage
Documentation for automating smart data movement across different types of storage media.
Tools
Tools include dse commands, dsetool, cfs-stress tool, pre-flight check and yaml_diff tools, and the sstableloader.
nodetool
A list of the available commands for managing a cluster.
dse commands
The dse commands provide additional controls for starting and using DataStax Enterprise.
dsetool utility
The dsetool utility for DataStax Enterprise (DSE) performs operations, including creating system keys, encrypting sensitive configuration information, temporarily changing running parameters for the performance service, and listing node subranges of data in a keyspace.
dse client-tool
Reference information about the dse client-tool application connects an external client to a DataStax Enterprise node and performs common utility tasks.
Stress tools
Tools for stress testing DataStax Enterprise.
SSTable utilities
Tools for using, upgrading, and changing DataStax Enterprise SSTables.
Preflight check tool
The preflight check tool is a collection of tests that detects and optionally fixes configuration settings on DataStax Enterprise nodes.
cluster_check and yaml_diff tools
Using the cluster_check and yaml_diff tools to check the differences between cassandra.yaml or dse.yaml files.
Operations
DataStax Enterprise operation topics, such as node and datacenter operations, changing replication strategies, configuring compaction and compression, caching, and tuning Bloom filters.
Starting and stopping DSE
You can start and stop DataStax Enterprise as a service or stand-alone process.
Adding or removing nodes, datacenters, or clusters
Information on adding or removing nodes, datacenters, or clusters.
Backing up and restoring data
DataStax Enterprise backs up data by taking a snapshot of all on-disk data files (SSTable files) stored in the data directory.
Repairing nodes
Repairing nodes makes sure data in every replica is consistent with other replicas.
Monitoring a DSE cluster
Information about performance characteristics, thread pool, read/write latency, table statistics, compaction metrics, and endpoint metrics.
Tuning the database
Tuning Java resources, Bloom filters, and configuring memtable thresholds to improve write performance.
Data caching
Configuring caches for optimal performance.
Compacting and compressing
Information on configuring and testing compaction and compression in DataStax Enterprise.
Migrating data to DSE
Methods to migrate data to DataStax Enterprise solutions.
Collecting node health and indexing scores
Steps to configure node health options, and commands to retrieve health and indexing scores.
Clearing data from DSE
Remove all data from any type of installation.