CustomAlertmanager

Scope: Cluster
Version: v1alpha1

The resource for connecting additional Alertmanagers to Prometheus.

  • specobject

    Required value

    • externalobject

      Parameters for connecting an external Alertmanager.

      • addressstring

        URL of an external Alertmanager.

        Pattern: ^https?://[^\s/$.?#].[^\s]*$

        Examples:

        address: http://alerts.mycompany.com
        
        address: https://alerts.company.com
        
        address: http://192.168.1.1
        
      • authobject

        Authorization properties.

        • basicobject

          Basic authorization properties.

          • bearerTokenstring

            Bearer token authorization.

          • passwordstring

            User password.

          • usernamestring

            User name.

      • serviceobject

        Kubernetes cluster service, which leads to deployed Alertmanager.

        • namestring

          Required value

          Name of an Alertmanager service.

        • namespacestring

          Required value

          Namespace of an Alertmanager service.

        • pathstring

          URL prefix in a service to send alerts for.

          Default: "/"

      • tlsobject

        TLS settings.

        • castring

          CA cert to use.

        • certstring

          Client certificate.

        • insecureSkipVerifyboolean

          Disable certificate validation.

          Default: false

        • keystring

          Client key.

    • internalobject

      Internal Alertmanager parameters.

      • inhibitRulesarray of objects

        List of inhibition rules.

        InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing (details…).

        • equalarray of strings

          Labels that must have an equal value in the source and target alert for the inhibition to take effect.

        • sourceMatcharray of objects

          Matchers for which one or more alerts have to exist for the inhibition to take effect.

          Matcher defines how to match on alert’s labels.

          • namestring

            Required value

            Label to match.

          • regexboolean

            Whether to match on equality (false) or regular-expression (true).

          • valuestring

            Label value to match.

        • targetMatcharray of objects

          Matchers that have to be fulfilled in the alerts to be muted.

          Matcher defines how to match on alert’s labels.

          • namestring

            Required value

            Label to match.

          • regexboolean

            Whether to match on equality (false) or regular-expression (true).

          • valuestring

            Label value to match.

      • receiversarray of objects

        List of receivers.

        Receiver defines one or more notification integrations.

        • emailConfigsarray of objects

          List of Email configurations.

          EmailConfig configures notifications via Email.

          • authIdentitystring

            The identity to use for authentication.

          • authPasswordobject

            The secret’s key that contains the password to use for authentication.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • authSecretobject

            The secret’s key that contains the CRAM-MD5 secret.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • authUsernamestring

            The username to use for authentication.

          • fromstring

            The sender address.

          • headersarray of objects

            Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.

            KeyValue defines a (key, value) tuple.

            • keystring

              Required value

              Key of the tuple.

            • valuestring

              Required value

              Value of the tuple.

          • hellostring

            The hostname to identify to the SMTP server.

          • htmlstring

            The HTML body of the email notification.

          • requireTLSboolean

            The SMTP TLS requirement.

            Note that Go does not support unencrypted connections to remote SMTP endpoints.

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • smarthoststring

            The SMTP host through which emails are sent.

          • textstring

            The text body of the email notification.

          • tlsConfigobject

            TLS configuration.

            • caobject

              Struct containing the CA cert to use for the targets.

              • configMapobject

                ConfigMap containing data to use for the targets.

                • keystring

                  Required value

                  The key to select.

                • namestring

                  Name of the ConfigMap.

                • optionalboolean

                  Specify whether the ConfigMap or its key must exist.

              • secretobject

                Secret containing data to use for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • certobject

              Struct containing the client cert file for the targets.

              • configMapobject

                ConfigMap containing data to use for the targets.

                • keystring

                  Required value

                  The key to select.

                • namestring

                  Name of the ConfigMap.

                • optionalboolean

                  Specify whether the ConfigMap or its key must exist.

              • secretobject

                Secret containing data to use for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • insecureSkipVerifyboolean

              Disable target certificate validation.

            • keySecretobject

              Secret containing the client key file for the targets.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • serverNamestring

              Used to verify the hostname for the targets.

          • tostring

            The email address to send notifications to.

        • namestring

          Required value

          Name of the receiver. Must be unique across all items from the list.

        • opsgenieConfigsarray of objects

          List of OpsGenie configurations.

          OpsGenieConfig configures notifications via OpsGenie. Details…

          • apiKeyobject

            The secret’s key that contains the OpsGenie API key.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • apiURLstring

            The URL to send OpsGenie API requests to.

          • descriptionstring

            Description of the incident.

          • detailsarray of objects

            A set of arbitrary key/value pairs that provide further detail about the incident.

            • keystring

              Required value

              Key of the tuple.

            • valuestring

              Required value

              Value of the tuple.

          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • messagestring

            Alert text limited to 130 characters.

          • notestring

            Additional alert note.

          • prioritystring

            Priority level of alert. Possible values are P1, P2, P3, P4, and P5.

          • respondersarray of objects

            List of responders responsible for notifications.

            OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.

            • idstring

              ID of the responder.

            • namestring

              Name of the responder.

            • typestring

              Required value

              Type of responder.

            • usernamestring

              Username of the responder.

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • sourcestring

            Backlink to the sender of the notification.

          • tagsstring

            Comma separated list of tags attached to the notifications.

        • pagerdutyConfigsarray of objects

          List of PagerDuty configurations.

          PagerDutyConfig configures notifications via PagerDuty. Details…

          • classstring

            The class/type of the event.

          • clientstring

            Client identification.

          • clientURLstring

            Backlink to the sender of notification.

          • componentstring

            The part or component of the affected system that is broken.

          • descriptionstring

            Description of the incident.

          • detailsarray of objects

            Arbitrary key/value pairs that provide further detail about the incident.

            • keystring

              Required value

              Key of the tuple.

            • valuestring

              Required value

              Value of the tuple.

          • groupstring

            A cluster or grouping of sources.

          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • routingKeyobject

            The secret’s key that contains the PagerDuty integration key (when using Events API v2).

            Either this field or serviceKey needs to be defined.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • serviceKeyobject

            The secret’s key that contains the PagerDuty service key (when using integration type “Prometheus”).

            Either this field or routingKey needs to be defined.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • severitystring

            Severity of the incident.

          • urlstring

            The URL to send requests to.

        • pushoverConfigsarray of objects

          List of Pushover configurations.

          PushoverConfig configures notifications via Pushover. Details…

          • expirestring

            How long your notification will continue to be retried for, unless the user acknowledges the notification.

          • htmlboolean

            Whether notification message is HTML or plain text.

          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • messagestring

            Notification message.

          • prioritystring

            Priority. Details…

          • retrystring

            How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • soundstring

            The name of one of the sounds supported by device clients to override the user’s default sound choice.

          • titlestring

            Notification title.

          • tokenobject

            The secret’s key that contains the registered application’s API token (details…).

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • urlstring

            A supplementary URL shown alongside the message.

          • urlTitlestring

            A title for supplementary URL, otherwise just the URL is shown.

          • userKeyobject

            The secret’s key that contains the recipient user’s user key.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

        • slackConfigsarray of objects

          List of Slack configurations.

          Configures notifications via Slack. Details…

          • actionsarray of objects

            A list of Slack actions that are sent with each notification.

            Configures a single Slack action that is sent with each notification.

            More information here… and here.

            • confirmobject

              Protects users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. Details….

              • dismissTextstring

                The text label for the button to cancel the action.

              • okTextstring

                The text label for the button to continue with an action.

              • textstring

                Required value

                Describe in detail the consequences of the action and contextualize your button text choices.

                Use a maximum of 30 characters or so for best results across form factors.

              • titlestring

                Brief title of the pop up window.

            • namestring
            • stylestring
            • textstring

              Required value

            • typestring

              Required value

            • urlstring
            • valuestring
          • apiURLobject

            The secret’s key that contains the Slack webhook URL.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • callbackIdstring
          • channelstring

            The channel or user to send notifications to.

          • colorstring
          • fallbackstring
          • fieldsarray of objects

            A list of Slack fields that are sent with each notification.

            Configures a single Slack field that is sent with each notification.

            Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. More information…

            • shortboolean
            • titlestring

              Required value

            • valuestring

              Required value

          • footerstring
          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • iconEmojistring
          • iconURLstring
          • imageURLstring
          • linkNamesboolean
          • mrkdwnInarray of strings
          • pretextstring
          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • shortFieldsboolean
          • textstring
          • thumbURLstring
          • titlestring
          • titleLinkstring
          • usernamestring
        • victoropsConfigsarray of objects

          List of VictorOps configurations.

          VictorOpsConfig configures notifications via VictorOps. Details…

          • apiKeyobject

            The secret’s key that contains the API key to use when talking to the VictorOps API.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • apiUrlstring

            The VictorOps API URL.

          • customFieldsarray of objects

            Additional custom fields for notification.

            KeyValue defines a (key, value) tuple.

            • keystring

              Required value

              Key of the tuple.

            • valuestring

              Required value

              Value of the tuple.

          • entityDisplayNamestring

            Contains summary of the alerted problem.

          • httpConfigobject

            The HTTP client’s configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • messageTypestring

            Describes the behavior of the alert (CRITICAL, WARNING, INFO).

          • monitoringToolstring

            The monitoring tool the state message is from.

          • routingKeystring

            A key used to map the alert to a team.

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • stateMessagestring

            Contains long explanation of the alerted problem.

        • webhookConfigsarray of objects

          List of webhook configurations.

          WebhookConfig configures notifications via a generic receiver supporting the webhook payload. Details…

          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • maxAlertsinteger

            Maximum number of alerts to be sent per webhook message.

            When 0, all alerts are included.

            Allowed values: 0 <= X

          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • urlstring

            The URL to send HTTP POST requests to.

            urlSecret takes precedence over url.

            One of urlSecret and url should be defined.

          • urlSecretobject

            The secret’s key that contains the webhook URL to send HTTP requests to.

            urlSecret takes precedence over url. One of urlSecret and url should be defined.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

        • wechatConfigsarray of objects

          List of WeChat configurations.

          WeChatConfig configures notifications via WeChat. Details…

          • agentIDstring
          • apiSecretobject

            The secret’s key that contains the WeChat API key.

            The secret needs to be in the d8-monitoring namespace.

            • keystring

              Required value

              The key of the secret to select from.

            • namestring

              Name of the secret.

            • optionalboolean

              Specify whether the Secret or its key must exist.

          • apiURLstring

            The WeChat API URL.

          • corpIDstring

            The corp id for authentication.

          • httpConfigobject

            HTTP client configuration.

            • basicAuthobject

              BasicAuth for the client.

              • passwordobject

                The secret in the d8-monitoring namespace that contains the password for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • usernameobject

                The secret in the d8-monitoring namespace that contains the username for authentication.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

            • bearerTokenSecretobject

              The secret’s key that contains the bearer token to be used by the client for authentication.

              The secret needs to be in the d8-monitoring namespace.

              • keystring

                Required value

                The key of the secret to select from.

              • namestring

                Name of the secret.

              • optionalboolean

                Specify whether the Secret or its key must exist.

            • proxyURLstring

              Optional proxy URL.

            • tlsConfigobject

              TLS configuration.

              • caobject

                Struct containing the CA cert to use for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • certobject

                Struct containing the client cert file for the targets.

                • configMapobject

                  ConfigMap containing data to use for the targets.

                  • keystring

                    Required value

                    The key to select.

                  • namestring

                    Name of the ConfigMap.

                  • optionalboolean

                    Specify whether the ConfigMap or its key must exist.

                • secretobject

                  Secret containing data to use for the targets.

                  • keystring

                    Required value

                    The key of the secret to select from.

                  • namestring

                    Name of the secret.

                  • optionalboolean

                    Specify whether the Secret or its key must exist.

              • insecureSkipVerifyboolean

                Disable target certificate validation.

              • keySecretobject

                Secret containing the client key file for the targets.

                • keystring

                  Required value

                  The key of the secret to select from.

                • namestring

                  Name of the secret.

                • optionalboolean

                  Specify whether the Secret or its key must exist.

              • serverNamestring

                Used to verify the hostname for the targets.

          • messagestring

            API request data as defined by the WeChat API.

          • messageTypestring
          • sendResolvedboolean

            Whether or not to notify about resolved alerts.

          • toPartystring
          • toTagstring
          • toUserstring
      • routeobject

        The Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.

        • continueboolean

          Whether an alert should continue matching subsequent sibling nodes.

          It will always be overridden to true for the first-level route by the Prometheus operator.

        • groupByarray of strings

          List of labels to group by.

        • groupIntervalstring

          How long to wait before sending an updated notification.

          Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds, seconds, minutes, hours).

        • groupWaitstring

          How long to wait before sending the initial notification.

          Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds, seconds, minutes, hours).

        • matchersarray of objects

          List of matchers that the alert’s labels should match.

          For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.

          Matcher defines how to match on alert’s labels.

          • namestring

            Required value

            Label to match.

          • regexboolean

            Whether to match on equality (false) or regular-expression (true).

          • valuestring

            Label value to match.

        • receiverstring

          Name of the receiver for this route.

          If not empty, it should be listed in the receivers field.

        • repeatIntervalstring

          How long to wait before repeating the last notification.

          Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds, seconds, minutes, hours).

        • routesarray

          Child routes.

    • typestring

      Type of the Alertmanager.

      Allowed values: External, Internal

