netdata/health/notifications/kavenegar/metadata.yaml

# yamllint disable rule:line-length
---
- id: 'notify-kavenegar'
  meta:
    name: 'Kavenegar'
    link: 'https://kavenegar.com/'
    categories:
      - notify.agent
    icon_filename: 'kavenegar.png'
  keywords:
    - Kavenegar
  overview:
    notification_description: |
      [Kavenegar](https://kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs.
      You can send notifications to Kavenegar using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
    notification_limitations: ''
  setup:
    prerequisites:
      list:
        - title: ''
          description: |
            - The APIKEY and Sender from http://panel.kavenegar.com/client/setting/account
            - Access to the terminal where Netdata Agent is running
    configuration:
      file:
        name: 'health_alarm_notify.conf'
      options:
        description: 'The following options can be defined for this notification'
        folding:
          title: 'Config Options'
          enabled: true
        list:
          - name: 'SEND_KAVENEGAR'
            default_value: 'YES'
            description: "Set `SEND_KAVENEGAR` to YES"
            required: true
          - name: 'KAVENEGAR_API_KEY'
            default_value: ''
            description: "Set `KAVENEGAR_API_KEY` to your API key."
            required: true
          - name: 'KAVENEGAR_SENDER'
            default_value: ''
            description: "Set `KAVENEGAR_SENDER` to the value of your Sender."
            required: true
          - name: 'DEFAULT_RECIPIENT_KAVENEGAR'
            default_value: ''
            description: "Set `DEFAULT_RECIPIENT_KAVENEGAR` to the SMS recipient you want the alert notifications to be sent to. You can define multiple recipients like this: 09155555555 09177777777."
            required: true
            detailed_description: |
              All roles will default to this variable if lest unconfigured.

              You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file:
              ```conf
              role_recipients_kavenegar[sysadmin]="09100000000"
              role_recipients_kavenegar[domainadmin]="09111111111"
              role_recipients_kavenegar[dba]="0922222222"
              role_recipients_kavenegar[webmaster]="0933333333"
              role_recipients_kavenegar[proxyadmin]="0944444444"
              role_recipients_kavenegar[sitemgr]="0955555555"
              ```

              The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option.
      examples:
        folding:
          enabled: true
          title: ''
        list:
          - name: 'Basic Configuration'
            folding:
              enabled: false
            description: ''
            config: |
              #------------------------------------------------------------------------------
              # Kavenegar (Kavenegar.com) SMS options

              SEND_KAVENEGAR="YES"
              KAVENEGAR_API_KEY="XXXXXXXXXXXX"
              KAVENEGAR_SENDER="YYYYYYYY"
              DEFAULT_RECIPIENT_KAVENEGAR="0912345678"
  troubleshooting:
    problems:
      list: []