github.com/stakater/IngressMonitorController@v1.0.103/docs/pingdom-configuration.md (about)

     1  # Pingdom Configuration
     2  
     3  ## Note
     4  Currently we do not have access to Pingdom account that's why Tests are not verified. Community members having Pingdom account are welcome to contribute in Test Cases.
     5  
     6  ## Basic
     7  The following properties need to be configured for Pingdom, in addition to the general properties listed
     8  in the [Configuration section of the README](../README.md#configuration):
     9  
    10  | Key      | Description                                      |
    11  |----------|--------------------------------------------------|
    12  | apiToken | Your generated Pingdom API Token                 |
    13  
    14  ## Optional
    15  The following optional property can be included for Pingdom accounts which require multi-user authentication.
    16  More information can be found [Here](https://www.pingdom.com/api/2.1/#multi-user+authentication)
    17  
    18  | Key               | Description                                              |
    19  |-------------------|----------------------------------------------------------|
    20  | alertContact      | `-` separated contact Ids                                |
    21  | alertIntegrations | Comma separated list of integration ids                  |
    22  
    23  ## Advanced
    24  
    25  Currently additional pingdom configurations can be added through a set of annotations to each ingress object, the current supported annotations are:
    26  
    27  |                        Annotation                        |                    Description                   |
    28  |:--------------------------------------------------------:|:------------------------------------------------:|
    29  | pingdom.monitor.stakater.com/resolution                  | The pingdom check interval in minutes            |
    30  | pingdom.monitor.stakater.com/send-notification-when-down | How many failed check attempts before notifying  |
    31  | pingdom.monitor.stakater.com/paused                      | Set to "true" to pause checks                    |
    32  | pingdom.monitor.stakater.com/notify-when-back-up         | Set to "false" to disable recovery notifications |
    33  | pingdom.monitor.stakater.com/request-headers             | Custom pingdom request headers (e.g. {"Accept"="application/json"}) |
    34  | pingdom.monitor.stakater.com/basic-auth-user             | Required for basic-authentication checks - [see below](#basic-auth-checks) |
    35  | pingdom.monitor.stakater.com/should-contain              | Set to text string that has to be present in the HTML code of the page (configures "Should contain") |
    36  | pingdom.monitor.stakater.com/tags                        | Comma separated set of tags to apply to check (e.g. "testing,aws") |
    37  | pingdom.monitor.stakater.com/alert-integrations                | `-` separated set list of integrations ids (e.g. "91166-12168") |
    38  | pingdom.monitor.stakater.com/alert-contacts                | `-` separated contact id's (e.g. "1234567_8_9-9876543_2_1") to override the [default alertContacts](https://github.com/stakater/IngressMonitorController/blob/master/README.md#usage)|
    39  
    40  ### Basic Auth checks
    41  
    42  Pingdom supports checks completing basic auth requirements. The annotation `pingdom.monitor.stakater.com/basic-auth-user` can be used to trigger the Ingress Monitor attempting to configure this setting. The value of the anotation should be the username to be configured. The Ingress Monitor Controller will then attempt to access an OS env variable of the same name which will return the password that should be used. The env variable can be mounted within the Ingress Monitor Controller container via a secret.
    43  
    44  For example; the annotation `pingdom.monitor.stakater.com/basic-auth-user: 'health-service'` will set the username field to 'health-service' and will retrieve the password via `os.Getenv('health-service')` and set this appropriately.