Skip to content

Commit 76e78d5

Browse files
docs(etc): scylla-manager.yaml, explain rf rack valid sm ks creation
1 parent 67ded39 commit 76e78d5

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

dist/etc/scylla-manager.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,14 @@ http: 127.0.0.1:5080
7373
#
7474
# Keyspace for management data.
7575
# It will be created automatically on ScyllaDB Manager server startup if it does not already exist.
76-
# In such case, it will use NetworkTopologyStrategy and provided replication_factor.
76+
# In such case, it will use NetworkTopologyStrategy and have replication factor equal to the amount
77+
# of racks in each data center. In case where this setup could lead to reduced availability
78+
# (total replication factor smaller than 3), replication factor will be increased up to 3
79+
# (depending on node count) regardless of the rack count.
7780
# In case different keyspace replication is required, it should be created manually
7881
# before starting ScyllaDB Manager server (this action is recommended for non default
7982
# ScyllaDB Manager database deployments - especially multi datacenter ones).
8083
# keyspace: scylla_manager
81-
# replication_factor: 1
8284
#
8385
# Query timeout.
8486
# timeout: 1s

docs/source/install-scylla-manager.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Best practice is to install ScyllaDB Manager Server on a dedicated machine, not
4242
.. code-block:: console
4343
:substitutions:
4444
45-
sudo curl -o /etc/apt/sources.list.d/scylla-manager.list -L https://downloads.scylladb.com/deb/debian/|UBUNTU_SCYLLADB_LIST|
45+
sudo curl -o /etc/apt/sources.list.d/scylla-manager.list -L https://downloads.scylladb.com/deb/debian/|UBUNTU_SCYLLADB_LIST|
4646
4747
4848
#. Install ScyllaDB Manager packages.
@@ -69,7 +69,7 @@ Best practice is to install ScyllaDB Manager Server on a dedicated machine, not
6969
7070
sudo yum install scylla-manager-server
7171
sudo yum install scylla-manager-client
72-
72+
7373
7474
7575
Configure storage
@@ -114,7 +114,6 @@ ScyllaDB Manager configuration file ``/etc/scylla-manager/scylla-manager.yaml``
114114
#
115115
# Keyspace for management data, for create statement see /etc/scylla-manager/create_keyspace.cql.tpl.
116116
# keyspace: scylla_manager
117-
# replication_factor: 1
118117
119118
Using an editor open the file and change relevant parameters.
120119

@@ -124,8 +123,10 @@ Using an editor open the file and change relevant parameters.
124123

125124
#. If authentication is needed, uncomment and edit the ``user`` and ``password`` parameters.
126125

127-
#. If it's a single DC cluster, uncomment and edit the ``replication_factor`` parameter to match the required replication factor.
128-
This would use NetworkTopologyStrategy to create a ScyllaDB Manager keyspace, refer to `ScyllaDB Architecture - Fault Tolerance <https://docs.scylladb.com/architecture/architecture-fault-tolerance/>`_ for more information on replication.
126+
#. If it's a single DC cluster, ScyllaDB Manager keyspace using NetworkTopologyStrategy would be created.
127+
Refer to `ScyllaDB Architecture - Fault Tolerance <https://docs.scylladb.com/architecture/architecture-fault-tolerance/>`_ for more information on replication.
128+
It would have replication factor equal to the amount of racks in each data center. In case where this setup could lead to reduced availability
129+
(total replication factor smaller than 3), replication factor will be increased up to 3 (depending on node count) regardless of the rack count.
129130

130131
#. If it's a multi DC cluster, create a keyspace named ``scylla_manager`` yourself.
131132
You can use a different keyspace name, just remember to adjust the ``keyspace`` parameter value.
@@ -159,7 +160,6 @@ Sample configuration of ScyllaDB Manager working with a remote cluster with auth
159160
- 198.100.51.12
160161
user: user
161162
password: password
162-
replication_factor: 3
163163
164164
Run the scyllamgr_setup script
165165
==============================

0 commit comments

Comments
 (0)