[dev.icinga.com #2905] create a dedicated page for packages and their customizations

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/2905

Created by mfriedrich on 2012-07-27 09:27:55 +00:00

Assignee: croft
Status: Resolved (closed on 2012-09-26 17:19:28 +00:00)
Target Version: 1.8
Last Update: 2012-09-26 17:19:28 +00:00 (in Redmine)

---

we need a clarification somewhere for the quickinstall guides, for packages.

my proposal

• create a dedicated page for packages (like "quickstart for packages")
• link the wiki guides for the distributions we have
• write in BIG FAT LETTERS AND COLOR that PATHs on packages are different to the default non-fhs compliant source install with prefix /usr/local/icinga
• add a list of distributions and their package urls with possible locations of

**** icinga/ido2db/idomod.so binary

**** icinga/ido2db initscript

**** icinga.cfg / ido2db.cfg / idomod.cfg

**** status.dat / objects.cache / rentention.dat

**** spool for checkresults

**** commandfile

this new page should be linked everywhere in the quickstart guides, where people should be targetted reading on the "quickstart for packages", leaving the "quickstart for source install" - we might adapt the name in the TOC too...

i will provide some lists later on, at least for the repoforge RHEL version, plus Debian.

Attachments

• icinga_docs_1.8_de_packages.png mfriedrich - 2012-09-25 11:18:15 +00:00

Changesets

2012-09-26 14:47:31 +00:00 by mfriedrich 3409d10

fix url and text in en/icinga-packages.xml refs #2905

[icinga-migration]

Updated by mfriedrich on 2012-07-31 13:01:52 +00:00

Add a note that packagers might adopt paths on new releases - so if you can't find a config, binary, etc use one of those tips

• find, grep, locate/updatedb
• icinga binary and icinga.cfg
• icinga.cfg knows about most locations the icinga daemon needs to run with
• cgi.cfg will know where icinga.cfg is, and the classic ui paths

Debian/ubuntu

Howto Url
Debian: https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+IDOUtils+on+Debian
Ubuntu: https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+IDOUtils+on+Ubuntu

Source
Debian Backports or Ubuntu PPA

Package Docs
(replace icinga* with the package name)

$ zless /usr/share/doc/icinga*/README.Debian.gz

Customizations

- the initscript is debianized and does NOT support all upstream parameters
- example object configs look different. the upstream configs are installed into /usr/share/doc/icinga-common/examples (install icinga-common package)
- nagios-plugins command definitions are included in icinga.cfg already, if the nagios-plugins package is installed
- icinga_user|group=nagios
- db setup on package install of icinga-idoutils
- external commands setup on package install
- ido2db daemon must be enabled in /etc/default/icinga

Locations

config (icinga.cfg, cgi.cfg, ido{mod|2db}.cfg): /etc/icinga
neb modules config: /etc/icinga/modules
nagios plugin config: /etc/nagios-plugins
binaries: /usr/sbin/icinga|icingastats|ido2db
libraries: /usr/lib/icinga/idomod.so|p1.pl
state dir (status.dat, objects.cache, retention.dat): /var/cache/icinga
cmdfile: /var/spool/icinga/cmd
checkresults: /var/spool/icinga/checkresults
web: /usr/share/icinga/htdocs
web htpasswd: /etc/icinga/passwd
web config: /etc/icinga/apache2.conf
web path: /icinga + /cgi-bin/icinga
cgis: /usr/lib/cgi-bin/*.cgi
logs: /var/log/icinga
pid: /var/run/icinga/icinga.pid
init-script: /etc/init.d/icinga|ido2db
init-script settings: /etc/default/icinga

RHEL/CentOS/Fedora

Howto Url
https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+IDOUtils+on+RHEL

Source
Repoforge RPMs, or custom built RPMs by the linked guide
https://wiki.icinga.org/display/howtos/Build+Icinga+RPMs

Customizations

- icinga_user=icinga, icinga_group=icingacmd
- volatile data, created by icinga, in /var/spool/icinga (selinux)
- classic ui config uses /etc/icinga/htpasswd with default credentials for http auth
- idoutils packages does not install the database, follow /usr/share/doc/icinga-idoutils-libdbi-*/README.RHEL.idoutils or the the wiki entry

Package Docs
(replace icinga* with the package name and version)

$ less /usr/share/doc/icinga*/README.RHEL(.idoutils)

Locations

config (icinga.cfg, cgi.cfg, ido{mod|2db}.cfg): /etc/icinga
neb modules config: /etc/icinga/modules
binaries: /usr/bin/icinga|icingastats|ido2db
libraries: /usr/lib{64}/icinga/idomod.so
state dir (status.dat, objects.cache, retention.dat): /var/spool/icinga
cmdfile: /var/spool/icinga/cmd
checkresults: /var/spool/icinga/checkresults
web: /usr/share/icinga
web htpasswd: /etc/icinga/passwd
web config: /etc/httpd/conf.d/icinga.conf
web path: /icinga + /icinga/cgi-bin
cgis: /usr/lib{64}/icinga/cgi/*.cgi
logs: /var/log/icinga
pid: /var/run/icinga.pid
init-script: /etc/init.d/icinga|ido2db
init-script settings: /etc/sysconfig/icinga|ido2db

Other Packages

Open a docs issue with your updates!

[icinga-migration]

Updated by mfriedrich on 2012-09-03 17:50:32 +00:00

• Status changed from New to Assigned
• Assigned to set to croft

@lara
can you do it please?

[icinga-migration]

Updated by mfriedrich on 2012-09-09 09:17:43 +00:00

created a wiki page since i consider this one of the most common errors.
https://wiki.icinga.org/display/howtos/Package+Specific+Locations

[icinga-migration]

Updated by croft on 2012-09-10 11:11:06 +00:00

Looks fine :-) THX.

[icinga-migration]

Updated by mfriedrich on 2012-09-10 17:30:46 +00:00

can you link that somewhere, best on a dedicated page for "Icinga Packages" linked on the main TOC? so that people can see where to get their packages.

the page should contain a short description, plus the following references.

• package download url
  https://www.icinga.org/download/packages/

• install howtos from the wiki
  https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+IDOUtils
  https://wiki.icinga.org/display/howtos/Setting+up+Icinga+Web

• package specific locations
  https://wiki.icinga.org/display/howtos/Package+Specific+Locations

can you do that please?

[icinga-migration]

Updated by croft on 2012-09-10 18:09:29 +00:00

Yes, of course :-)

[icinga-migration]

Updated by mfriedrich on 2012-09-25 11:18:15 +00:00

• File added icinga_docs_1.8_de_packages.png
• Done % changed from 0 to 40

a little formatting on the german page would be nice, but then it could be translated to english in en/icinga-packages.xml plus when done, add a link to TOC in en/Icinga.xml

[icinga-migration]

Updated by croft on 2012-09-25 14:46:18 +00:00

...in progress :-)

[icinga-migration]

Updated by mfriedrich on 2012-09-26 17:19:28 +00:00

• Category set to Packages
• Status changed from Assigned to Resolved
• Done % changed from 40 to 100

i've fixed an url, and some text in the english version, as i was reviewing the docs today. for me, this is sufficient, when this links into the wiki, where everyone may update their package specific locations. thanks for the work.