scylla.yaml is equivalent to the Apache Cassandra cassandra.yaml configuration file, and it is compatible for relevant parameters. Below is a subset of scylla.yaml with parameters you are likely to update. For full list of parameters, look at the file itself.
# The name of the cluster. This is mainly used to prevent machines in # one logical cluster from joining another. cluster_name: 'Test Cluster' # This defines the number of tokens randomly assigned to this node on the ring # The more tokens, relative to other nodes, the larger the proportion of data # that this node will store. You probably want all nodes to have the same number # of tokens assuming they have equal hardware capability. # # If you already have a cluster with 1 token per node, and wish to migrate to # multiple tokens per node, see http://wiki.apache.org/cassandra/Operations num_tokens: 256 # Directory where Scylla should store data on disk. data_file_directories: - /var/lib/scylla/data # commit log. when running on magnetic HDD, this should be a # separate spindle than the data directories. commitlog_directory: /var/lib/scylla/commitlog # seed_provider class_name is saved for future use. # seeds address are mandatory! seed_provider: # Addresses of hosts that are deemed contact points. # Scylla nodes use this list of hosts to find each other and learn # the topology of the ring. You must change this if you are running # multiple nodes! - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: # seeds is actually a comma-delimited list of addresses. # Ex: "<ip1>,<ip2>,<ip3>" - seeds: "127.0.0.1" # Address or interface to bind to and tell other Scylla nodes to connect to. # You _must_ change this if you want multiple nodes to be able to communicate! # # Setting listen_address to 0.0.0.0 is always wrong. listen_address: localhost # Address to broadcast to other Scylla nodes # Leaving this blank will set it to the same value as listen_address # broadcast_address: 188.8.131.52 # port for the CQL native transport to listen for clients on # For security reasons, you should not expose this port to the internet. Firewall it if needed. native_transport_port: 9042 # Uncomment to enable experimental features # experimental: true
By default scylla.yaml is located at
/etc/scylla/scylla.yaml. Note that the file will open as read only unless you edit it as the root user or by using sudo.
scylla.yaml Required Settings¶
The following configuration items must be set
|cluster_name||Name of the cluster, all the nodes in the cluster must have the same name|
|seeds||Seed nodes are used during startup to bootstrap the gossip process and join the cluster|
|listen_address||IP address that the Scylla use to connect to other Scylla nodes in the cluster|
|rpc_address||IP address of interface for client connections (Thrift, CQL)|
Enabling Experimental Features¶
There are two ways to enable experimental features:
- Enable all experimental features (which may be risky)
- Enable only the features you want to try (available in Scylla Open Source from version 3.2)
Enable All Experimental Features¶
To enable all experimental features add to the scylla.yaml:
Enable Specific Experimental Features¶
New in version 3.2: Scylla Open Source
To enable specific experimental features add to the scylla.yaml the list of experimental features you want to enable, by setting the experimental_features array. The list of valid elements for this array can be obtained from
scylla --help. For example:
experimental_features: - cdc - lwt
Starting with Scylla Open Source 3.2, Scylla Enterprise 2019.1.4, Manager 2.0, and Monitoring 3.0 you can use IPv6 addresses wherever an IPv4 address is used, including client-to-node and node-to-node communication, Scylla Manager to Scylla nodes (Scylla Manager Agent), and Monitoring to nodes.
- seeds: "2a05:d018:223:f00:971d:14af:6418:fe2d" - listen_address: 2a05:d018:223:f00:971d:14af:6418:fe2d - broadcast_rpc_address: 2a05:d018:223:f00:971d:14af:6418:fe2d
To enable IPv6 addressing, set the following paramerter in scylla.yaml:
To read the rest of the Administration Guide (from the top).
To go to the System Configuration documentation, click here.