CustomPrometheusRules

Scope: Cluster

Resource to store PrometheusRule. Details….

  • specobject

    Required value

    • groupsarray of objects

      Required value

      Alert group description.

      The structure of the groups is similar to that of prometheus-operator.

      RuleGroup is a list of sequentially evaluated recording and alerting rules.

      • intervalstring
      • namestring

        Required value

      • rulesarray of objects

        Required value

        • alertstring
        • annotationsobject
        • exprinteger or string

          Required value

        • forstring
        • labelsobject
        • recordstring

Resource to store PrometheusRule. Details….

  • specobject

    Required value

    • groupsarray of objects

      Required value

      Alert group description.

      The structure of the groups is similar to that of prometheus-operator.

      RuleGroup is a list of sequentially evaluated recording and alerting rules.

      • intervalstring
      • namestring

        Required value

      • rulesarray of objects

        Required value

        • alertstring
        • annotationsobject
        • exprinteger or string

          Required value

        • forstring
        • labelsobject
        • recordstring

GrafanaAdditionalDatasource

Scope: Cluster

The resource for connecting additional datasources to Grafana.

The resource parameters are described in details in the Grafana documentation.

  • specobject

    Required value

    • accessstring

      Required value

      Access mode.

      Allowed values: Proxy, Direct

    • basicAuthboolean

      Enable/disable basic auth.

    • basicAuthUserstring

      Basic auth username.

    • databasestring

      Database name (if used).

    • jsonDataobject

      Fields to be converted to JSON and stored in jsonData.

    • secureJsonDataobject

      JSON-data object to be saved encrypted.

    • typestring

      Required value

      Datasource type.

    • urlstring

      Datasource URL.

      Example:

      url: http://localhost:8080
      
    • userstring

      Database username.

    • withCredentialsboolean

      Enable/disable with credentials headers (details…).

