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

     1  # StatusCake Configuration
     2  
     3  ## Basic
     4  The following properties need to be configured for Statuscake, in addition to the general properties listed 
     5   in the [Configuration section of the README](../README.md#configuration):
     6  
     7  | Key      | Description                                         |
     8  |----------|-----------------------------------------------------|
     9  | username | Account username for authentication with Statuscake |
    10  
    11  ## Advanced
    12  
    13  Currently additional Statuscake configurations can be added through a set of annotations to each ingress object, the current supported annotations are:
    14  
    15  |                        Annotation                        |                    Description                   |
    16  |:--------------------------------------------------------:|:------------------------------------------------:|
    17  | statuscake.monitor.stakater.com/check-rate               | Set Check Rate for the monitor (default: 300)    |
    18  | statuscake.monitor.stakater.com/test-type                | Set Test type - HTTP, TCP, PING (default: HTTP)  |
    19  | statuscake.monitor.stakater.com/paused                   | Pause the service                                |
    20  | statuscake.monitor.stakater.com/ping-url                 | Webhook for alerts                               |
    21  | statuscake.monitor.stakater.com/follow-redirect          | Enable ingress redirects                         |
    22  | statuscake.monitor.stakater.com/port                     | TCP Port                                         |
    23  | statuscake.monitor.stakater.com/trigger-rate             | Minutes to wait before sending an alert          |
    24  | statuscake.monitor.stakater.com/contact-group            | Contact Group to be alerted.                     |
    25  | statuscake.monitor.stakater.com/test-tags                | Comma separated list of tags                     |
    26  | statuscake.monitor.stakater.com/basic-auth-user          | Required for [basic-authenticationchecks](#basic-auth-checks)  |
    27  
    28  
    29  ### Basic Auth checks
    30  
    31  Statuscake supports checks completing basic auth requirements. The annotation `statuscake.monitor.stakater.com/basic-auth-user` can be used to trigger the Ingress Monitor attempting to configure this setting. The value of the annotation 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.
    32  
    33  For example; the annotation `statuscake.monitor.stakater.com/basic-auth-user: 'my-service-username'` will set the username field to the value `my-service-username` and will retrieve the password via `os.Getenv('my-service-username')` and set this appropriately. If the password is not found/set the annotation will be skipped.