Commvault Cassandra Setup SOP (Detailed Guide)
Prerequisites
Before starting, ensure:
- Root or sudo access to the Cassandra server.
- Commvault installation package (Unix.tar).
- CommServe hostname/IP.
- Authorization (AuthCode) if required.
- Cassandra service is healthy.
- Java is installed.
- Network connectivity between Cassandra server and CommServe.
Step 1: Switch to Root User
Login to the Cassandra server.
sudo su -Verify:
whoamiOutput should be
rootStep 2: Configure Hosts File
Edit hosts file.
vi /etc/hostsExample:
171.12.12.12 test.co.in test
Purpose
- Name resolution
- CommServe communication
- Gateway communication
Save
:wq!Step 3: Extract Installation Package
Move to installation directory.
cd /home/ubuntuExtract package.
tar -xvf Unix.tarGrant execute permissions.
chmod 777 UnixGo inside package.
cd UnixVerify contents.
llStep 4: Start Commvault Installation
Run installer.
./cvpkgaddThe text installer opens.
Step 5: Installation Wizard
Select
Install Packages on this machineClick
NextThen
Advanced SelectionNext.
Step 6: Select Packages
Choose
✔ File System Core
✔ File System
✔ Cassandra
Click Next.
These packages install
- Base Commvault software
- File System Agent
- Cassandra iDataAgent
Step 7: Evaluation Mode
Installer asks
Install for evaluation?Select
NoContinue.
Step 8: Installation Directory
Default
/opt/commvaultUsually no change required.
Click Next.
Step 9: Log Directory
Default
/var/log/commvault/Log_FilesRecommended to keep default.
Step 10: Network Backup Option
Installer asks
Configure network for backups?Select
NoStep 11: Unix Group
Default group
commvaultChoose
Nounless customer requires a different group.
Step 12: Client Name
Provide hostname.
Example
cassandraee1.company.comClick Next.
Display name can also be customized.
Step 13: Review Installation Summary
Review
- Packages
- Installation path
- Log path
Click Next.
Step 14: CommServe Information
Enter
CommServe HostnameExample
NDCPBKPPRX01Click Next.
Step 15: Authorization Code
If prompted
Enter
Authorization Codeprovided by the Commvault administrator.
Step 16: Finish Installation
Click
FinishStep 17: Verify Installation
Run
commvault statusVerify
- Version
- Instance
- CommServe
- Installed packages
- Client name
Step 18: Verify Cassandra Service
Check
systemctl status dse-native.serviceEnsure
Active (running)Step 19: Configure Priam
Move to
cd /etc/PriamList files
llOpen
vi cvPriam.propertiesConfigure properties.
Example
priam.cass.startscript=service dse-native start #edit service ex service cassandra start
priam.cass.stopscript=service dse-native stop #edit service ex service cassandra stop
priam.cass.process=dse
priam.commitlog.location=/var/lib/cassandra/commitlog
priam.data.location=/var/lib/cassandra/data
priam.cql.port=7200 #editport
priam.jmx.port=7199 #editport
priam.storage.port=7000 #editport
priam.ssl.storage.port=7002 #editport
priam.thrift.port=9160 #editportSave.
:wq!Step 20: Locate Cassandra Configuration
Find configuration.
find / -name cassandra.yaml 2>/dev/nullExample
/etc/dse/cassandra/cassandra.yamlNavigate
cd /etc/dse/cassandraStep 21: Enable Incremental Backups
Open
vi cassandra.yamlFind
incremental_backups:Default
falseChange
incremental_backups: trueSave
:wq!This is mandatory for incremental backups because Cassandra stores SSTables incrementally only when this option is enabled.
Step 22: Create Cassandra Client in Commvault
Open
CommCell Console
Home
New Client
Big Data Apps
CassandraProvide
| Field | Example |
|---|---|
| Client Name | cassandraee1 |
| Instance Name | CassandraEE |
| Gateway Node | cassandraee1 |
| Cassandra Config Path | /etc/dse/cassandra |
| CQL Host | cassandraee1.company.com |
| CQL Port | 9042 (or customer-specific) |
Step 23: Configure Authentication
Under Authentication Settings configure:
CQL Authentication
Provide
- Credential Name
- Username
- Password
JMX Authentication
Provide
- Credential Name
- Username
- Password
Keystore
Provide
- Credential Name
- Keystore path
- Password
Used when SSL is enabled.
Truststore
Provide
- Credential Name
- Truststore path
- Password
Step 24: Commit Log Backup (Optional)
Enable
Enable Commit Log BackupProvide
Archive Log Path
Example
/var/lib/cassandra/commitlogArchive Command
Example
cp %s /cv_archive/Cassandra/commitlog/Commit log backup allows point-in-time recovery.
Step 25: Configure Storage Policy
Navigate
Big Data Apps
Cassandra
Default
Properties
Storage DeviceSelect
Storage Policy.
Click
OKsubclint path discovery
select cluster
Step 26: Perform Backup
Right-click
Default
BackupChoose
Full Backupor
Incremental BackupMonitor the Job Controller until the job completes successfully.
Step 27: Restore Data
Navigate
Default
Browse and RestoreSelect the required backup.
Choose
- In-place restore
- Out-of-place restore
Submit the restore job.
Step 28: Post-Restore Validation
After restore, verify:
nodetool statussystemctl status dse-nativecqlshRun
DESCRIBE KEYSPACES;Check that:
- Cassandra service is running.
- All nodes are in the UN (Up/Normal) state.
- Keyspaces and tables are accessible.
- Read/write operations succeed.
- Commvault restore job completed without errors.
