Filesystem Layout

Filesystem layout

OMD uses a standard Linux filesystem layout for etc, lib, var and other directories, with everything relative to the site’s home folder.

Philosophy

  • follow the Linux filesystem layout relative to the site’s home folder
  • only change files/folders owned by the site user

Global directory layout

    /omd
    ├── apache
    ├── sites
    │   ├── site_a
    │   ├── site_b
    │   └── site_...
    └── versions
        ├── 2.80-labs-edition
        ├── 2.90-labs-edition
        ├── 3.00-labs-edition
        └── default -> /etc/alternatives/omd

Global directories are created automatically and must to be changed. New site folders are created by the omd create command. New versions are installed by the package manager of your system. The apache folder contains the reverse proxy configuration for the system Apache server.

It is possible to install and use multiple OMD versions side by side. It is also possible to upgrade a legacy OMD installation to OMD-Labs with the omd update command.

Site directory layout

Keep a few things in mind:

  • Usually you should work with the site user only.
  • Everything not writable by the site user should not be changed manually.
  • The folders which are just symbolic links to the version directory (bin,lib,share,include) should not be changed.
  • The version symlink should not be changed manually; change the version with omd update.
  • Apply changes in the ./etc folder or with omd config.
    /omd/sites/example
    ├── bin -> version/bin
    ├── etc
    │   ├── apache
    │   ├── ...
    │   ├── cron.d
    │   ├── init.d
    │   ├── init-hooks.d
    │   ├── logrotate.d
    │   ├── mail-templates
    │   ├── rc.d
    │   └── xinetd.d
    ├── include -> version/include
    ├── lib -> version/lib
    ├── local
    │   ├── bin                                 *put scripts here*
    │   └── lib
    │       └── monitoring-plugins              *put your own plugins here*
    ├── share -> version/share
    ├── tmp
    ├── var
    │   ├── log                                 *logfiles can be found here*
    │   └── www
    └── version -> ../../versions/2.10-labs-edition

Check plugins

OMD makes it very easy to separate plugins you have written or downloaded from the standard plugin collection. The standard plugins are located in ./lib/monitoring-plugins which can be accessed by the $USER1$ macro in Nagios. Your own plugins should stay in ./local/lib/monitoring-plugins with the macro $USER2$.