Skip to content

Apps

Apps objects descrive user services or applications (e.g. IT applications) available to users.

App :

  • has a unique short name (unique identifier)
  • has an optional description
  • has a list of scopes to notify in case a notification is targeted at the App (ex. app maintener)
  • is a scope in itself (can be used as a target for notifications)

Apps are mostly used in Site definition. Sites declare which apps they use. A notification to the app goes to the Site.

Global apps / Local apps

Global apps are defined in a toplevel section of the configuration file (under apps:). Their name doesn't have a site prefix. They can be referenced by any site with their short name.

Local apps defined either in apps: section (but with a site prefix in their name) or inside a Site entry. In that case, their named is automatically prefixed with the site name. Other sites can still reference them (notify_apps) but have to include the prefix.

App Data Model

apps:

  - name: website01
    description: Global Website 01
    # hosting site
    site: datacenter02
    notify_to: 
        - group:webmasters
        - site:datacenter02
        - jack

App example

apps:

  # global app
  - name: website01
    description: Global Website 01
    # hosting site
    site: datacenter02
    notify_to: 
        - group:webmasters
        - site:datacenter02
        - jack

   # global app : no info, to be used by sites and as a notification target
   - name: otherapp



  # explicitly local with prefix in name
  - name: site01:fileserver
    description: File server on site 01
    # hosting site
    site: site01
    notify_to: 
        - site:site01
        - group:filer_managers
        - joe


 sites:

   # locally defined (automatic prefix)
   - name: site01
     (...)
     # site field will be automatically added
     notify_apps
         - website01
     apps:
         - fileserver
         # will create app site01:fileserver

App scope: app

Scope

    app:appname
    app:site01:fileserver

Alternate names:

    a:website01
    a:site01:fileserver

Scope usage

    predefined_message:

        - name: website01_outage
          (...)
          notify_to:
            - app:website01