Skip to content

Commit

Permalink
Docs: Fix whitespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
lippserd committed Apr 10, 2024
1 parent fd4ffda commit 4889c7d
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 5 deletions.
38 changes: 38 additions & 0 deletions doc/02-Installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!-- {% if index %} -->

# Installing Icinga DB

The recommended way to install Icinga DB is to use prebuilt packages for
Expand All @@ -24,6 +25,7 @@ which ships an up-to-date Redis server version and is pre-configured for the Ici
keep latency between the components low.

<!-- {% else %} -->

## Adding Icinga Package Repository

The recommended way to install Icinga DB is to use prebuilt packages from our official release repository.
Expand All @@ -38,7 +40,9 @@ Here's how to add the official release repository:

<!-- {% if amazon_linux %} -->
<!-- {% if not icingaDocs %} -->

### Amazon Linux 2 Repository

<!-- {% endif %} -->
!!! info

Expand All @@ -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
```

<!-- {% endif %} -->

<!-- {% if centos %} -->
<!-- {% if not icingaDocs %} -->

### CentOS Repository

<!-- {% endif %} -->

```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
```

<!-- {% endif %} -->

<!-- {% if debian %} -->
<!-- {% if not icingaDocs %} -->

### Debian Repository

<!-- {% endif %} -->

```bash
Expand All @@ -82,11 +93,14 @@ DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \

apt update
```

<!-- {% endif %} -->

<!-- {% if rhel %} -->
<!-- {% if not icingaDocs %} -->

### RHEL Repository

<!-- {% endif %} -->
!!! info

Expand All @@ -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
```

<!-- {% endif %} -->

<!-- {% if sles %} -->
<!-- {% if not icingaDocs %} -->

### SLES Repository

<!-- {% endif %} -->
!!! info

Expand All @@ -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
```

<!-- {% endif %} -->

<!-- {% if ubuntu %} -->
<!-- {% if not icingaDocs %} -->

### Ubuntu Repository

<!-- {% endif %} -->

```bash
Expand All @@ -139,6 +159,7 @@ wget -O - https://packages.icinga.com/icinga.key | apt-key add -

apt update
```

<!-- {% endif %} -->

## Installing Icinga DB Package
Expand All @@ -147,16 +168,22 @@ Use your distribution's package manager to install the `icingadb` package as fol

<!-- {% if amazon_linux %} -->
<!-- {% if not icingaDocs %} -->

#### Amazon Linux 2

<!-- {% endif %} -->

```bash
yum install icingadb
```

<!-- {% endif %} -->

<!-- {% if centos %} -->
<!-- {% if not icingaDocs %} -->

#### CentOS

<!-- {% endif %} -->
!!! info

Expand All @@ -165,18 +192,24 @@ yum install icingadb
```bash
yum install icingadb
```

<!-- {% endif %} -->

<!-- {% if debian or ubuntu %} -->
<!-- {% if not icingaDocs %} -->

#### Debian / Ubuntu

<!-- {% endif %} -->

```bash
apt install icingadb
```

<!-- {% endif %} -->

<!-- {% if rhel %} -->

#### RHEL 8 or Later

```bash
Expand All @@ -188,15 +221,20 @@ dnf install icingadb
```bash
yum install icingadb
```

<!-- {% endif %} -->

<!-- {% if sles %} -->
<!-- {% if not icingaDocs %} -->

#### SLES

<!-- {% endif %} -->

```bash
zypper install icingadb
```

<!-- {% endif %} -->

## Setting up the Database
Expand Down
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/01-Amazon-Linux.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on Amazon Linux

<!-- {% set amazon_linux = True %} -->
<!-- {% include "02-Installation.md" %} -->
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/02-CentOS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on CentOS

<!-- {% set centos = True %} -->
<!-- {% include "02-Installation.md" %} -->
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/03-Debian.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on Debian

<!-- {% set debian = True %} -->
<!-- {% include "02-Installation.md" %} -->
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/04-RHEL.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on RHEL

<!-- {% set rhel = True %} -->
<!-- {% include "02-Installation.md" %} -->
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/05-SLES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on SLES

<!-- {% set sles = True %} -->
<!-- {% include "02-Installation.md" %} -->
1 change: 1 addition & 0 deletions doc/02-Installation.md.d/06-Ubuntu.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installing Icinga DB on Ubuntu

<!-- {% set ubuntu = True %} -->
<!-- {% include "02-Installation.md" %} -->
8 changes: 4 additions & 4 deletions doc/03-Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
Expand Down
4 changes: 3 additions & 1 deletion doc/06-Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -98,5 +98,7 @@ where it left off and reuse the cache if it is still present.
protect yourself against SSH connection losses.

[installation instructions]: 02-Installation.md

[IDO]: https://icinga.com/docs/icinga-2/latest/doc/14-features/#ido-database-db-ido

[example configuration]: icingadb-migration.example.yml

0 comments on commit 4889c7d

Please sign in to comment.