The resource for connecting additional datasources to Grafana.

The resource parameters are described in details in the Grafana documentation.

  • specobject

    Required value

    • accessstring

      Required value

      Access mode.

      Allowed values: proxy, direct

    • basicAuthboolean

      Enable/disable basic auth.

    • basicAuthUserstring

      Basic auth username.

    • databasestring

      Database name (if used).

    • jsonDataobject

      Fields to be converted to JSON and stored in jsonData.

    • secureJsonDataobject

      JSON-data object to be saved encrypted.

    • typestring

      Required value

      Datasource type.

    • urlstring

      Datasource URL.

      Example:

      url: http://localhost:8080
      
    • userstring

      Database username.

    • withCredentialsboolean

      Enable/disable with credentials headers (details…).

GrafanaAlertsChannel

Scope: Cluster
Version: v1alpha1

The resource for adding alert notification channels to Grafana.

  • specobject

    Required value

    • alertManagerobject

      Required value

      Alert manager settings.

      • addressstring

        Required value

        URL of an external Alertmanager.

        Pattern: ^https?://[^\s/$.?#].[^\s]*$

        Examples:

        address: http://alerts.mycompany.com
        
        address: https://alerts.company.com
        
        address: http://192.168.1.1
        
      • authobject

        Authorization properties.

        • basicobject

          Required value

          Basic authorization properties.

          • passwordstring

            Required value

            Password.

          • usernamestring

            Required value

            User name.

    • descriptionstring

      Small and optional description about this alerts channel.

      Default: ""

    • disableResolveMessageboolean

      When true, this option disables the resolve message [OK] that is sent when the alerting state returns to false.

      Default: false

    • isDefaultboolean

      Use this notification channel for all alerts.

      Default: false

    • typestring

      Required value

      Allowed values: PrometheusAlertManager

