Skip to content

Latest commit

 

History

History
2737 lines (1099 loc) · 61.5 KB

configuration_options.md

File metadata and controls

2737 lines (1099 loc) · 61.5 KB

scylla-cluster-tests configuration options

config_files / SCT_CONFIG_FILES

a list of config files that would be used

default: N/A

cluster_backend / SCT_CLUSTER_BACKEND

backend that will be used, aws/gce/docker

default: N/A

test_method / SCT_TEST_METHOD

class.method used to run the test. Filled automatically with run-test sct command.

default: N/A

test_duration / SCT_TEST_DURATION

Test duration (min). Parameter used to keep instances produced by tests
and for jenkins pipeline timeout and TimoutThread.

default: 60

prepare_stress_duration / SCT_PREPARE_STRESS_DURATION

Time in minutes, which is required to run prepare stress commands
defined in prepare_*_cmd for dataset generation, and is used in
test duration calculation

default: 300

stress_duration / SCT_STRESS_DURATION

Time in minutes, Time of execution for stress commands from stress_cmd parameters
and is used in test duration calculation

default: N/A

n_db_nodes / SCT_N_DB_NODES

Number list of database data nodes in multiple data centers. To use with
multi data centers and zero nodes, dc with zero-nodes only should be set as 0,
ex. "3 3 0".

default: N/A

n_test_oracle_db_nodes / SCT_N_TEST_ORACLE_DB_NODES

Number list of oracle test nodes in multiple data centers.

default: 1

n_loaders / SCT_N_LOADERS

Number list of loader nodes in multiple data centers

default: N/A

n_monitor_nodes / SCT_N_MONITORS_NODES

Number list of monitor nodes in multiple data centers

default: N/A

intra_node_comm_public / SCT_INTRA_NODE_COMM_PUBLIC

If True, all communication between nodes are via public addresses

default: N/A

endpoint_snitch / SCT_ENDPOINT_SNITCH

The snitch class scylla would use

'GossipingPropertyFileSnitch' - default
'Ec2MultiRegionSnitch' - default on aws backend
'GoogleCloudSnitch'

default: N/A

user_credentials_path / SCT_USER_CREDENTIALS_PATH

Path to your user credentials. qa key are downloaded automatically from S3 bucket

default: N/A

cloud_credentials_path / SCT_CLOUD_CREDENTIALS_PATH

Path to your user credentials. qa key are downloaded automatically from S3 bucket

default: N/A

cloud_cluster_id / SCT_CLOUD_CLUSTER_ID

scylla cloud cluster id

default: N/A

cloud_prom_bearer_token / SCT_CLOUD_PROM_BEARER_TOKEN

scylla cloud promproxy bearer_token to federate monitoring data into our monitoring instance

default: N/A

cloud_prom_path / SCT_CLOUD_PROM_PATH

scylla cloud promproxy path to federate monitoring data into our monitoring instance

default: N/A

cloud_prom_host / SCT_CLOUD_PROM_HOST

scylla cloud promproxy hostname to federate monitoring data into our monitoring instance

default: N/A

ip_ssh_connections / SCT_IP_SSH_CONNECTIONS

Type of IP used to connect to machine instances.
This depends on whether you are running your tests from a machine inside
your cloud provider, where it makes sense to use 'private', or outside (use 'public')

Default: Use public IPs to connect to instances (public)
Use private IPs to connect to instances (private)
Use IPv6 IPs to connect to instances (ipv6)

default: private

scylla_repo / SCT_SCYLLA_REPO

Url to the repo of scylla version to install scylla. Can provide specific version after a colon e.g: https://s3.amazonaws.com/downloads.scylladb.com/deb/ubuntu/scylla-2021.1.list:2021.1.18

default: N/A

scylla_apt_keys / SCT_SCYLLA_APT_KEYS

APT keys for ScyllaDB repos

default: ['17723034C56D4B19', '5E08FBD8B5D6EC9C', 'D0A112E067426AB2', '491C93B9DE7496A7', 'A43E06657BAC99E3']

unified_package / SCT_UNIFIED_PACKAGE

Url to the unified package of scylla version to install scylla

default: N/A

nonroot_offline_install / SCT_NONROOT_OFFLINE_INSTALL

Install Scylla without required root priviledge

default: N/A

install_mode / SCT_INSTALL_MODE

Scylla install mode, repo/offline/web

default: repo

scylla_version / SCT_SCYLLA_VERSION

Version of scylla to install, ex. '2.3.1'
Automatically lookup AMIs and repo links for formal versions.
WARNING: can't be used together with 'scylla_repo' or 'ami_id_db_scylla'

default: N/A

user_data_format_version / SCT_USER_DATA_FORMAT_VERSION

Format version of the user-data to use for scylla images,
default to what tagged on the image used

default: N/A

oracle_user_data_format_version / SCT_ORACLE_USER_DATA_FORMAT_VERSION

Format version of the user-data to use for scylla images,
default to what tagged on the image used

default: N/A

oracle_scylla_version / SCT_ORACLE_SCYLLA_VERSION

Version of scylla to use as oracle cluster with gemini tests, ex. '3.0.11'
Automatically lookup AMIs for formal versions.
WARNING: can't be used together with 'ami_id_db_oracle'

default: 2022.1.14

scylla_linux_distro / SCT_SCYLLA_LINUX_DISTRO

The distro name and family name to use. Example: 'ubuntu-jammy' or 'debian-bookworm'.

default: ubuntu-focal

scylla_linux_distro_loader / SCT_SCYLLA_LINUX_DISTRO_LOADER

The distro name and family name to use. Example: 'ubuntu-jammy' or 'debian-bookworm'.

default: ubuntu-jammy

assert_linux_distro_features / SCT_ASSERT_LINUX_DISTRO_FEATURES

List of distro features relevant to SCT test. Example: 'fips'.

default: N/A

scylla_repo_m / SCT_SCYLLA_REPO_M

Url to the repo of scylla version to install scylla from for managment tests

default: N/A

scylla_repo_loader / SCT_SCYLLA_REPO_LOADER

Url to the repo of scylla version to install c-s for loader

default: https://s3.amazonaws.com/downloads.scylladb.com/deb/ubuntu/scylla-5.2.list

scylla_mgmt_address / SCT_SCYLLA_MGMT_ADDRESS

Url to the repo of scylla manager version to install for management tests

default: N/A

scylla_mgmt_agent_address / SCT_SCYLLA_MGMT_AGENT_ADDRESS

Url to the repo of scylla manager agent version to install for management tests

default: N/A

manager_version / SCT_MANAGER_VERSION

Branch of scylla manager server and agent to install. Options in defaults/manager_versions.yaml

default: 3.4

target_manager_version / SCT_TARGET_MANAGER_VERSION

Branch of scylla manager server and agent to upgrade to. Options in defaults/manager_versions.yaml

default: N/A

manager_scylla_backend_version / SCT_MANAGER_SCYLLA_BACKEND_VERSION

Branch of scylla db enterprise to install. Options in defaults/manager_versions.yaml

default: 2024

scylla_mgmt_agent_version / SCT_SCYLLA_MGMT_AGENT_VERSION

default: 3.4.0

scylla_mgmt_pkg / SCT_SCYLLA_MGMT_PKG

Url to the scylla manager packages to install for management tests

default: N/A

stress_cmd_lwt_i / SCT_STRESS_CMD_LWT_I

Stress command for LWT performance test for INSERT baseline

default: N/A

stress_cmd_lwt_d / SCT_STRESS_CMD_LWT_D

Stress command for LWT performance test for DELETE baseline

default: N/A

stress_cmd_lwt_u / SCT_STRESS_CMD_LWT_U

Stress command for LWT performance test for UPDATE baseline

default: N/A

