mirror of
https://github.com/scylladb/scylladb.git
synced 2026-04-27 11:55:15 +00:00
ad649be1bf
thrift support was deprecated since ScyllaDB 5.2 > Thrift API - legacy ScyllaDB (and Apache Cassandra) API is > deprecated and will be removed in followup release. Thrift has > been disabled by default. so let's drop it. in this change, * thrift protocol support is dropped * all references to thrift support in document are dropped * the "thrift_version" column in system.local table is preserved for backward compatibility, as we could load from an existing system.local table which still contains this clolumn, so we need to write this column as well. * "/storage_service/rpc_server" is only preserved for backward compatibility with java-based nodetool. * `rpc_port` and `start_rpc` options are preserved, but they are marked as "Unused". so that the new release of scylladb can consume existing scylla.yaml configurations which might contain these settings. by making them deprecated, user will be able get warned, and update their configurations before we actually remove them in the next major release. Fixes #3811 Fixes #18416 Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
219 lines
7.7 KiB
ReStructuredText
219 lines
7.7 KiB
ReStructuredText
.. The |RHEL_EPEL| variable needs to be adjuster per release, depending on support for RHEL.
|
||
.. 5.2 supports Rocky/RHEL 8 only
|
||
.. 5.4 supports Rocky/RHEL 8 and 9
|
||
.. |RHEL_EPEL_8| replace:: https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
|
||
.. |RHEL_EPEL_9| replace:: https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
|
||
|
||
======================================
|
||
Install ScyllaDB Linux Packages
|
||
======================================
|
||
|
||
We recommend installing ScyllaDB using :doc:`ScyllaDB Web Installer for Linux </getting-started/installation-common/scylla-web-installer/>`,
|
||
a platform-agnostic installation script, to install ScyllaDB on any supported Linux platform.
|
||
Alternatively, you can install ScyllaDB using Linux packages.
|
||
|
||
This article will help you install ScyllaDB on Linux using platform-specific packages.
|
||
|
||
Prerequisites
|
||
----------------
|
||
|
||
* Ubuntu, Debian, CentOS, or RHEL (see :doc:`OS Support by Platform and Version </getting-started/os-support>`
|
||
for details about supported versions and architecture)
|
||
* Root or ``sudo`` access to the system
|
||
* Open :ref:`ports used by ScyllaDB <networking-ports>`
|
||
* (CentOS and RHEL only) Removing Automatic Bug Reporting Tool (ABRT) if installed before installing ScyllaDB,
|
||
as it may conflict with ScyllaDB coredump configuration:
|
||
|
||
.. code-block:: console
|
||
|
||
sudo yum remove -y abrt
|
||
|
||
.. The last requirement may need to be removed. See https://github.com/scylladb/scylladb/issues/14488.
|
||
|
||
Install ScyllaDB
|
||
--------------------
|
||
|
||
.. tabs::
|
||
|
||
.. group-tab:: Debian/Ubuntu
|
||
|
||
#. Install a repo file and add the ScyllaDB APT repository to your system.
|
||
|
||
.. code-block:: console
|
||
|
||
sudo mkdir -p /etc/apt/keyrings
|
||
|
||
|
||
.. code-block:: console
|
||
|
||
sudo gpg --homedir /tmp --no-default-keyring --keyring /etc/apt/keyrings/scylladb.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 491c93b9de7496a7
|
||
|
||
.. code-block:: console
|
||
:substitutions:
|
||
|
||
sudo wget -O /etc/apt/sources.list.d/scylla.list http://downloads.scylladb.com/deb/debian/|UBUNTU_SCYLLADB_LIST|
|
||
|
||
|
||
#. Install ScyllaDB packages.
|
||
|
||
.. code-block:: console
|
||
|
||
sudo apt-get update
|
||
sudo apt-get install -y scylla
|
||
|
||
Running the command installs the latest official version of ScyllaDB Open Source.
|
||
To install a specific patch version, list all the available patch versions:
|
||
|
||
.. code-block:: console
|
||
|
||
apt-cache madison scylla
|
||
|
||
Then install the selected patch version:
|
||
|
||
.. code-block:: console
|
||
|
||
apt-get install scylla{,-server,-jmx,-tools,-tools-core,-kernel-conf,-node-exporter,-conf,-python3}=<your patch version>
|
||
|
||
The following example shows installing ScyllaDB 5.2.3.
|
||
|
||
.. code-block:: console
|
||
:class: hide-copy-button
|
||
|
||
apt-cache madison scylla
|
||
scylla | 5.2.3-0.20230608.ea08d409f155-1 | https://downloads.scylladb.com/downloads/scylla/deb/debian-ubuntu/scylladb-5.2 stable/main amd64 Packages
|
||
scylla | 5.2.2-0.20230521.9dd70a58c3f9-1 | https://downloads.scylladb.com/downloads/scylla/deb/debian-ubuntu/scylladb-5.2 stable/main amd64 Packages
|
||
scylla | 5.2.1-0.20230508.f1c45553bc29-1 | https://downloads.scylladb.com/downloads/scylla/deb/debian-ubuntu/scylladb-5.2 stable/main amd64 Packages
|
||
scylla | 5.2.0-0.20230427.429b696bbc1b-1 | https://downloads.scylladb.com/downloads/scylla/deb/debian-ubuntu/scylladb-5.2 stable/main amd64 Packages
|
||
|
||
.. code-block:: console
|
||
:class: hide-copy-button
|
||
|
||
apt-get install scylla{,-server,-jmx,-tools,-tools-core,-kernel-conf,-node-exporter,-conf,-python3}=5.2.3-0.20230608.ea08d409f155-1
|
||
|
||
|
||
#. (Ubuntu only) Set Java 11.
|
||
|
||
.. code-block:: console
|
||
|
||
sudo apt-get update
|
||
sudo apt-get install -y openjdk-11-jre-headless
|
||
sudo update-java-alternatives --jre-headless -s java-1.11.0-openjdk-amd64
|
||
|
||
|
||
.. group-tab:: Centos/RHEL
|
||
|
||
#. Install the EPEL repository.
|
||
|
||
CentOS:
|
||
|
||
.. code-block:: console
|
||
|
||
sudo yum install epel-release
|
||
|
||
|
||
Rocky/RHEL 8
|
||
|
||
.. code-block:: console
|
||
:substitutions:
|
||
|
||
sudo yum -y install |RHEL_EPEL_8|
|
||
|
||
|
||
Rocky/RHEL 9
|
||
|
||
.. code-block:: console
|
||
:substitutions:
|
||
|
||
sudo yum -y install |RHEL_EPEL_9|
|
||
|
||
#. Add the ScyllaDB RPM repository to your system.
|
||
|
||
.. code-block:: console
|
||
:substitutions:
|
||
|
||
sudo curl -o /etc/yum.repos.d/scylla.repo -L http://downloads.scylladb.com/rpm/centos/|CENTOS_SCYLLADB_REPO|
|
||
|
||
#. Install ScyllaDB packages.
|
||
|
||
.. code-block:: console
|
||
|
||
sudo yum install scylla
|
||
|
||
Running the command installs the latest official version of ScyllaDB Open Source.
|
||
Alternatively, you can to install a specific patch version:
|
||
|
||
.. code-block:: console
|
||
|
||
sudo yum install scylla-<your patch version>
|
||
|
||
Example: The following example shows the command to install ScyllaDB 5.2.3.
|
||
|
||
.. code-block:: console
|
||
:class: hide-copy-button
|
||
|
||
sudo yum install scylla-5.2.3
|
||
|
||
|
||
Configure and Run ScyllaDB
|
||
-------------------------------
|
||
|
||
#. Configure the following parameters in the ``/etc/scylla/scylla.yaml`` configuration file.
|
||
|
||
* ``cluster_name`` - The name of the cluster. All the nodes in the cluster must have the same
|
||
cluster name configured.
|
||
* ``seeds`` - The IP address of the first node. Other nodes will use it as the first contact
|
||
point to discover the cluster topology when joining the cluster.
|
||
* ``listen_address`` - The IP address that ScyllaDB uses to connect to other nodes in the cluster.
|
||
* ``rpc_address`` - The IP address of the interface for CQL client connections.
|
||
|
||
#. Run the ``scylla_setup`` script to tune the system settings and determine the optimal configuration.
|
||
|
||
.. code-block:: console
|
||
|
||
sudo scylla_setup
|
||
|
||
* The script invokes a set of :ref:`scripts <system-configuration-scripts>` to configure several operating system settings; for example, it sets
|
||
RAID0 and XFS filesystem.
|
||
* The script runs a short (up to a few minutes) benchmark on your storage and generates the ``/etc/scylla.d/io.conf``
|
||
configuration file. When the file is ready, you can start ScyllaDB. ScyllaDB will not run without XFS
|
||
or ``io.conf`` file.
|
||
* You can bypass this check by running ScyllaDB in :doc:`developer mode </getting-started/installation-common/dev-mod>`.
|
||
We recommend against enabling developer mode in production environments to ensure ScyllaDB's maximum performance.
|
||
|
||
#. Run ScyllaDB as a service (if not already running).
|
||
|
||
.. code-block:: console
|
||
|
||
sudo systemctl start scylla-server
|
||
|
||
|
||
Now you can start using ScyllaDB. Here are some tools you may find useful.
|
||
|
||
Run nodetool:
|
||
|
||
.. code-block:: console
|
||
|
||
nodetool status
|
||
|
||
Run cqlsh:
|
||
|
||
.. code-block:: console
|
||
|
||
cqlsh
|
||
|
||
Run cassandra-stress:
|
||
|
||
.. code-block:: console
|
||
|
||
cassandra-stress write -mode cql3 native
|
||
|
||
|
||
Next Steps
|
||
------------
|
||
|
||
* :doc:`Configure ScyllaDB </getting-started/system-configuration>`
|
||
* Manage your clusters with `ScyllaDB Manager <https://manager.docs.scylladb.com/>`_
|
||
* Monitor your cluster and data with `ScyllaDB Monitoring <https://monitoring.docs.scylladb.com/>`_
|
||
* Get familiar with ScyllaDB’s :doc:`command line reference guide </operating-scylla/nodetool>`.
|
||
* Learn about ScyllaDB at `ScyllaDB University <https://university.scylladb.com/>`_
|