Skip to content

Commit

Permalink
fix(configuration_options.md): update docs
Browse files Browse the repository at this point in the history
the docs are missing a few recent changes, and were re-created.
  • Loading branch information
fruch committed Jan 21, 2024
1 parent d5cf388 commit 842a859
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/configuration_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| **<a href="#user-content-scylla_version" name="scylla_version">scylla_version</a>** | Version of scylla to install, ex. '2.3.1'<br>Automatically lookup AMIs and repo links for formal versions.<br>WARNING: can't be used together with 'scylla_repo' or 'ami_id_db_scylla' | N/A | SCT_SCYLLA_VERSION
| **<a href="#user-content-user_data_format_version" name="user_data_format_version">user_data_format_version</a>** | Format version of the user-data to use for scylla images,<br>default to what tagged on the image used | N/A | SCT_USER_DATA_FORMAT_VERSION
| **<a href="#user-content-oracle_user_data_format_version" name="oracle_user_data_format_version">oracle_user_data_format_version</a>** | Format version of the user-data to use for scylla images,<br>default to what tagged on the image used | N/A | SCT_ORACLE_USER_DATA_FORMAT_VERSION
| **<a href="#user-content-oracle_scylla_version" name="oracle_scylla_version">oracle_scylla_version</a>** | Version of scylla to use as oracle cluster with gemini tests, ex. '3.0.11'<br>Automatically lookup AMIs for formal versions.<br>WARNING: can't be used together with 'ami_id_db_oracle' | 2021.1.15 | SCT_ORACLE_SCYLLA_VERSION
| **<a href="#user-content-oracle_scylla_version" name="oracle_scylla_version">oracle_scylla_version</a>** | Version of scylla to use as oracle cluster with gemini tests, ex. '3.0.11'<br>Automatically lookup AMIs for formal versions.<br>WARNING: can't be used together with 'ami_id_db_oracle' | 2021.1.23 | SCT_ORACLE_SCYLLA_VERSION
| **<a href="#user-content-scylla_linux_distro" name="scylla_linux_distro">scylla_linux_distro</a>** | The distro name and family name to use [centos/ubuntu-xenial/debian-jessie] | ubuntu-focal | SCT_SCYLLA_LINUX_DISTRO
| **<a href="#user-content-scylla_linux_distro_loader" name="scylla_linux_distro_loader">scylla_linux_distro_loader</a>** | The distro name and family name to use [centos/ubuntu-xenial/debian-jessie] | centos | SCT_SCYLLA_LINUX_DISTRO_LOADER
| **<a href="#user-content-scylla_repo_m" name="scylla_repo_m">scylla_repo_m</a>** | Url to the repo of scylla version to install scylla from for managment tests | N/A | SCT_SCYLLA_REPO_M
Expand All @@ -37,7 +37,7 @@
| **<a href="#user-content-manager_version" name="manager_version">manager_version</a>** | Branch of scylla manager server and agent to install. Options in defaults/manager_versions.yaml | 3.2 | SCT_MANAGER_VERSION
| **<a href="#user-content-target_manager_version" name="target_manager_version">target_manager_version</a>** | Branch of scylla manager server and agent to upgrade to. Options in defaults/manager_versions.yaml | N/A | SCT_TARGET_MANAGER_VERSION
| **<a href="#user-content-manager_scylla_backend_version" name="manager_scylla_backend_version">manager_scylla_backend_version</a>** | Branch of scylla db enterprise to install. Options in defaults/manager_versions.yaml | 2022 | SCT_MANAGER_SCYLLA_BACKEND_VERSION
| **<a href="#user-content-scylla_mgmt_agent_version" name="scylla_mgmt_agent_version">scylla_mgmt_agent_version</a>** | | N/A | SCT_SCYLLA_MGMT_AGENT_VERSION
| **<a href="#user-content-scylla_mgmt_agent_version" name="scylla_mgmt_agent_version">scylla_mgmt_agent_version</a>** | | 3.2.5 | SCT_SCYLLA_MGMT_AGENT_VERSION
| **<a href="#user-content-scylla_mgmt_pkg" name="scylla_mgmt_pkg">scylla_mgmt_pkg</a>** | Url to the scylla manager packages to install for management tests | N/A | SCT_SCYLLA_MGMT_PKG
| **<a href="#user-content-stress_cmd_lwt_i" name="stress_cmd_lwt_i">stress_cmd_lwt_i</a>** | Stress command for LWT performance test for INSERT baseline | N/A | SCT_STRESS_CMD_LWT_I
| **<a href="#user-content-stress_cmd_lwt_d" name="stress_cmd_lwt_d">stress_cmd_lwt_d</a>** | Stress command for LWT performance test for DELETE baseline | N/A | SCT_STRESS_CMD_LWT_D
Expand All @@ -60,7 +60,7 @@
| **<a href="#user-content-target_scylla_mgmt_server_address" name="target_scylla_mgmt_server_address">target_scylla_mgmt_server_address</a>** | Url to the repo of scylla manager version used to upgrade the manager server | N/A | SCT_TARGET_SCYLLA_MGMT_SERVER_ADDRESS
| **<a href="#user-content-target_scylla_mgmt_agent_address" name="target_scylla_mgmt_agent_address">target_scylla_mgmt_agent_address</a>** | Url to the repo of scylla manager version used to upgrade the manager agents | N/A | SCT_TARGET_SCYLLA_MGMT_AGENT_ADDRESS
| **<a href="#user-content-update_db_packages" name="update_db_packages">update_db_packages</a>** | A local directory of rpms to install a custom version on top of<br>the scylla installed (or from repo or from ami) | N/A | SCT_UPDATE_DB_PACKAGES
| **<a href="#user-content-monitor_branch" name="monitor_branch">monitor_branch</a>** | The port of scylla management | branch-4.5 | SCT_MONITOR_BRANCH
| **<a href="#user-content-monitor_branch" name="monitor_branch">monitor_branch</a>** | The port of scylla management | branch-4.6 | SCT_MONITOR_BRANCH
| **<a href="#user-content-db_type" name="db_type">db_type</a>** | Db type to install into db nodes, scylla/cassandra | scylla | SCT_DB_TYPE
| **<a href="#user-content-user_prefix" name="user_prefix">user_prefix</a>** | the prefix of the name of the cloud instances, defaults to username | N/A | SCT_USER_PREFIX
| **<a href="#user-content-ami_id_db_scylla_desc" name="ami_id_db_scylla_desc">ami_id_db_scylla_desc</a>** | version name to report stats to Elasticsearch and tagged on cloud instances | N/A | SCT_AMI_ID_DB_SCYLLA_DESC
Expand Down Expand Up @@ -218,7 +218,7 @@
| **<a href="#user-content-k8s_use_chaos_mesh" name="k8s_use_chaos_mesh">k8s_use_chaos_mesh</a>** | enables chaos-mesh for k8s testing | N/A | SCT_K8S_USE_CHAOS_MESH
| **<a href="#user-content-k8s_n_auxiliary_nodes" name="k8s_n_auxiliary_nodes">k8s_n_auxiliary_nodes</a>** | Number of nodes in auxiliary pool | N/A | SCT_K8S_N_AUXILIARY_NODES
| **<a href="#user-content-k8s_n_monitor_nodes" name="k8s_n_monitor_nodes">k8s_n_monitor_nodes</a>** | Number of nodes in monitoring pool that will be used for scylla-operator's deployed monitoring pods. | N/A | SCT_K8S_N_MONITOR_NODES
| **<a href="#user-content-mgmt_docker_image" name="mgmt_docker_image">mgmt_docker_image</a>** | Scylla manager docker image, i.e. 'scylladb/scylla-manager:2.2.1' | N/A | SCT_MGMT_DOCKER_IMAGE
| **<a href="#user-content-mgmt_docker_image" name="mgmt_docker_image">mgmt_docker_image</a>** | Scylla manager docker image, i.e. 'scylladb/scylla-manager:2.2.1' | scylladb/scylla-manager:3.2.5 | SCT_MGMT_DOCKER_IMAGE
| **<a href="#user-content-docker_image" name="docker_image">docker_image</a>** | Scylla docker image repo, i.e. 'scylladb/scylla', if omitted is calculated from scylla_version | N/A | SCT_DOCKER_IMAGE
| **<a href="#user-content-docker_network" name="docker_network">docker_network</a>** | local docker network to use, if there's need to have db cluster connect to other services running in docker | N/A | SCT_DOCKER_NETWORK
| **<a href="#user-content-s3_baremetal_config" name="s3_baremetal_config">s3_baremetal_config</a>** | | N/A | SCT_S3_BAREMETAL_CONFIG
Expand Down Expand Up @@ -294,9 +294,7 @@
| **<a href="#user-content-stress_cmd_complex_verify_delete" name="stress_cmd_complex_verify_delete">stress_cmd_complex_verify_delete</a>** | cassandra-stress commands.<br>You can specify everything but the -node parameter, which is going to<br>be provided by the test suite infrastructure.<br>multiple commands can passed as a list | N/A | SCT_STRESS_CMD_COMPLEX_VERIFY_DELETE
| **<a href="#user-content-scylla_encryption_options" name="scylla_encryption_options">scylla_encryption_options</a>** | options will be used for enable encryption at-rest for tables | N/A | SCT_SCYLLA_ENCRYPTION_OPTIONS
| **<a href="#user-content-kms_key_rotation_interval" name="kms_key_rotation_interval">kms_key_rotation_interval</a>** | 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. | N/A | SCT_KMS_KEY_ROTATION_INTERVAL
| **<a href="#user-content-logs_transport" name="logs_transport">logs_transport</a>** | How to transport logs: rsyslog, ssh or docker | syslog-ng | SCT_LOGS_TRANSPORT
| **<a href="#user-content-rsyslog_imjournal_rate_limit_interval" name="rsyslog_imjournal_rate_limit_interval">rsyslog_imjournal_rate_limit_interval</a>** | Value for rsyslog' imjournal Ratelimit.Interval option (maximum 65535 till rsyslog v8.34) | 60 | SCT_RSYSLOG_IMJOURNAL_RATE_LIMIT_INTERVAL
| **<a href="#user-content-rsyslog_imjournal_rate_limit_burst" name="rsyslog_imjournal_rate_limit_burst">rsyslog_imjournal_rate_limit_burst</a>** | Value for rsyslog' imjournal Ratelimit.Burst option (maximum 65535 till rsyslog v8.34) | 50000 | SCT_RSYSLOG_IMJOURNAL_RATE_LIMIT_BURST
| **<a href="#user-content-logs_transport" name="logs_transport">logs_transport</a>** | How to transport logs: syslog-ng, ssh or docker | syslog-ng | SCT_LOGS_TRANSPORT
| **<a href="#user-content-collect_logs" name="collect_logs">collect_logs</a>** | Collect logs from instances and sct runner | N/A | SCT_COLLECT_LOGS
| **<a href="#user-content-execute_post_behavior" name="execute_post_behavior">execute_post_behavior</a>** | Run post behavior actions in sct teardown step | N/A | SCT_EXECUTE_POST_BEHAVIOR
| **<a href="#user-content-post_behavior_db_nodes" name="post_behavior_db_nodes">post_behavior_db_nodes</a>** | Failure/post test behavior, i.e. what to do with the db cloud instances at the end of the test.<br><br>'destroy' - Destroy instances and credentials (default)<br>'keep' - Keep instances running and leave credentials alone<br>'keep-on-failure' - Keep instances if testrun failed | keep-on-failure | SCT_POST_BEHAVIOR_DB_NODES
Expand Down Expand Up @@ -356,3 +354,4 @@
| **<a href="#user-content-simulated_racks" name="simulated_racks">simulated_racks</a>** | Forces GossipingPropertyFileSnitch (regardless `endpoint_snitch`) to simulate racks.<br>Provide number of racks to simulate. | N/A | SCT_SIMULATED_RACKS
| **<a href="#user-content-use_dns_names" name="use_dns_names">use_dns_names</a>** | Use dns names instead of ip addresses for nodes in cluster | N/A | SCT_USE_DNS_NAMES
| **<a href="#user-content-validate_large_collections" name="validate_large_collections">validate_large_collections</a>** | Enable validation for large cells in system table and logs | N/A | SCT_VALIDATE_LARGE_COLLECTIONS
| **<a href="#user-content-run_commit_log_check_thread" name="run_commit_log_check_thread">run_commit_log_check_thread</a>** | Run commit log check thread if commitlog_use_hard_size_limit is True | True | SCT_RUN_COMMIT_LOG_CHECK_THREAD

0 comments on commit 842a859

Please sign in to comment.