stress_cmd_lwt_ine / SCT_STRESS_CMD_LWT_INE

Stress command for LWT performance test for INSERT with IF NOT EXISTS

default: N/A

stress_cmd_lwt_uc / SCT_STRESS_CMD_LWT_UC

Stress command for LWT performance test for UPDATE with IF

default: N/A

stress_cmd_lwt_ue / SCT_STRESS_CMD_LWT_UE

Stress command for LWT performance test for UPDATE with IF EXISTS

default: N/A

stress_cmd_lwt_de / SCT_STRESS_CMD_LWT_DE

Stress command for LWT performance test for DELETE with IF EXISTS

default: N/A

stress_cmd_lwt_dc / SCT_STRESS_CMD_LWT_DC

Stress command for LWT performance test for DELETE with IF condition>

default: N/A

stress_cmd_lwt_mixed / SCT_STRESS_CMD_LWT_MIXED

Stress command for LWT performance test for mixed lwt load

default: N/A

stress_cmd_lwt_mixed_baseline / SCT_STRESS_CMD_LWT_MIXED_BASELINE

Stress command for LWT performance test for mixed lwt load baseline

default: N/A

use_cloud_manager / SCT_USE_CLOUD_MANAGER

When define true, will install scylla cloud manager

default: N/A

use_ldap / SCT_USE_LDAP

When defined true, LDAP is going to be used.

default: N/A

use_ldap_authorization / SCT_USE_LDAP_AUTHORIZATION

When defined true, will create a docker container with LDAP and configure scylla.yaml to use it

default: N/A

use_ldap_authentication / SCT_USE_LDAP_AUTHENTICATION

When defined true, will create a docker container with LDAP and configure scylla.yaml to use it

default: N/A

prepare_saslauthd / SCT_PREPARE_SASLAUTHD

When defined true, will install and start saslauthd service

default: N/A

ldap_server_type / SCT_LDAP_SERVER_TYPE

This option indicates which server is going to be used for LDAP operations. [openldap, ms_ad]

default: N/A

use_mgmt / SCT_USE_MGMT

When define true, will install scylla management

default: True

parallel_node_operations / SCT_PARALLEL_NODE_OPERATIONS

When defined true, will run node operations in parallel. Supported operations: startup

default: N/A

manager_prometheus_port / SCT_MANAGER_PROMETHEUS_PORT

Port to be used by the manager to contact Prometheus

default: 5090

target_scylla_mgmt_server_address / SCT_TARGET_SCYLLA_MGMT_SERVER_ADDRESS

Url to the repo of scylla manager version used to upgrade the manager server

default: N/A

target_scylla_mgmt_agent_address / SCT_TARGET_SCYLLA_MGMT_AGENT_ADDRESS

Url to the repo of scylla manager version used to upgrade the manager agents

default: N/A

update_db_packages / SCT_UPDATE_DB_PACKAGES

A local directory of rpms to install a custom version on top of
the scylla installed (or from repo or from ami)

default: N/A

monitor_branch / SCT_MONITOR_BRANCH

The port of scylla management

default: branch-4.8

db_type / SCT_DB_TYPE

Db type to install into db nodes, scylla/cassandra

default: scylla

user_prefix / SCT_USER_PREFIX

the prefix of the name of the cloud instances, defaults to username

default: N/A

ami_id_db_scylla_desc / SCT_AMI_ID_DB_SCYLLA_DESC

version name to report stats to Elasticsearch and tagged on cloud instances

default: N/A

sct_public_ip / SCT_SCT_PUBLIC_IP

Override the default hostname address of the sct test runner,
for the monitoring of the Nemesis.
can only work out of the box in AWS

default: N/A

sct_ngrok_name / SCT_NGROK_NAME

Override the default hostname address of the sct test runner,
using ngrok server, see readme for more instructions

default: N/A

backtrace_decoding / SCT_BACKTRACE_DECODING

If True, all backtraces found in db nodes would be decoded automatically

default: True

print_kernel_callstack / SCT_PRINT_KERNEL_CALLSTACK

Scylla will print kernel callstack to logs if True, otherwise, it will try and may print a message
that it failed to.

default: True

instance_provision / SCT_INSTANCE_PROVISION

instance_provision: spot|on_demand|spot_fleet

default: spot

instance_provision_fallback_on_demand / SCT_INSTANCE_PROVISION_FALLBACK_ON_DEMAND

