Skip to content

Installation: Update section about installing RPM packages #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2024
Merged

Installation: Update section about installing RPM packages #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 50 additions & 22 deletions docs/install/redhat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
CrateDB on Red Hat, SUSE, and Derivates
#######################################

Install CrateDB RPM_ packages using the YUM_ package manager.
Install CrateDB RPM_ packages using the DNF_, YUM_, or ZYpp_ package managers.

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

You will need to configure your system to register with and trust packages
from the CrateDB package repository::

# Install prerequisites.
yum install sudo

# Import the public GPG key for verifying the package signatures.
sudo rpm --import https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate

# Register with the CrateDB package repository.
sudo rpm -Uvh https://cdn.crate.io/downloads/yum/7/x86_64/crate-release-7.0-1.x86_64.rpm

The command above will install the ``/etc/yum.repos.d/crate.repo`` package
repository configuration file.
To register with the CrateDB package repository, create a file called ``cratedb.repo``
in the ``/etc/yum.repos.d/`` directory for RedHat based distributions, or in the
``/etc/zypp/repos.d/`` directory for OpenSuSE based distributions, containing::

[cratedb-ce-stable]
name=CrateDB RPM package repository - $basearch - Stable
baseurl=https://cdn.crate.io/downloads/yum/7/$basearch
enabled=0
gpgcheck=1
gpgkey=https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
autorefresh=1
type=rpm-md
Comment on lines +32 to +33
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those two parameters have not been part of the previous package repository configuration. They are now inherited from the advised package repository configuration like ES is doing it.

We did not research about their meaning yet, please advise correspondingly if you think they should be removed again.

Copy link
Member Author

@amotl amotl Apr 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On our tests, they didn't cause any harm, so we just followed ES here, and included them to the new configuration.


[cratedb-ce-testing]
name=CrateDB RPM package repository - $basearch - Testing
baseurl=https://cdn.crate.io/downloads/yum/testing/7/$basearch
enabled=0
gpgcheck=1
gpgkey=https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate
autorefresh=1
type=rpm-md

.. NOTE::

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

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


Install CrateDB
===============

With everything set up, you can install CrateDB::

sudo yum install crate
sudo dnf install --enablerepo=cratedb-ce-stable crate

.. TIP::

On older Red Hat and CentOS installations, please use the ``yum`` command
instead of ``dnf``. On SUSE based installations, please use the ``zypper``
command.


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


Trust signing key
=================

In order to trust the package signing key upfront, before being prompted
to do it on the first installation of CrateDB, you can also import it
into your repository keyring, like that::

# Install prerequisites.
yum install sudo

# Import the public GPG key for verifying the package signatures.
sudo rpm --import https://cdn.crate.io/downloads/yum/RPM-GPG-KEY-crate


.. include:: _control-linux.rst
.. include:: _post-install.rst

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