Skip to content

Commit bc7a7e4

Browse files
annastuchlikannastuchlik
authored
fix(docs): add instructions to install Manager and Manager Agent (#4768)
* doc: add instructions to install Manager and Manager Agent This commit adds the missing instructions on how to install ScyllaDB Manager and ScyllaDB Manager Agent. Fixes #3915 Fixes #4729 * doc: update the Upgrade section to remove the link to the Download Center The Download Center no longer exists, so we can’t refer users to that resource. This commit replaces the information about the download pages with instructions on how to upgrade. The variables are used so that users can copy and paste the command, similarly to the installation section.
1 parent 9ab3248 commit bc7a7e4

3 files changed

Lines changed: 99 additions & 21 deletions

File tree

‎docs/source/install-scylla-manager-agent.rst‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,46 @@ Agent serves as a reverse proxy to Scylla REST API, and provides additional feat
1818
Install package
1919
===============
2020

21-
Download and install Scylla Manager Agent from the `Scylla Download Center <https://www.scylladb.com/download/#manager>`_.
21+
.. tabs::
22+
23+
.. group-tab:: Debian/Ubuntu
24+
25+
#. Import the ScyllaDB GPG signing key. *Note*: If ScyllaDB is already installed on this node, the key was
26+
imported during ScyllaDB installation.
27+
28+
.. code-block:: console
29+
30+
sudo mkdir -p /etc/apt/keyrings
31+
sudo gpg --homedir /tmp --no-default-keyring --keyring /etc/apt/keyrings/scylladb.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys a43e06657bac99e3
32+
33+
#. Add the ScyllaDB Manager APT repository to your system.
34+
35+
.. code-block:: console
36+
:substitutions:
37+
38+
sudo curl -o /etc/apt/sources.list.d/scylla-manager.list -L https://downloads.scylladb.com/deb/debian/|UBUNTU_SCYLLADB_LIST|
39+
40+
#. Install ScyllaDB Manager Agent.
41+
42+
.. code-block:: console
43+
44+
sudo apt update
45+
sudo apt install -y scylla-manager-agent
46+
47+
.. group-tab:: Centos/RHEL
48+
49+
#. Add the ScyllaDB Manager RPM repository to your system.
50+
51+
.. code-block:: console
52+
:substitutions:
53+
54+
sudo curl -o /etc/yum.repos.d/scylla-manager.repo -L https://downloads.scylladb.com/rpm/centos/|CENTOS_SCYLLADB_REPO|
55+
56+
#. Install ScyllaDB Manager Agent.
57+
58+
.. code-block:: console
59+
60+
sudo yum install scylla-manager-agent
2261
2362
Run the scyllamgr_agent_setup script
2463
====================================

‎docs/source/install-scylla-manager.rst‎

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,54 @@ While a minimal server can run on a system with 2 cores and 1GB RAM, the followi
2323
Install package
2424
===============
2525

26-
Best practice is to install ScyllaDB Manager Server on a dedicated machine not a Scylla production node.
27-
Download and install the ScyllaDB Manager Server and Client packages from the `Scylla Download Center <https://www.scylladb.com/download/#manager>`_.
26+
Best practice is to install ScyllaDB Manager Server on a dedicated machine, not on a ScyllaDB production node.
27+
28+
.. tabs::
29+
30+
.. group-tab:: Debian/Ubuntu
31+
32+
#. Import the ScyllaDB GPG signing key.
33+
34+
.. code-block:: console
35+
36+
sudo mkdir -p /etc/apt/keyrings
37+
sudo gpg --homedir /tmp --no-default-keyring --keyring /etc/apt/keyrings/scylladb.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys a43e06657bac99e3
38+
39+
40+
#. Add the Scylla Manager APT repository to your system.
41+
42+
.. code-block:: console
43+
:substitutions:
44+
45+
sudo curl -o /etc/apt/sources.list.d/scylla-manager.list -L https://downloads.scylladb.com/deb/debian/|UBUNTU_SCYLLADB_LIST|
46+
47+
48+
#. Install ScyllaDB Manager packages.
49+
50+
.. code-block:: console
51+
52+
sudo apt update
53+
sudo apt install -y scylla-manager-server
54+
sudo apt install -y scylla-manager-client
55+
56+
57+
.. group-tab:: Centos/RHEL
58+
59+
#. Add the ScyllaDB Manager RPM repository to your system.
60+
61+
.. code-block:: console
62+
:substitutions:
63+
64+
sudo curl -o /etc/yum.repos.d/scylla-manager.repo -L https://downloads.scylladb.com/rpm/centos/|CENTOS_SCYLLADB_REPO|
65+
66+
#. Install ScyllaDB Manager packages.
67+
68+
.. code-block:: console
69+
70+
sudo yum install scylla-manager-server
71+
sudo yum install scylla-manager-client
72+
73+
2874
2975
Configure storage
3076
=================

‎docs/source/upgrade/index.rst‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -82,38 +82,31 @@ It should have a status of *“Active: inactive (dead)”*.
8282
Upgrade the ScyllaDB Manager Server and Client
8383
----------------------------------------------
8484

85-
.. TODO This section must be updated when the installation instructions are moved to the docs:
86-
.. The link should take the user to the relevant page in the docs, not to the Download Center.
87-
88-
#. **On the Manager server**, update the Manager repo file. Go to ScyllaDB Manager in
89-
the `ScyllaDB Download Center <https://www.scylladb.com/download/#manager>`_,
90-
and select your platform and the version to which you want to upgrade to display the relevant command.
91-
92-
The following examples show how to update the repo for Manager 3.6:
85+
#. **On the Manager server**, update the Manager repo file.
9386

9487
.. tabs::
9588

96-
.. group-tab:: Example for Centos
89+
.. group-tab:: Centos
9790

98-
.. code:: console
99-
:class: hide-copy-button
91+
.. code-block:: console
92+
:substitutions:
10093
101-
sudo curl -o /etc/yum.repos.d/scylla-manager.repo -L https://downloads.scylladb.com/rpm/centos/scylladb-manager-3.6.repo
94+
sudo curl -o /etc/yum.repos.d/scylla-manager.repo -L https://downloads.scylladb.com/rpm/centos/|CENTOS_SCYLLADB_REPO|
10295
103-
.. group-tab:: Example for Ubuntu
96+
.. group-tab:: Ubuntu
10497

105-
.. code:: console
106-
:class: hide-copy-button
98+
.. code-block:: console
99+
:substitutions:
107100
108-
sudo wget -O /etc/apt/sources.list.d/scylla-manager.list https://downloads.scylladb.com/deb/ubuntu/scylladb-manager-3.6.list
101+
sudo wget -O /etc/apt/sources.list.d/scylla-manager.list https://downloads.scylladb.com/deb/ubuntu/|UBUNTU_SCYLLADB_LIST|
109102
110103
.. note::
111104

112105
You don't need to update the repo file if you upgrade to a patch release, for example,
113-
from Manager 3.5.0 to 3.5.1.
106+
from Manager 3.8.0 to 3.8.1.
114107

115108
You can display the contents of the Manager repo file to confirm that the displayed version
116-
is the ver#4487sion to which you want to upgrade.
109+
is the version to which you want to upgrade.
117110

118111
- On CentOS/Red Hat, run: ``cat /etc/yum.repos.d/scylla-manager.repo``
119112
- On Debian/Ubuntu, run: ``cat /etc/apt/sources.list.d/scylla-manager.list``

0 commit comments

Comments
 (0)