From 7695bc1faa0afd4bf322d19b1a4cb42c81b2643a Mon Sep 17 00:00:00 2001 From: Eric Lippmann Date: Tue, 9 Apr 2024 16:04:59 +0200 Subject: [PATCH] Docs: Fix whitespaces --- doc/02-Installation.md | 38 +++++++++++++++++++++ doc/02-Installation.md.d/01-Amazon-Linux.md | 1 + doc/02-Installation.md.d/02-CentOS.md | 1 + doc/02-Installation.md.d/03-Debian.md | 1 + doc/02-Installation.md.d/04-RHEL.md | 1 + doc/02-Installation.md.d/05-SLES.md | 1 + doc/02-Installation.md.d/06-Ubuntu.md | 1 + doc/03-Configuration.md | 8 ++--- doc/06-Migration.md | 2 +- 9 files changed, 49 insertions(+), 5 deletions(-) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index f292d3d5e..e7e359aa9 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -1,4 +1,5 @@ + # Installing Icinga DB The recommended way to install Icinga DB is to use prebuilt packages for @@ -24,6 +25,7 @@ which ships an up-to-date Redis® open source server version and is pre-configur keep latency between the components low. + ## Adding Icinga Package Repository The recommended way to install Icinga DB is to use prebuilt packages from our official release repository. @@ -38,7 +40,9 @@ Here's how to add the official release repository: + ### Amazon Linux 2 Repository + !!! info @@ -51,21 +55,28 @@ Here's how to add the official release repository: rpm --import https://packages.icinga.com/icinga.key wget https://packages.icinga.com/subscription/amazon/ICINGA-release.repo -O /etc/yum.repos.d/ICINGA-release.repo ``` + + ### CentOS Repository + + ```bash rpm --import https://packages.icinga.com/icinga.key wget https://packages.icinga.com/centos/ICINGA-release.repo -O /etc/yum.repos.d/ICINGA-release.repo ``` + + ### Debian Repository + ```bash @@ -82,11 +93,14 @@ DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \ apt update ``` + + ### RHEL Repository + !!! info @@ -99,11 +113,14 @@ apt update rpm --import https://packages.icinga.com/icinga.key wget https://packages.icinga.com/subscription/rhel/ICINGA-release.repo -O /etc/yum.repos.d/ICINGA-release.repo ``` + + ### SLES Repository + !!! info @@ -118,11 +135,14 @@ rpm --import https://packages.icinga.com/icinga.key zypper ar https://packages.icinga.com/subscription/sles/ICINGA-release.repo zypper ref ``` + + ### Ubuntu Repository + ```bash @@ -139,6 +159,7 @@ wget -O - https://packages.icinga.com/icinga.key | apt-key add - apt update ``` + ## Installing Icinga DB Package @@ -147,16 +168,22 @@ Use your distribution's package manager to install the `icingadb` package as fol + #### Amazon Linux 2 + + ```bash yum install icingadb ``` + + #### CentOS + !!! info @@ -165,18 +192,24 @@ yum install icingadb ```bash yum install icingadb ``` + + #### Debian / Ubuntu + + ```bash apt install icingadb ``` + + #### RHEL 8 or Later ```bash @@ -188,15 +221,20 @@ dnf install icingadb ```bash yum install icingadb ``` + + #### SLES + + ```bash zypper install icingadb ``` + ## Setting up the Database diff --git a/doc/02-Installation.md.d/01-Amazon-Linux.md b/doc/02-Installation.md.d/01-Amazon-Linux.md index cb5e161c8..45a3286f4 100644 --- a/doc/02-Installation.md.d/01-Amazon-Linux.md +++ b/doc/02-Installation.md.d/01-Amazon-Linux.md @@ -1,3 +1,4 @@ # Installing Icinga DB on Amazon Linux + diff --git a/doc/02-Installation.md.d/02-CentOS.md b/doc/02-Installation.md.d/02-CentOS.md index 343d64062..42ff36685 100644 --- a/doc/02-Installation.md.d/02-CentOS.md +++ b/doc/02-Installation.md.d/02-CentOS.md @@ -1,3 +1,4 @@ # Installing Icinga DB on CentOS + diff --git a/doc/02-Installation.md.d/03-Debian.md b/doc/02-Installation.md.d/03-Debian.md index 2cea527dd..3eb3ba015 100644 --- a/doc/02-Installation.md.d/03-Debian.md +++ b/doc/02-Installation.md.d/03-Debian.md @@ -1,3 +1,4 @@ # Installing Icinga DB on Debian + diff --git a/doc/02-Installation.md.d/04-RHEL.md b/doc/02-Installation.md.d/04-RHEL.md index 0dd059afb..39cabce44 100644 --- a/doc/02-Installation.md.d/04-RHEL.md +++ b/doc/02-Installation.md.d/04-RHEL.md @@ -1,3 +1,4 @@ # Installing Icinga DB on RHEL + diff --git a/doc/02-Installation.md.d/05-SLES.md b/doc/02-Installation.md.d/05-SLES.md index 9af0e4869..e1915e88d 100644 --- a/doc/02-Installation.md.d/05-SLES.md +++ b/doc/02-Installation.md.d/05-SLES.md @@ -1,3 +1,4 @@ # Installing Icinga DB on SLES + diff --git a/doc/02-Installation.md.d/06-Ubuntu.md b/doc/02-Installation.md.d/06-Ubuntu.md index 0ce05e011..d1ef557a9 100644 --- a/doc/02-Installation.md.d/06-Ubuntu.md +++ b/doc/02-Installation.md.d/06-Ubuntu.md @@ -1,3 +1,4 @@ # Installing Icinga DB on Ubuntu + diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index 957b21bad..472389483 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -47,9 +47,9 @@ In high availability setups, all Icinga DB instances must write to the same data ### Database Options Each of these configuration options are highly technical with thoroughly considered and tested default values that you -should only change when you exactly know what you are doing. You can use these options to influence the Icinga DB default -behaviour, how it interacts with databases, thus the defaults are usually sufficient for most users and do not need any -manual adjustments. +should only change when you exactly know what you are doing. You can use these options to influence the Icinga DB +default behaviour, how it interacts with databases, thus the defaults are usually sufficient for most users and +do not need any manual adjustments. !!! important @@ -93,7 +93,7 @@ Configuration of the logging component used by Icinga DB. ## Retention By default, no historical data is deleted, which means that the longer the data is retained, -the more disk space is required to store it. History retention is an optional feature that allows to +the more disk space is required to store it. History retention is an optional feature that allows to limit the number of days that historical data is available for each history category. There are separate options for the full history tables used to display history information in the web interface and SLA tables which store the minimal information required for SLA reporting, diff --git a/doc/06-Migration.md b/doc/06-Migration.md index 5a87e4107..cc565aac5 100644 --- a/doc/06-Migration.md +++ b/doc/06-Migration.md @@ -20,7 +20,7 @@ packages, it is automatically installed as well. ### Preparing the Configuration Please take the [example configuration] as a starting point and copy it to the -host you will perform the migration on. The following sections will guide you +host you will perform the migration on. The following sections will guide you through how to adjust it for your needs. #### Environment ID