instance_provision_fallback_on_demand: create instance on_demand provision type if instance with selected 'instance_provision' type creation failed. Expected values: true|false (default - false

default: N/A

reuse_cluster / SCT_REUSE_CLUSTER

If reuse_cluster is set it should hold test_id of the cluster that will be reused.
reuse_cluster: 7dc6db84-eb01-4b61-a946-b5c72e0f6d71

default: N/A

test_id / SCT_TEST_ID

test id to filter by

default: N/A

db_nodes_shards_selection / SCT_NODES_SHARDS_SELECTION

How to select number of shards of Scylla. Expected values: default/random.
Default value: 'default'.
In case of random option - Scylla will start with different (random) shards on every node of the cluster

default: default

seeds_selector / SCT_SEEDS_SELECTOR

How to select the seeds. Expected values: random/first/all

default: all

seeds_num / SCT_SEEDS_NUM

Number of seeds to select

default: 1

email_recipients / SCT_EMAIL_RECIPIENTS

list of email of send the performance regression test to

default: ['[email protected]']

email_subject_postfix / SCT_EMAIL_SUBJECT_POSTFIX

Email subject postfix

default: N/A

enable_test_profiling / SCT_ENABLE_TEST_PROFILING

Turn on sct profiling

default: N/A

ssh_transport / SSH_TRANSPORT

Set type of ssh library to use. Could be 'fabric' (default) or 'libssh2'

default: libssh2

experimental_features / SCT_EXPERIMENTAL_FEATURES

unlock specified experimental features

default: N/A

server_encrypt / SCT_SERVER_ENCRYPT

when enable scylla will use encryption on the server side

default: N/A

client_encrypt / SCT_CLIENT_ENCRYPT

when enable scylla will use encryption on the client side

default: N/A

client_encrypt_mtls / SCT_CLIENT_ENCRYPT_MTLS

when enabled scylla will enforce mutual authentication when client-to-node encryption is enabled

default: N/A

server_encrypt_mtls / SCT_SERVER_ENCRYPT_MTLS

when enabled scylla will enforce mutual authentication when node-to-node encryption is enabled

default: N/A

hinted_handoff / SCT_HINTED_HANDOFF

when enable or disable scylla hinted handoff (enabled/disabled)

default: disabled

authenticator / SCT_AUTHENTICATOR

which authenticator scylla will use AllowAllAuthenticator/PasswordAuthenticator

default: N/A

authenticator_user / SCT_AUTHENTICATOR_USER

the username if PasswordAuthenticator is used

default: N/A

authenticator_password / SCT_AUTHENTICATOR_PASSWORD

the password if PasswordAuthenticator is used

default: N/A

authorizer / SCT_AUTHORIZER

which authorizer scylla will use AllowAllAuthorizer/CassandraAuthorizer

default: N/A

sla / SCT_SLA

run SLA nemeses if the test is SLA only

default: N/A

service_level_shares / SCT_SERVICE_LEVEL_SHARES

List if service level shares - how many server levels to create and test. Uses in SLA test.list of int, like: [100, 200]

default: [1000]

alternator_port / SCT_ALTERNATOR_PORT

Port to configure for alternator in scylla.yaml

default: N/A

dynamodb_primarykey_type / SCT_DYNAMODB_PRIMARYKEY_TYPE

Type of dynamodb table to create with range key or not, can be:
HASH,HASH_AND_RANGE

default: HASH

alternator_write_isolation / SCT_ALTERNATOR_WRITE_ISOLATION

Set the write isolation for the alternator table, see https://github.com/scylladb/scylla/blob/master/docs/alternator/alternator.md#write-isolation-policies for more details

default: N/A

alternator_use_dns_routing / SCT_ALTERNATOR_USE_DNS_ROUTING

If true, spawn a docker with a dns server for the ycsb loader to point to

default: N/A

alternator_enforce_authorization / SCT_ALTERNATOR_ENFORCE_AUTHORIZATION

If true, enable the authorization check in dynamodb api (alternator)

default: N/A

alternator_access_key_id / SCT_ALTERNATOR_ACCESS_KEY_ID

the aws_access_key_id that would be used for alternator

default: N/A

alternator_secret_access_key / SCT_ALTERNATOR_SECRET_ACCESS_KEY

the aws_secret_access_key that would be used for alternator

default: N/A

region_aware_loader / SCT_REGION_AWARE_LOADER

When in multi region mode, run stress on loader that is located in the same region as db node

default: N/A

append_scylla_args / SCT_APPEND_SCYLLA_ARGS

More arguments to append to scylla command line

default: --blocked-reactor-notify-ms 25 --abort-on-lsa-bad-alloc 1 --abort-on-seastar-bad-alloc --abort-on-internal-error 1 --abort-on-ebadf 1 --enable-sstable-key-validation 1

append_scylla_args_oracle / SCT_APPEND_SCYLLA_ARGS_ORACLE

More arguments to append to oracle command line

default: --enable-cache false

append_scylla_yaml / SCT_APPEND_SCYLLA_YAML

More configuration to append to /etc/scylla/scylla.yaml

default: N/A

append_scylla_node_exporter_args / SCT_SCYLLA_NODE_EXPORTER_ARGS

More arguments to append to scylla-node-exporter command line

default: N/A

nemesis_class_name / SCT_NEMESIS_CLASS_NAME

Nemesis class to use (possible types in sdcm.nemesis).
Next syntax supporting:
- nemesis_class_name: "NemesisName" Run one nemesis in single thread
- nemesis_class_name: ":" Run in
parallel threads on different nodes. Ex.: "ChaosMonkey:2"
- nemesis_class_name: ": :" Run
in parallel threads and in
parallel threads. Ex.: "DisruptiveMonkey:1 NonDisruptiveMonkey:2"

default: NoOpMonkey

nemesis_interval / SCT_NEMESIS_INTERVAL

Nemesis sleep interval to use if None provided specifically in the test

default: 5

nemesis_sequence_sleep_between_ops / SCT_NEMESIS_SEQUENCE_SLEEP_BETWEEN_OPS

Sleep interval between nemesis operations for use in unique_sequence nemesis kind of tests

default: N/A

nemesis_during_prepare / SCT_NEMESIS_DURING_PREPARE

Run nemesis during prepare stage of the test

default: True

nemesis_seed / SCT_NEMESIS_SEED

A seed number in order to repeat nemesis sequence as part of SisyphusMonkey

default: N/A

nemesis_add_node_cnt / SCT_NEMESIS_ADD_NODE_CNT

Add/remove nodes during GrowShrinkCluster nemesis

default: 1

nemesis_grow_shrink_instance_type / SCT_NEMESIS_GROW_SHRINK_INSTANCE_TYPE

Instance type to use for adding/removing nodes during GrowShrinkCluster nemesis

default: N/A

cluster_target_size / SCT_CLUSTER_TARGET_SIZE

Used for scale test: max size of the cluster

default: N/A

space_node_threshold / SCT_SPACE_NODE_THRESHOLD

Space node threshold before starting nemesis (bytes)
The default value is 6GB (6x1024^3 bytes)
This value is supposed to reproduce
scylladb/scylladb#1140

default: N/A

nemesis_filter_seeds / SCT_NEMESIS_FILTER_SEEDS

If true runs the nemesis only on non seed nodes

default: N/A

stress_cmd / SCT_STRESS_CMD

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

gemini_schema_url / SCT_GEMINI_SCHEMA_URL

Url of the schema/configuration the gemini tool would use

default: N/A

gemini_cmd / SCT_GEMINI_CMD

gemini command to run (for now used only in GeminiTest)

default: N/A

gemini_seed / SCT_GEMINI_SEED

Seed number for gemini command

default: N/A

gemini_table_options / SCT_GEMINI_TABLE_OPTIONS

table options for created table. example:
["cdc={'enabled': true}"]
["cdc={'enabled': true}", "compaction={'class': 'IncrementalCompactionStrategy'}"]

default: N/A

instance_type_loader / SCT_INSTANCE_TYPE_LOADER

AWS image type of the loader node

default: N/A

instance_type_monitor / SCT_INSTANCE_TYPE_MONITOR

AWS image type of the monitor node

default: N/A

instance_type_db / SCT_INSTANCE_TYPE_DB

AWS image type of the db node

default: N/A

instance_type_db_oracle / SCT_INSTANCE_TYPE_DB_ORACLE

AWS image type of the oracle node

default: N/A

instance_type_runner / SCT_INSTANCE_TYPE_RUNNER

instance type of the sct-runner node

default: N/A

region_name / SCT_REGION_NAME

AWS regions to use

default: N/A

security_group_ids / SCT_SECURITY_GROUP_IDS

AWS security groups ids to use

default: N/A

use_placement_group / SCT_USE_PLACEMENT_GROUP

if true, create 'cluster' placement group for test case for low-latency network performance achievement

default: N/A

subnet_id / SCT_SUBNET_ID

AWS subnet ids to use

default: N/A

ami_id_db_scylla / SCT_AMI_ID_DB_SCYLLA

AMS AMI id to use for scylla db node

default: N/A

ami_id_loader / SCT_AMI_ID_LOADER

AMS AMI id to use for loader node

default: N/A

ami_id_monitor / SCT_AMI_ID_MONITOR

AMS AMI id to use for monitor node

default: N/A

ami_id_db_cassandra / SCT_AMI_ID_DB_CASSANDRA

AMS AMI id to use for cassandra node

default: N/A

ami_id_db_oracle / SCT_AMI_ID_DB_ORACLE

AMS AMI id to use for oracle node

default: N/A

root_disk_size_db / SCT_ROOT_DISK_SIZE_DB

default: N/A

root_disk_size_monitor / SCT_ROOT_DISK_SIZE_MONITOR

default: N/A

root_disk_size_loader / SCT_ROOT_DISK_SIZE_LOADER

default: N/A

root_disk_size_runner / SCT_ROOT_DISK_SIZE_RUNNER

root disk size in Gb for sct-runner

default: N/A

ami_db_scylla_user / SCT_AMI_DB_SCYLLA_USER

default: N/A

ami_monitor_user / SCT_AMI_MONITOR_USER

default: N/A

ami_loader_user / SCT_AMI_LOADER_USER

default: N/A

ami_db_cassandra_user / SCT_AMI_DB_CASSANDRA_USER

default: N/A

spot_max_price / SCT_SPOT_MAX_PRICE

The max percentage of the on demand price we set for spot/fleet instances

default: N/A

extra_network_interface / SCT_EXTRA_NETWORK_INTERFACE

if true, create extra network interface on each node

default: N/A

aws_instance_profile_name_db / SCT_AWS_INSTANCE_PROFILE_NAME_DB

This is the name of the instance profile to set on all db instances

default: N/A

aws_instance_profile_name_loader / SCT_AWS_INSTANCE_PROFILE_NAME_LOADER

This is the name of the instance profile to set on all loader instances

default: N/A

backup_bucket_backend / SCT_BACKUP_BUCKET_BACKEND

the backend to be used for backup (e.g., 's3', 'gcs' or 'azure')

default: N/A

backup_bucket_location / SCT_BACKUP_BUCKET_LOCATION

the bucket name to be used for backup (e.g., 'manager-backup-tests')

default: N/A

backup_bucket_region / SCT_BACKUP_BUCKET_REGION

the AWS region of a bucket to be used for backup (e.g., 'eu-west-1')

default: N/A

use_prepared_loaders / SCT_USE_PREPARED_LOADERS

If True, we use prepared VMs for loader (instead of using docker images)

default: N/A

scylla_d_overrides_files / SCT_scylla_d_overrides_files

list of files that should upload to /etc/scylla.d/ directory to override scylla config files

default: N/A

gce_project / SCT_GCE_PROJECT

gcp project name to use

default: N/A

gce_datacenter / SCT_GCE_DATACENTER

Supported: us-east1 - means that the zone will be selected automatically or you can mention the zone explicitly, for example: us-east1-b

default: N/A

gce_network / SCT_GCE_NETWORK

default: N/A

gce_image_db / SCT_GCE_IMAGE_DB

default: N/A

gce_image_monitor / SCT_GCE_IMAGE_MONITOR

default: N/A

gce_image_loader / SCT_GCE_IMAGE_LOADER

default: N/A

gce_image_username / SCT_GCE_IMAGE_USERNAME

default: N/A

gce_instance_type_loader / SCT_GCE_INSTANCE_TYPE_LOADER

default: N/A

gce_root_disk_type_loader / SCT_GCE_ROOT_DISK_TYPE_LOADER

default: N/A

gce_n_local_ssd_disk_loader / SCT_GCE_N_LOCAL_SSD_DISK_LOADER

default: N/A

gce_instance_type_monitor / SCT_GCE_INSTANCE_TYPE_MONITOR

default: N/A

gce_root_disk_type_monitor / SCT_GCE_ROOT_DISK_TYPE_MONITOR

default: N/A

gce_n_local_ssd_disk_monitor / SCT_GCE_N_LOCAL_SSD_DISK_MONITOR

default: N/A

gce_instance_type_db / SCT_GCE_INSTANCE_TYPE_DB

default: N/A

gce_root_disk_type_db / SCT_GCE_ROOT_DISK_TYPE_DB

default: N/A

gce_n_local_ssd_disk_db / SCT_GCE_N_LOCAL_SSD_DISK_DB

default: N/A

gce_pd_standard_disk_size_db / SCT_GCE_PD_STANDARD_DISK_SIZE_DB

default: N/A

gce_pd_ssd_disk_size_db / SCT_GCE_PD_SSD_DISK_SIZE_DB

default: N/A

gce_setup_hybrid_raid / SCT_GCE_SETUP_HYBRID_RAID

If True, SCT configures a hybrid RAID of NVMEs and an SSD for scylla's data

default: N/A

gce_pd_ssd_disk_size_loader / SCT_GCE_PD_SSD_DISK_SIZE_LOADER

default: N/A

gce_pd_ssd_disk_size_monitor / SCT_GCE_SSD_DISK_SIZE_MONITOR

default: N/A

azure_region_name / SCT_AZURE_REGION_NAME

Supported: eastus

default: N/A

azure_instance_type_loader / SCT_AZURE_INSTANCE_TYPE_LOADER

default: N/A

azure_instance_type_monitor / SCT_AZURE_INSTANCE_TYPE_MONITOR

default: N/A

azure_instance_type_db / SCT_AZURE_INSTANCE_TYPE_DB

default: N/A

azure_instance_type_db_oracle / SCT_AZURE_INSTANCE_TYPE_DB_ORACLE

default: N/A

azure_image_db / SCT_AZURE_IMAGE_DB

default: N/A

azure_image_monitor / SCT_AZURE_IMAGE_MONITOR

default: N/A

azure_image_loader / SCT_AZURE_IMAGE_LOADER

default: N/A

azure_image_username / SCT_AZURE_IMAGE_USERNAME

default: N/A

eks_service_ipv4_cidr / SCT_EKS_SERVICE_IPV4_CIDR

default: N/A

eks_vpc_cni_version / SCT_EKS_VPC_CNI_VERSION

default: N/A

eks_role_arn / SCT_EKS_ROLE_ARN

default: N/A

eks_cluster_version / SCT_EKS_CLUSTER_VERSION

default: N/A

eks_nodegroup_role_arn / SCT_EKS_NODEGROUP_ROLE_ARN

default: N/A

gke_cluster_version / SCT_GKE_CLUSTER_VERSION

default: N/A

gke_k8s_release_channel / SCT_GKE_K8S_RELEASE_CHANNEL

K8S release channel name to be used. Expected values are: 'rapid', 'regular', 'stable' and '' (static / No channel).

default: N/A

k8s_scylla_utils_docker_image / SCT_K8S_SCYLLA_UTILS_DOCKER_IMAGE

Docker image to be used by Scylla operator to tune K8S nodes for performance. Used when k8s_enable_performance_tuning' is defined to 'True'. If not set then the default from operator will be used.

default: N/A

k8s_enable_performance_tuning / SCT_K8S_ENABLE_PERFORMANCE_TUNING

Define whether performance tuning must run or not.

default: N/A

k8s_deploy_monitoring / SCT_K8S_DEPLOY_MONITORING

default: N/A

k8s_local_volume_provisioner_type / SCT_K8S_LOCAL_VOLUME_PROVISIONER_TYPE

Defines the type of the K8S local volume provisioner to be deployed. It may be either 'static' or 'dynamic'. Details about 'dynamic': 'dynamic': https://github.com/scylladb/k8s-local-volume-provisioner; 'static': sdcm/k8s_configs/static-local-volume-provisioner.yaml

default: N/A

k8s_scylla_operator_docker_image / SCT_K8S_SCYLLA_OPERATOR_DOCKER_IMAGE

Docker image to be used for installation of scylla operator.

default: N/A

k8s_scylla_operator_upgrade_docker_image / SCT_K8S_SCYLLA_OPERATOR_UPGRADE_DOCKER_IMAGE

Docker image to be used for upgrade of scylla operator.

default: N/A

k8s_scylla_operator_helm_repo / SCT_K8S_SCYLLA_OPERATOR_HELM_REPO

Link to the Helm repository where to get 'scylla-operator' charts from.

default: N/A

k8s_scylla_operator_upgrade_helm_repo / SCT_K8S_SCYLLA_OPERATOR_UPGRADE_HELM_REPO

Link to the Helm repository where to get 'scylla-operator' charts for upgrade.

default: N/A

k8s_scylla_operator_chart_version / SCT_K8S_SCYLLA_OPERATOR_CHART_VERSION

Version of 'scylla-operator' Helm chart to use. If not set then latest one will be used.

default: N/A

k8s_scylla_operator_upgrade_chart_version / SCT_K8S_SCYLLA_OPERATOR_UPGRADE_CHART_VERSION

Version of 'scylla-operator' Helm chart to use for upgrade.

default: N/A

k8s_functional_test_dataset / SCT_K8S_FUNCTIONAL_TEST_DATASET

Defines whether dataset uses for pre-fill cluster in functional test. Defined in sdcm.utils.sstable.load_inventory. Expected values: BIG_SSTABLE_MULTI_COLUMNS_DATA, MULTI_COLUMNS_DATA

default: N/A

k8s_scylla_cpu_limit / SCT_K8S_SCYLLA_CPU_LIMIT

The CPU limit that will be set for each Scylla cluster deployed in K8S. If not set, then will be autocalculated. Example: '500m' or '2'

default: N/A

k8s_scylla_memory_limit / SCT_K8S_SCYLLA_MEMORY_LIMIT

The memory limit that will be set for each Scylla cluster deployed in K8S. If not set, then will be autocalculated. Example: '16384Mi'

default: N/A

k8s_scylla_cluster_name / SCT_K8S_SCYLLA_CLUSTER_NAME

default: N/A

k8s_n_scylla_pods_per_cluster / K8S_N_SCYLLA_PODS_PER_CLUSTER

Number of loader pods per loader cluster.

default: 3

k8s_scylla_disk_gi / SCT_K8S_SCYLLA_DISK_GI

default: N/A

k8s_scylla_disk_class / SCT_K8S_SCYLLA_DISK_CLASS

default: N/A

k8s_loader_cluster_name / SCT_K8S_LOADER_CLUSTER_NAME

default: N/A

k8s_n_loader_pods_per_cluster / SCT_K8S_N_LOADER_PODS_PER_CLUSTER

Number of loader pods per loader cluster.

default: N/A

k8s_loader_run_type / SCT_K8S_LOADER_RUN_TYPE

Defines how the loader pods must run. It may be either 'static' (default, run stress command on the constantly existing idle pod having reserved resources, perf-oriented) or 'dynamic' (run stress commad in a separate pod as main thread and get logs in a searate retryable API call not having resource reservations).

default: dynamic

k8s_instance_type_auxiliary / SCT_K8S_INSTANCE_TYPE_AUXILIARY

Instance type for the nodes of the K8S auxiliary/default node pool.

default: N/A

k8s_instance_type_monitor / SCT_K8S_INSTANCE_TYPE_MONITOR

Instance type for the nodes of the K8S monitoring node pool.

default: N/A

mini_k8s_version / SCT_MINI_K8S_VERSION

default: N/A

k8s_cert_manager_version / SCT_K8S_CERT_MANAGER_VERSION

default: N/A

k8s_minio_storage_size / SCT_K8S_MINIO_STORAGE_SIZE

default: 10Gi

k8s_log_api_calls / SCT_K8S_LOG_API_CALLS

Defines whether the K8S API server logging must be enabled and it's logs gathered. Be aware that it may be really huge set of data.

default: N/A

k8s_tenants_num / SCT_TENANTS_NUM

Number of Scylla clusters to create in the K8S cluster.

default: 1

k8s_enable_tls / SCT_K8S_ENABLE_TLS

Defines whether we enable the scylla operator TLS feature or not.

default: N/A

k8s_enable_sni / SCT_K8S_ENABLE_SNI

Defines whether we install SNI and use it or not (serverless feature).

default: N/A

k8s_enable_alternator / SCT_K8S_ENABLE_ALTERNATOR

Defines whether we enable the alternator feature using scylla-operator or not.

default: N/A

k8s_connection_bundle_file / SCT_K8S_CONNECTION_BUNDLE_FILE

Serverless configuration bundle file

default: N/A

k8s_db_node_service_type / SCT_K8S_DB_NODE_SERVICE_TYPE

Defines the type of the K8S 'Service' objects type used for ScyllaDB pods. Empty value means 'do not set and allow scylla-operator to choose'.

default: N/A

k8s_db_node_to_node_broadcast_ip_type / SCT_K8S_DB_NODE_TO_NODE_BROADCAST_IP_TYPE

Defines the source of the IP address to be used for the 'broadcast_address' config option in the 'scylla.yaml' files. Empty value means 'do not set and allow scylla-operator to choose'.

default: N/A

k8s_db_node_to_client_broadcast_ip_type / SCT_K8S_DB_NODE_TO_CLIENT_BROADCAST_IP_TYPE

Defines the source of the IP address to be used for the 'broadcast_rpc_address' config option in the 'scylla.yaml' files. Empty value means 'do not set and allow scylla-operator to choose'.

default: N/A

k8s_use_chaos_mesh / SCT_K8S_USE_CHAOS_MESH

enables chaos-mesh for k8s testing

default: N/A

k8s_n_auxiliary_nodes / SCT_K8S_N_AUXILIARY_NODES

Number of nodes in auxiliary pool

default: N/A

k8s_n_monitor_nodes / SCT_K8S_N_MONITOR_NODES

Number of nodes in monitoring pool that will be used for scylla-operator's deployed monitoring pods.

default: N/A

mgmt_docker_image / SCT_MGMT_DOCKER_IMAGE

Scylla manager docker image, i.e. 'scylladb/scylla-manager:2.2.1'

default: scylladb/scylla-manager:3.4.0

docker_image / SCT_DOCKER_IMAGE

Scylla docker image repo, i.e. 'scylladb/scylla', if omitted is calculated from scylla_version

default: N/A

docker_network / SCT_DOCKER_NETWORK

local docker network to use, if there's need to have db cluster connect to other services running in docker

default: N/A

s3_baremetal_config / SCT_S3_BAREMETAL_CONFIG

default: N/A

db_nodes_private_ip / SCT_DB_NODES_PRIVATE_IP

default: N/A

db_nodes_public_ip / SCT_DB_NODES_PUBLIC_IP

default: N/A

loaders_private_ip / SCT_LOADERS_PRIVATE_IP

default: N/A

loaders_public_ip / SCT_LOADERS_PUBLIC_IP

default: N/A

monitor_nodes_private_ip / SCT_MONITOR_NODES_PRIVATE_IP

default: N/A

monitor_nodes_public_ip / SCT_MONITOR_NODES_PUBLIC_IP

default: N/A

cassandra_stress_population_size / SCT_CASSANDRA_STRESS_POPULATION_SIZE

default: 1000000

cassandra_stress_threads / SCT_CASSANDRA_STRESS_THREADS

default: 1000

add_node_cnt / SCT_ADD_NODE_CNT

default: 1

stress_multiplier / SCT_STRESS_MULTIPLIER

Number of cassandra-stress processes

default: 1

stress_multiplier_w / SCT_STRESS_MULTIPLIER_W

Number of cassandra-stress processes for write workload

default: 1

stress_multiplier_r / SCT_STRESS_MULTIPLIER_R

Number of cassandra-stress processes for read workload

default: 1

stress_multiplier_m / SCT_STRESS_MULTIPLIER_M

Number of cassandra-stress processes for mixed workload

default: 1

run_fullscan / SCT_RUN_FULLSCAN

default: N/A

run_full_partition_scan / SCT_run_full_partition_scan

Runs a background thread that issues reversed-queries on a table random partition by an interval

default: N/A

run_tombstone_gc_verification / SCT_RUN_TOMBSTONE_GC_VERIFICATION

Runs a background thread that verifies Tombstones GC on a table by an interval

default: N/A

keyspace_num / SCT_KEYSPACE_NUM

default: 1

round_robin / SCT_ROUND_ROBIN

default: N/A

batch_size / SCT_BATCH_SIZE

default: 1

pre_create_schema / SCT_PRE_CREATE_SCHEMA

default: N/A

pre_create_keyspace / SCT_PRE_CREATE_KEYSPACE

Command to create keysapce to be pre-create before running workload

default: N/A

post_prepare_cql_cmds / SCT_POST_PREPARE_CQL_CMDS

CQL Commands to run after prepare stage finished (relevant only to longevity_test.py)

default: N/A

prepare_wait_no_compactions_timeout / SCT_PREPARE_WAIT_NO_COMPACTIONS_TIMEOUT

At the end of prepare stage, run major compaction and wait for this time (in minutes) for compaction to finish. (relevant only to longevity_test.py), Should be use only for when facing issue like compaction is affect the test or load

default: N/A

compaction_strategy / SCT_COMPACTION_STRATEGY

Choose a specific compaction strategy to pre-create schema with.

default: SizeTieredCompactionStrategy

sstable_size / SSTABLE_SIZE

Configure sstable size for the usage of pre-create-schema mode

default: N/A

cluster_health_check / SCT_CLUSTER_HEALTH_CHECK

When true, start cluster health checker for all nodes

default: True

data_validation / SCT_DATA_VALIDATION

A group of sub-parameters: validate_partitions, table_name, primary_key_column,
partition_range_with_data_validation, max_partitions_in_test_table.
1. validate_partitions - when true, validating the same number of rows-per-partition before/after a Nemesis.
2. table_name - table name to check for the validate_partitions check.
3. primary_key_column - primary key of the table to check for the validate_partitions check
4. partition_range_with_data_validation - Relevant for scylla-bench. A range (min - max) of PK values
for partitions to be validated by reads and not to be deleted during test. Example: 0-250.
5. max_partitions_in_test_table - Relevant for scylla-bench. Max partition keys (partition-count)
in the scylla_bench.test table.

default: N/A

stress_read_cmd / SCT_STRESS_READ_CMD

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

prepare_verify_cmd / SCT_PREPARE_VERIFY_CMD

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

user_profile_table_count / SCT_USER_PROFILE_TABLE_COUNT

number of tables to create for template user c-s

default: 1

scylla_mgmt_upgrade_to_repo / SCT_SCYLLA_MGMT_UPGRADE_TO_REPO

Url to the repo of scylla manager version to upgrade to for management tests

default: N/A

mgmt_restore_extra_params / SCT_MGMT_RESTORE_EXTRA_PARAMS

Manager restore operation extra parameters: batch-size, parallel, etc.For example, --batch-size 2 --parallel 1. Provided string appends the restore cmd

default: N/A

mgmt_agent_backup_config / SCT_MGMT_AGENT_BACKUP_CONFIG

Manager agent backup general configuration: checkers, transfers, low_level_retries. For example, {'checkers': 100, 'transfers': 2, 'low_level_retries': 20}

default: N/A

mgmt_reuse_backup_snapshot_name / SCT_MGMT_REUSE_BACKUP_SNAPSHOT_NAME

Name of backup snapshot to use in Manager restore benchmark test, for example, 500gb_2t_ics. The name provides the info about dataset size (500gb), tables number (2) and compaction (ICS)

default: N/A

mgmt_skip_post_restore_stress_read / SCT_MGMT_SKIP_POST_RESTORE_STRESS_READ

Skip post-restore c-s verification read in the Manager restore benchmark tests

default: N/A

mgmt_nodetool_refresh_flags / SCT_MGMT_NODETOOL_REFRESH_FLAGS

Nodetool refresh extra options like --load-and-stream or --primary-replica-only

default: N/A

mgmt_prepare_snapshot_size / SCT_MGMT_PREPARE_SNAPSHOT_SIZE

Size of backup snapshot in Gb to be prepared to be prepared for backup

default: N/A

stress_cmd_w / SCT_STRESS_CMD_W

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_r / SCT_STRESS_CMD_R

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_m / SCT_STRESS_CMD_M

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_cache_warmup / SCT_STRESS_CMD_CACHE_WARM_UP

cassandra-stress commands for warm-up before read workload.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

prepare_write_cmd / SCT_PREPARE_WRITE_CMD

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_no_mv / SCT_STRESS_CMD_NO_MV

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_no_mv_profile / SCT_STRESS_CMD_NO_MV_PROFILE

default: N/A

perf_extra_jobs_to_compare / SCT_PERF_EXTRA_JOBS_TO_COMPARE

jobs to compare performance results with, for example if running in staging, we still can compare with official jobs

default: N/A

cs_user_profiles / SCT_CS_USER_PROFILES

cassandra-stress user-profiles list. Executed in test step

default: N/A

prepare_cs_user_profiles / SCT_PREPARE_CS_USER_PROFILES

cassandra-stress user-profiles list. Executed in prepare step

default: N/A

cs_duration / SCT_CS_DURATION

default: 50m

cs_debug / SCT_CS_DEBUG

enable debug for cassandra-stress

default: N/A

stress_cmd_mv / SCT_STRESS_CMD_MV

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

prepare_stress_cmd / SCT_PREPARE_STRESS_CMD

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

perf_gradual_threads / SCT_PERF_GRADUAL_THREADS

Threads amount of c-s load for gradual performance test per sub-test. Example: {'read': 100, 'write': 200, 'mixed': 300}

default: N/A

perf_gradual_throttle_steps / SCT_PERF_GRADUAL_THROTTLE_STEPS

Used for gradual performance test. Define throttle for load step in ops. Example: {'read': ['100000', '150000'], 'mixed': ['300']}

default: N/A

skip_download / SCT_SKIP_DOWNLOAD

default: N/A

sstable_file / SCT_SSTABLE_FILE

default: N/A

sstable_url / SCT_SSTABLE_URL

default: N/A

sstable_md5 / SCT_SSTABLE_MD5

default: N/A

flush_times / SCT_FLUSH_TIMES

default: N/A

flush_period / SCT_FLUSH_PERIOD

default: N/A

new_scylla_repo / SCT_NEW_SCYLLA_REPO

default: N/A

new_version / SCT_NEW_VERSION

Assign new upgrade version, use it to upgrade to specific minor release. eg: 3.0.1

default: N/A

target_upgrade_version / SCT_TARGET_UPGRADE_VERSION

Assign target upgrade version, use for decide if the truncate entries test should be run. This test should be performed in case the target upgrade version >= 3.1

default: N/A

disable_raft / SCT_DISABLE_RAFT

As for now, raft will be enable by default in all [upgrade] tests, so this flag will allow usto still run [upgrade] test without raft enabled (or disabling raft), so we will have bettercoverage

default: True

enable_tablets_on_upgrade / SCT_ENABLE_TABLETS_ON_UPGRADE

By default, the tablets feature is disabled. With this parameter, created for the upgrade test,the tablets feature will only be enabled after the upgrade

default: N/A

upgrade_node_packages / SCT_UPGRADE_NODE_PACKAGES

default: N/A

upgrade_node_system / SCT_UPGRADE_NODE_SYSTEM

Upgrade system packages on nodes before upgrading Scylla. Enabled by default

default: True

test_sst3 / SCT_TEST_SST3

default: N/A

test_upgrade_from_installed_3_1_0 / SCT_TEST_UPGRADE_FROM_INSTALLED_3_1_0

Enable an option for installed 3.1.0 for work around a scylla issue if it's true

default: N/A

recover_system_tables / SCT_RECOVER_SYSTEM_TABLES

default: N/A

stress_cmd_1 / SCT_STRESS_CMD_1

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_complex_prepare / SCT_STRESS_CMD_COMPLEX_PREPARE

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

prepare_write_stress / SCT_PREPARE_WRITE_STRESS

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_read_10m / SCT_STRESS_CMD_READ_10M

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_read_cl_one / SCT_STRESS_CMD_READ_CL_ONE

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.

default: N/A

stress_cmd_read_60m / SCT_STRESS_CMD_READ_60M

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_complex_verify_read / SCT_STRESS_CMD_COMPLEX_VERIFY_READ

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_complex_verify_more / SCT_STRESS_CMD_COMPLEX_VERIFY_MORE

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

write_stress_during_entire_test / SCT_WRITE_STRESS_DURING_ENTIRE_TEST

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

verify_data_after_entire_test / SCT_VERIFY_DATA_AFTER_ENTIRE_TEST

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.

default: N/A

stress_cmd_read_cl_quorum / SCT_STRESS_CMD_READ_CL_QUORUM

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

verify_stress_after_cluster_upgrade / SCT_VERIFY_STRESS_AFTER_CLUSTER_UPGRADE

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

stress_cmd_complex_verify_delete / SCT_STRESS_CMD_COMPLEX_VERIFY_DELETE

cassandra-stress commands.
You can specify everything but the -node parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: N/A

scylla_encryption_options / SCT_SCYLLA_ENCRYPTION_OPTIONS

options will be used for enable encryption at-rest for tables

default: N/A

kms_key_rotation_interval / SCT_KMS_KEY_ROTATION_INTERVAL

The time interval in minutes which gets waited before the KMS key rotation happens. Applied when the AWS KMS service is configured to be used.

default: N/A

enterprise_disable_kms / SCT_ENTERPRISE_DISABLE_KMS

An escape hatch to disable KMS for enterprise run, when needed, we enable kms by default since if we use scylla 2023.1.3 and up

default: N/A

logs_transport / SCT_LOGS_TRANSPORT

How to transport logs: syslog-ng, ssh or docker

default: syslog-ng

collect_logs / SCT_COLLECT_LOGS

Collect logs from instances and sct runner

default: N/A

execute_post_behavior / SCT_EXECUTE_POST_BEHAVIOR

Run post behavior actions in sct teardown step

default: N/A

post_behavior_db_nodes / SCT_POST_BEHAVIOR_DB_NODES

Failure/post test behavior, i.e. what to do with the db cloud instances at the end of the test.

'destroy' - Destroy instances and credentials (default)
'keep' - Keep instances running and leave credentials alone
'keep-on-failure' - Keep instances if testrun failed

default: keep-on-failure

post_behavior_loader_nodes / SCT_POST_BEHAVIOR_LOADER_NODES

Failure/post test behavior, i.e. what to do with the loader cloud instances at the end of the test.

'destroy' - Destroy instances and credentials (default)
'keep' - Keep instances running and leave credentials alone
'keep-on-failure' - Keep instances if testrun failed

default: destroy

post_behavior_monitor_nodes / SCT_POST_BEHAVIOR_MONITOR_NODES

Failure/post test behavior, i.e. what to do with the monitor cloud instances at the end of the test.

'destroy' - Destroy instances and credentials (default)
'keep' - Keep instances running and leave credentials alone
'keep-on-failure' - Keep instances if testrun failed

default: keep-on-failure

post_behavior_k8s_cluster / SCT_POST_BEHAVIOR_K8S_CLUSTER

Failure/post test behavior, i.e. what to do with the k8s cluster at the end of the test.

'destroy' - Destroy k8s cluster and credentials (default)
'keep' - Keep k8s cluster running and leave credentials alone
'keep-on-failure' - Keep k8s cluster if testrun failed

default: keep-on-failure

internode_compression / SCT_INTERNODE_COMPRESSION

scylla option: internode_compression

default: N/A

internode_encryption / SCT_INTERNODE_ENCRYPTION

scylla sub option of server_encryption_options: internode_encryption

default: all

jmx_heap_memory / SCT_JMX_HEAP_MEMORY

The total size of the memory allocated to JMX. Values in MB, so for 1GB enter 1024(MB)

default: N/A

store_perf_results / SCT_STORE_PERF_RESULTS

A flag that indicates whether or not to gather the prometheus stats at the end of the run.
Intended to be used in performance testing

default: N/A

append_scylla_setup_args / SCT_APPEND_SCYLLA_SETUP_ARGS

More arguments to append to scylla_setup command line

default: N/A

use_preinstalled_scylla / SCT_USE_PREINSTALLED_SCYLLA

Don't install/update ScyllaDB on DB nodes

default: N/A

force_run_iotune / SCT_FORCE_RUN_IOTUNE

Force running iotune on the DB nodes, regdless if image has predefined values

default: N/A

stress_cdclog_reader_cmd / SCT_STRESS_CDCLOG_READER_CMD

cdc-stressor command to read cdc_log table.
You can specify everything but the -node , -keyspace, -table, parameter, which is going to
be provided by the test suite infrastructure.
multiple commands can passed as a list

default: cdc-stressor -stream-query-round-duration 30s

store_cdclog_reader_stats_in_es / SCT_STORE_CDCLOG_READER_STATS_IN_ES

Add cdclog reader stats to ES for future performance result calculating

default: N/A

stop_test_on_stress_failure / SCT_STOP_TEST_ON_STRESS_FAILURE

If set to True the test will be stopped immediately when stress command failed.
When set to False the test will continue to run even when there are errors in the
stress process

default: True

stress_cdc_log_reader_batching_enable / SCT_STRESS_CDC_LOG_READER_BATCHING_ENABLE

retrieving data from multiple streams in one poll

default: True

use_legacy_cluster_init / SCT_USE_LEGACY_CLUSTER_INIT

Use legacy cluster initialization with autobootsrap disabled and parallel node setup

default: N/A

availability_zone / SCT_AVAILABILITY_ZONE

Availability zone to use. Specify multiple (comma separated) to deploy resources to multi az (works on AWS).
"Same for multi-region scenario.

default: N/A

aws_fallback_to_next_availability_zone / SCT_AWS_FALLBACK_TO_NEXT_AVAILABILITY_ZONE

Try all availability zones one by one in order to maximize the chances of getting
the requested instance capacity.

default: N/A

num_nodes_to_rollback / SCT_NUM_NODES_TO_ROLLBACK

Number of nodes to upgrade and rollback in test_generic_cluster_upgrade

default: N/A

upgrade_sstables / SCT_UPGRADE_SSTABLES

Whether to upgrade sstables as part of upgrade_node or not

default: N/A

stress_before_upgrade / SCT_STRESS_BEFORE_UPGRADE

Stress command to be run before upgrade (preapre stage)

default: N/A

stress_during_entire_upgrade / SCT_STRESS_DURING_ENTIRE_UPGRADE

Stress command to be run during the upgrade - user should take care for suitable duration

default: N/A

stress_after_cluster_upgrade / SCT_STRESS_AFTER_CLUSTER_UPGRADE

Stress command to be run after full upgrade - usually used to read the dataset for verification

default: N/A

jepsen_scylla_repo / SCT_JEPSEN_SCYLLA_REPO

Link to the git repository with Jepsen Scylla tests

default: https://github.com/jepsen-io/scylla.git

jepsen_test_cmd / SCT_JEPSEN_TEST_CMD

Jepsen test command (e.g., 'test-all')

default: ['test-all -w cas-register --concurrency 10n', 'test-all -w counter --concurrency 10n', 'test-all -w cmap --concurrency 10n', 'test-all -w cset --concurrency 10n', 'test-all -w write-isolation --concurrency 10n', 'test-all -w list-append --concurrency 10n', 'test-all -w wr-register --concurrency 10n']

jepsen_test_count / SCT_JEPSEN_TEST_COUNT

possible number of reruns of single Jepsen test command

default: 1

jepsen_test_run_policy / SCT_JEPSEN_TEST_RUN_POLICY

Jepsen test run policy (i.e., what we want to consider as passed for a single test)

'most' - most test runs are passed
'any' - one pass is enough
'all' - all test runs should pass

default: all

max_events_severities / SCT_MAX_EVENTS_SEVERITIES

Limit severity level for event types

default: N/A

scylla_rsyslog_setup / SCT_SCYLLA_RSYSLOG_SETUP

Configure rsyslog on Scylla nodes to send logs to monitoring nodes

default: N/A

events_limit_in_email / SCT_EVENTS_LIMIT_IN_EMAIL

Limit number events in email reports

default: 10

data_volume_disk_num / SCT_DATA_VOLUME_DISK_NUM

Number of additional data volumes attached to instances
if data_volume_disk_num > 0, then data volumes (ebs on aws) will be
used for scylla data directory

default: N/A

data_volume_disk_type / SCT_DATA_VOLUME_DISK_TYPE

Type of addtitional volumes: gp2|gp3|io2|io3

default: N/A

data_volume_disk_size / SCT_DATA_VOLUME_DISK_SIZE

Size of additional volume in GB

default: N/A

data_volume_disk_iops / SCT_DATA_VOLUME_DISK_IOPS

Number of iops for ebs type io2|io3|gp3

default: N/A

data_volume_disk_throughput / SCT_DATA_VOLUME_DISK_THROUGHPUT

Throughput in MiB/sec for ebs type gp3. Min is 125. Max is 1000.

default: N/A

run_db_node_benchmarks / SCT_RUN_DB_NODE_BENCHMARKS

Flag for running db node benchmarks before the tests

default: N/A

nemesis_selector / SCT_NEMESIS_SELECTOR

nemesis_selector gets a list of "nemesis properties" and filters IN all the nemesis that has
ALL the properties in that list which are set to true (the intersection of all properties).
(In other words filters out all nemesis that doesn't ONE of these properties set to true)
IMPORTANT: If a property doesn't exist, ALL the nemesis will be included.

default: N/A

nemesis_exclude_disabled / SCT_NEMESIS_EXCLUDE_DISABLED

nemesis_exclude_disabled determines whether 'disabled' nemeses are filtered out from list
or are allowed to be used. This allows to easily disable too 'risky' or 'extreme' nemeses by default,
for all longevities. For example: it is unwanted to run the ToggleGcModeMonkey in standard longevities
that runs a stress with data validation.

default: True

nemesis_multiply_factor / SCT_NEMESIS_MULTIPLY_FACTOR

Multiply the list of nemesis to execute by the specified factor

default: 6

nemesis_double_load_during_grow_shrink_duration / SCT_NEMESIS_DOUBLE_LOAD_DURING_GROW_SHRINK_DURATION

After growing (and before shrink) in GrowShrinkCluster nemesis it will double the load for provided duration.

default: N/A

raid_level / SCT_RAID_LEVEL

Number of of raid level: 0 - RAID0, 5 - RAID5

default: N/A

bare_loaders / SCT_BARE_LOADERS

Don't install anything but node_exporter to the loaders during cluster setup

default: N/A

stress_image / SCT_STRESS_IMAGE

Dict of the images to use for the stress tools

default: N/A

scylla_network_config / SCT_SCYLLA_NETWORK_CONFIG

Configure Scylla networking with single or multiple NIC/IP combinations.
It must be defined for listen_address and rpc_address. For each address mandatory parameters are:
- address: listen_address/rpc_address/broadcast_rpc_address/broadcast_address/test_communication
- ip_type: ipv4 or ipv6
- public: false or true
- nic: number of NIC. 0, 1
Supported for AWS only meanwhile

default: N/A

enable_argus / SCT_ENABLE_ARGUS

Control reporting to argus

default: True

cs_populating_distribution / SCT_CS_POPULATING_DISTRIBUTION

set c-s parameter '-pop' with gauss/uniform distribution for
performance gradual throughtput grow tests

default: N/A

latte_schema_parameters / SCT_LATTE_SCHEMA_PARAMETERS

Optional. Allows to pass through custom rune script parameters to the 'latte schema' command.

default: N/A

num_loaders_step / SCT_NUM_LOADERS_STEP

Number of loaders which should be added per step

default: N/A

stress_threads_start_num / SCT_STRESS_THREADS_START_NUM

Number of threads for c-s command

default: N/A

num_threads_step / SCT_NUM_THREADS_STEP

Number of threads which should be added on per step

default: N/A

stress_step_duration / SCT_STRESS_STEP_DURATION

Duration of time for stress round

default: 15m

max_deviation / SCT_MAX_DEVIATION

Max relative difference between best and current throughput,
if current throughput larger then best on max_rel_diff, it become new best one

default: N/A

n_stress_process / SCT_N_STRESS_PROCESS

Number of stress processes per loader

default: N/A

stress_process_step / SCT_STRESS_PROCESS_STEP

add/remove num of process on each round

default: N/A

use_hdr_cs_histogram / SCT_USE_HDR_CS_HISTOGRAM

Enable hdr histogram logging for cs

default: N/A

stop_on_hw_perf_failure / SCT_STOP_ON_HW_PERF_FAILURE

Stop sct performance test if hardware performance test failed

Hardware performance tests runs on each node with sysbench and cassandra-fio tools.
Results stored in ES. HW perf tests run during cluster setups and not affect
SCT Performance tests. Results calculated as average among all results for certain
instance type or among all nodes during single run.
if results for a single node is not in margin 0.01 of
average result for all nodes, hw test considered as Failed.
If stop_on_hw_perf_failure is True, then sct performance test will be terminated
after hw perf tests detect node with hw results not in margin with average
If stop_on_hw_perf_failure is False, then sct performance test will be run
even after hw perf tests detect node with hw results not in margin with average

default: N/A

custom_es_index / SCT_CUSTOM_ES_INDEX

Use custom ES index for storing test results

default: N/A

simulated_regions / SCT_SIMULATED_REGIONS

Defines how many regions must be simulated on the Scylla config side. If set then
nodes will be provisioned only using the very first real region defined in the configuration.

default: N/A

simulated_racks / SCT_SIMULATED_RACKS

Forces GossipingPropertyFileSnitch (regardless endpoint_snitch) to simulate racks.
Provide number of racks to simulate.

default: N/A

use_dns_names / SCT_USE_DNS_NAMES

Use dns names instead of ip addresses for nodes in cluster

default: N/A

validate_large_collections / SCT_VALIDATE_LARGE_COLLECTIONS

Enable validation for large cells in system table and logs

default: N/A

run_commit_log_check_thread / SCT_RUN_COMMIT_LOG_CHECK_THREAD

Run commit log check thread if commitlog_use_hard_size_limit is True

default: True

teardown_validators / SCT_TEARDOWN_VALIDATORS

Configuration for additional validations executed after the test

default: {'scrub': {'enabled': False, 'timeout': 1200, 'keyspace': '', 'table': ''}, 'test_error_events': {'enabled': False, 'failing_events': [{'event_class': 'DatabaseLogEvent', 'event_type': 'RUNTIME_ERROR', 'regex': '.runtime_error.'}, {'event_class': 'CoreDumpEvent'}]}}

use_capacity_reservation / SCT_USE_CAPACITY_RESERVATION

reserves instances capacity for whole duration of the test run (AWS only).
Fallbacks to next availabilit zone if capacity is not available

default: N/A

bisect_start_date / SCT_BISECT_START_DATE

Scylla build date from which bisecting should start.
Setting this date enables bisection. Format: YYYY-MM-DD

default: N/A

bisect_end_date / SCT_BISECT_END_DATE

Scylla build date until which bisecting should run. Format: YYYY-MM-DD

default: N/A

kafka_backend / SCT_KAFKA_BACKEND

Enable validation for large cells in system table and logs

default: N/A

kafka_connectors / SCT_KAFKA_CONNECTORS

configuration for setup up kafka connectors

default: N/A

run_scylla_doctor / SCT_RUN_SCYLLA_DOCTOR

Run scylla-doctor in artifact tests

default: N/A

skip_test_stages / SCT_SKIP_TEST_STAGES

Skip selected stages of a test scenario

default: N/A

use_zero_nodes / SCT_USE_ZERO_NODES

If True, enable support in sct of zero nodes(configuration, nemesis)

default: N/A

n_db_zero_token_nodes / SCT_N_DB_ZERO_TOKEN_NODES

Number of zero token nodes in cluster. Value should be set as "0 1 1"
for multidc configuration in same manner as 'n_db_nodes' and should be equal
number of regions

default: N/A

zero_token_instance_type_db / SCT_ZERO_TOKEN_INSTANCE_TYPE_DB

Instance type for zero token node

default: i4i.large

sct_aws_account_id / SCT_AWS_ACCOUNT_ID

AWS account id on behalf of which the test is run

default: N/A