GrafanaDashboardDefinition

Scope: Cluster

The resource for storing and managing Grafana Dashboards

  • specobject

    Required value

    • definitionstring

      Required value

      The dashboard’s JSON manifest.

      Caution! Make sure that there is no “local” id (at the .id address) in the manifest in addition to the uid.

      Pattern: ^[ \t\n]*\{(.|\n)*\}[ \t\n]*$

    • folderstring

      Required value

      What folder to use for a dashboard. If the folder does not exist, it will be created.

      Example:

      folder: My Folder
      

The resource for storing and managing Grafana Dashboards

  • specobject

    Required value

    • definitionstring

      Required value

      The dashboard’s JSON manifest.

      Caution! Make sure that there is no “local” id (at the .id address) in the manifest in addition to the uid.

      Pattern: ^[ \t\n]*\{(.|\n)*\}[ \t\n]*$

    • folderstring

      Required value

      What folder to use for a dashboard. If the folder does not exist, it will be created.

      Example:

      folder: My Folder
      

PrometheusRemoteWrite

Scope: Cluster

Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).

A cluster can have any number of such resources.

  • specobject

    Required value

    • basicAuthobject

      BasicAuth for the URL.

      • passwordstring

        Required value

        Password for the authentication.

      • usernamestring

        Required value

        Username for the authentication.

    • bearerTokenstring

      Bearer token.

    • customAuthTokenstring

      Custom token sent as a value of the X-Auth-Token header.

    • tlsConfigobject

      TLS Config to use for remote write.

      • insecureSkipVerifyboolean

        Disable target certificate validation.

        Default: false

    • urlstring

      Required value

      The URL of the endpoint to send samples to.

      Example:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • writeRelabelConfigsarray of objects

      The list of remote write relabel configurations.

      For example, if you need to remove unnecessary metrics or perform data relabeling.

      • actionstring

        Action to perform based on regex matching.

        Default: "replace"

      • modulusinteger

        Modulus to take of the hash of the source label values.

      • regexstring

        Regular expression against which the extracted value is matched. Default is ‘(.*)’

        Default: "(.*)"

      • replacementstring

        Replacement value against which a regex replace is performed if the regular expression matches.

        Regex capture groups are available.

        Default: "$1"

      • separatorstring

        Separator placed between concatenated source label values.

        Default: ";"

      • sourceLabelsarray of strings

        The source labels select values from existing labels.

        Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.

      • targetLabelstring

        Label to which the resulting value is written in a replace action. It is mandatory for replace actions.

        Regex capture groups are available.

Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).

