Commit graph

80 commits

Author SHA1 Message Date
Julian Brost
f9ce7a57bc
Merge pull request #743 from Icinga/doc-03-systemd-journald-appendix
doc/03-Configuration.md: Logging Fields in Journald
2024-08-06 15:24:19 +02:00
Alvar Penning
813cf9fad6
doc/03-Configuration.md: Logging Fields in Journald
While working on an issue where the additional logging information
provided by zap fields was missing, I realized that our documentation
did not indicate how to view them. So a new documentation section has
been added explaining how to view the fields when using the
`systemd-journald` logging output.

Also removes one trailing space.
2024-08-05 10:50:23 +02:00
Alvar Penning
fe00e9bcbe
doc/02-Installation.md: Fix installing-icingadb-db-packages anchor
The anchor contains web, which is incorrect in this context.
2024-06-03 08:38:17 +02:00
alvar
a0a65af026
Merge pull request #734 from Icinga/i707-release-v1.1.2
Release Version 1.2.0
2024-04-11 12:09:26 +00:00
Alvar Penning
f0b7aa2d38
Bump version to 1.2.0 2024-04-11 13:23:34 +02:00
Eric Lippmann
25f39383b1 Docs: Account Redis' trademark policy
See https://redis.io/legal/trademark-policy/
2024-04-11 10:07:51 +02:00
Julian Brost
ac85b52951 Upgrading docs for state_history schema migration
Co-authored-by: Alexander A. Klimov <alexander.klimov@icinga.com>
2024-04-08 16:01:53 +02:00
Yonas Habteab
79d6f7e85f Add upgrading hints/warnings 2024-04-05 15:48:21 +02:00
Yonas Habteab
735135ea7b Document wsrep_sync_wait database option 2024-03-28 13:24:57 +01:00
Yonas Habteab
6a14e557ca Document database.options properly 2024-03-27 14:41:47 +01:00
Yonas Habteab
71a8f2d962 Document retention.count & retention.interval options 2024-03-26 15:36:35 +01:00
Eric Lippmann
081505587a docs: Fix link to Icinga DB Web 2024-03-12 11:19:08 +01:00
Julian Brost
16849d8c70 doc/04-Upgrading.md: Fix path for schema upgrades
Looks like these were never in /usr/share/doc and the documentation was just
wrong for 1.0.0.
2023-08-08 14:41:31 +02:00
Julian Brost
a7800567c8 Upgrading docs for v1.1.1 2023-08-08 10:15:55 +02:00
Alexander A. Klimov
3991ee0edb icingadb-migrate: document TLS support 2023-06-21 16:53:29 +02:00
Feu Mourek
f8be92ebd2
Replace apt-get with apt 2022-11-23 12:06:50 +01:00
Julian Brost
ed9ae66e7c Improve documentation for migration tool
1. Moves the example config to a separate file one can just download.
2. Establishes some kind of standard workflow for the migration.
2022-11-07 13:35:09 +01:00
Alexander A. Klimov
cfaee2e3d4 cmd/icingadb-migrate: avoid unnecessary config option
for columns which are NULLable anyway.
2022-11-07 12:35:31 +01:00
Alexander A. Klimov
c51d767d7d Migration: docs enhancements 2022-10-26 15:30:36 +02:00
Alexander A. Klimov
0ff1728434 cmd/ido2icingadb: move docs to the main tree 2022-10-26 10:24:40 +02:00
Eric Lippmann
5d4167c15d Docs: Add Distributed Setups 2022-06-29 15:42:04 +02:00
Eric Lippmann
76b9b93206 Docs: Update Upgrading 2022-06-29 15:42:04 +02:00
Eric Lippmann
bc1d771104 Docs: Update Configuration 2022-06-29 15:42:04 +02:00
Eric Lippmann
782fbeac42 Docs: Update Installation 2022-06-29 15:42:04 +02:00
Eric Lippmann
cf8e12f391 Set Redis server port to 6380 by default
All Icinga DB components use 6380 as default Redis port.
2022-06-29 15:42:04 +02:00
Eric Lippmann
195db09f2e Update README.md 2022-06-29 15:42:04 +02:00
Eric Lippmann
96dd818cda Docs: Update About 2022-06-29 15:42:04 +02:00
Eric Lippmann
306a4a1f27 Docs: Remove Redis installation
Should be part of the Icinga docs.
2022-06-29 14:37:36 +02:00
Eric Lippmann
44722df309 Docs: Fix table borders
For compatibility reasons all table rows should have borders at the
start and at the end.
2022-06-29 14:37:36 +02:00
Eric Lippmann
ed6e352320 Docs: Don't require database password 2022-06-29 14:37:36 +02:00
Eric Lippmann
28df688986 Docs: Don't require database port 2022-06-29 14:37:36 +02:00
Eric Lippmann
69d7845a6f Docs: Use 'Database name' instead of 'Database database' 2022-06-29 14:37:36 +02:00
Eric Lippmann
067d8ea1cf Docs: Use CHANGEME as database password
icingadb is not a good default password and CHANGEME gives a clear hint
to set a proper password here.
2022-06-29 14:37:36 +02:00
Alexander A. Klimov
9b618c690a XTRIM data XREAD from icinga:runtime*
for Icinga 2 to monitor pending runtime updates.
2022-06-22 17:38:58 +02:00
Alexander A. Klimov
fac9f5e4e5 Write ops/s by op and s to icingadb:telemetry:stats 2022-06-15 09:51:59 +02:00
Julian Brost
f08c67cc1f Rename config.yml.example to config.example.yml
This makes more tools recognize this as a YAML file and enable syntax
highlighting for example.
2022-06-13 13:50:59 +02:00
Julian Brost
73e6922d8d Docs: use @localhost instead of @127.0.0.1 for MySQL user
This allows the user to additionally connect via ::1 and Unix Domain Sockets.
2022-06-07 10:53:51 +02:00
Eric Lippmann
399b6a3d32 Split Redis address into host and port
The port is set to 6379 by default to keep it consistent with standard
Redis installations, but the example configuration explicitly specifies
6380 since that is the default port of the icingadb-redis package.
2022-05-16 17:01:09 +02:00
Julian Brost
19170ecbcf SLA reporting: history retention for SLA tables 2022-05-13 12:04:47 +02:00
Julian Brost
a0b1bc3196 List required RDBMS versions and increase PostgreSQL minimum
MySQL minimum versions are based on what was used in Icinga DB 1.0.0 RC1.

