Skip to content

Commit 8a9ec08

Browse files
committed
Installation: Update section about installing RPM packages
Registering with the package repository using the `crate-release-7.0-1.x86_64.rpm` packages and friends is being deprecated. It is advised to configure the RPM repository manually instead.
1 parent 8a7bba0 commit 8a9ec08

File tree

1 file changed

+50
-22
lines changed

1 file changed

+50
-22
lines changed

docs/install/redhat.rst

Lines changed: 50 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
CrateDB on Red Hat, SUSE, and Derivates
1010
#######################################
1111

12-
Install CrateDB RPM_ packages using the YUM_ package manager.
12+
Install CrateDB RPM_ packages using the DNF_, YUM_, or ZYpp_ package managers.
1313

1414
This installation method is suitable for RedHat Enterprise Linux (RHEL) and compatible
1515
systems like Fedora, CentOS, Rocky Linux, AlmaLinux, AWS Linux, Oracle Linux, or
@@ -19,38 +19,51 @@ Scientific Linux. Installation also works on openSUSE and SUSE Linux Enterprise
1919
Configure package repository
2020
============================
2121

22-
You will need to configure your system to register with and trust packages
23-
from the CrateDB package repository::
24-
25-
# Install prerequisites.
26-
yum install sudo
27-
28-
# Import the public GPG key for verifying the package signatures.
29-
sudo rpm --import https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
30-
31-
# Register with the CrateDB package repository.
32-
sudo rpm -Uvh https://cdn.crate.io/downloads/yum/7/x86_64/crate-release-7.0-1.x86_64.rpm
33-
34-
The command above will install the ``/etc/yum.repos.d/crate.repo`` package
35-
repository configuration file.
22+
To register with the CrateDB package repository, create a file called ``cratedb.repo``
23+
in the ``/etc/yum.repos.d/`` directory for RedHat based distributions, or in the
24+
``/etc/zypp/repos.d/`` directory for OpenSuSE based distributions, containing::
25+
26+
[cratedb-ce-stable]
27+
name=CrateDB RPM package repository - $basearch - Stable
28+
baseurl=https://cdn.crate.io/downloads/yum/7/$basearch
29+
enabled=0
30+
gpgcheck=1
31+
gpgkey=https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
32+
autorefresh=1
33+
type=rpm-md
34+
35+
[cratedb-ce-testing]
36+
name=CrateDB RPM package repository - $basearch - Testing
37+
baseurl=https://cdn.crate.io/downloads/yum/testing/7/$basearch
38+
enabled=0
39+
gpgcheck=1
40+
gpgkey=https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
41+
autorefresh=1
42+
type=rpm-md
3643

3744
.. NOTE::
3845

39-
CrateDB provides both *stable release* and *testing release* channels. You
40-
can read more about the `release workflow`_.
46+
The configured repository is disabled by default. This eliminates the
47+
possibility of accidentally upgrading CrateDB when upgrading the rest
48+
of the system. Each install or upgrade command must explicitly enable
49+
the repository as indicated in the sample installation command below.
4150

42-
By default, yum_ (Red Hat's package manager) will use the stable
43-
repository. This is because the testing repository is disabled.
44-
If you would like to enable the testing repository, edit the ``crate.repo``
45-
file and set ``enabled=1`` within the ``[crate-testing]`` section.
51+
CrateDB provides both *stable release* and *testing release* channels. You
52+
can read more about the `release workflow`_.
4653

4754

4855
Install CrateDB
4956
===============
5057

5158
With everything set up, you can install CrateDB::
5259

53-
sudo yum install crate
60+
sudo dnf install --enablerepo=cratedb-ce-stable crate
61+
62+
.. TIP::
63+
64+
On older Red Hat and CentOS installations, please use the ``yum`` command
65+
instead of ``dnf``. On SUSE based installations, please use the ``zypper``
66+
command.
5467

5568

5669
Configure CrateDB
@@ -60,10 +73,25 @@ Please visit the :ref:`install-configure` documentation section to learn
6073
about the location and meaning of CrateDB's configuration files.
6174

6275

76+
Trust signing key
77+
=================
78+
79+
In order to trust the package signing key upfront, before being prompted
80+
to do it on the first installation of CrateDB, you can also import it
81+
into your repository keyring, like that::
82+
83+
# Install prerequisites.
84+
yum install sudo
85+
86+
# Import the public GPG key for verifying the package signatures.
87+
sudo rpm --import https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
88+
6389

6490
.. include:: _control-linux.rst
6591
.. include:: _post-install.rst
6692

93+
.. _DNF: https://en.wikipedia.org/wiki/DNF_(software)
6794
.. _release workflow: https://github.com/crate/crate/blob/master/devs/docs/release.rst
6895
.. _RPM: https://en.wikipedia.org/wiki/RPM_Package_Manager
6996
.. _YUM: https://en.wikipedia.org/wiki/Yum_(software)
97+
.. _ZYpp: https://en.wikipedia.org/wiki/ZYpp

0 commit comments

Comments
 (0)