A cluster can have any number of such resources.

  • specobject

    Required value

    • basicAuthobject

      BasicAuth for the URL.

      • passwordstring

        Required value

        Password for the authentication.

      • usernamestring

        Required value

        Username for the authentication.

    • bearerTokenstring

      Bearer token.

    • customAuthTokenstring

      Custom token sent as a value of the X-Auth-Token header.

    • tlsConfigobject

      TLS Config to use for remote write.

      • insecureSkipVerifyboolean

        Disable target certificate validation.

        Default: false

    • urlstring

      Required value

      The URL of the endpoint to send samples to.

      Example:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • writeRelabelConfigsarray of objects

      The list of remote write relabel configurations.

      For example, if you need to remove unnecessary metrics or perform data relabeling.

      • actionstring

        Action to perform based on regex matching.

        Default: "replace"

      • modulusinteger

        Modulus to take of the hash of the source label values.

      • regexstring

        Regular expression against which the extracted value is matched. Default is ‘(.*)’

        Default: "(.*)"

      • replacementstring

        Replacement value against which a regex replace is performed if the regular expression matches.

        Regex capture groups are available.

        Default: "$1"

      • separatorstring

        Separator placed between concatenated source label values.

        Default: ";"

      • sourceLabelsarray of strings

        The source labels select values from existing labels.

        Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.

      • targetLabelstring

        Label to which the resulting value is written in a replace action. It is mandatory for replace actions.

        Regex capture groups are available.