The required PostgreSQL version is bumped to at least 9.6 as this allows to
label functions as `PARALLEL RESTRICTED` like it's done by the SLA reporting.
This or newer versions are available for both CentOS/RHEL 8 and SLES 12 which
were the primary constraints for the previous version requirement.

For CentOS/RHEL, don't specify some additional paths and package names with a
specific version, as any newer version is also fine and there's a choice of
multiple versions. Also, we don't guide the user through actually installing
the PostgreSQL server, so they should already be familiar with the differing
names if their distribution reuqires them.

[1] https://github.com/Icinga/icingadb/blob/v1.0.0-rc1/.github/workflows/go.yml
2022-05-13 12:04:47 +02:00
Alexander A. Klimov
eb61bce2f2 Document Redis *nix socket support 2022-05-02 12:17:27 +02:00
Ravi Kumar Kempapura Srinivasa
73f4639d35 Document history retention configuration
Co-authored-by: Eric Lippmann <eric.lippmann@icinga.com>
2022-03-22 15:55:04 +01:00
Alexander A. Klimov
21ad40cf07 Docs: Postgres: explicitly set en_US.UTF-8
refs #136
2022-03-10 17:06:57 +01:00
Alexander A. Klimov
2cf4529cc0 Postgres: use case-insensitive CITEXT columns
not to require web to LOWER().

refs #136
2022-03-10 17:04:22 +01:00
Alexander A. Klimov
db996b1839 Document Postgres support
refs #136
2022-03-10 17:04:19 +01:00
Johannes Meyer
c5a5c9f62c doc: Document the password option for Redis 2022-03-03 13:57:24 +01:00
Alexander Aleksandrovič Klimov
4cdd9831d9
Docs: don’t explain MySQL installation 2022-02-15 14:52:45 +01:00
Eric Lippmann
1bc7f137cd
Merge pull request #417 from Icinga/bugfix/docs-mysql-user-create-commands
Docs: Replace GRANT + IDENTIFIED BY command incompatible with newer MySQL versions
2021-12-09 16:09:43 +01:00
Noah Hilverling
73ef038dfa Docs: Replace GRANT command incompatible with newer MySQL versions 2021-11-23 13:48:08 +01:00
Noah Hilverling
ed92dc22cb Docs: Fix foreground command config parameter 2021-11-23 13:45:51 +01:00