Configure email integration for OSS manually

Configure email integration for OSS manuallyΒΆ

Warning

The DevOps Portal has been deprecated in the Q4`18 MCP release tagged with the 2019.2.0 Build ID.

Note

Configuring notifications through the Push Notification service is deprecated. Mirantis recommends that you configure Alertmanager-based notifications as described in MCP Operations Guide: Enable Alertmanager notifications.

The Push Notification service can route notifications based on the alarms triggered by the issues that are found by Prometheus Alertmanager through email.

Warning

This section describes how to manually configure the Push Notification service Reclass metadata to integrate email routing for notifications in an existing OSS deployment. Therefore, if you want to configure the email routing configuration, perform the procedure below.

Otherwise, if you are performing the initial deployment of your MCP environment, you should have already configured your deployment model with the default Simple Mail Transfer Protocol (SMTP) parameters for the Push Notification service as described in OSS parameters and the OSS webhook parameters as described in StackLight LMA product parameters. In this case, skip this section.

Note

The Push Notification service only routes the received notifications to email recipients. Therefore, you must also provide the Prometheus Alertmanager service with a predefined alert template containing an email handler as described in MCP Operations Guide: Enable notifications through the Push Notification service.

To configure email integration for OSS manually:

  1. Obtain the following data:

    • pushkin_smtp_host

      SMTP server host for email routing. Gmail server host is used by default (smtp.gmail.com).

    • pushkin_smtp_port

      SMTP server port for email routing. Gmail server port is used by default (587).

    • webhook_from

      Source email address for notifications sending.

    • pushkin_email_sender_password

      Source email password for notifications sending.

    • webhook_recipients

      Comma-separated list of notification recipients.

  2. Verify that the following services are properly configured and deployed:

    • Elasticsearch

    • PostgreSQL

    Note

    For the configuration and deployment details, see:

  3. In the /srv/salt/reclass/classes/cluster/${_param:cluster_name}/oss/server.yml file, define the following parameters:

    parameters:
      _param:
        pushkin_smtp_host: smtp.gmail.com
        pushkin_smtp_port: 587
        webhook_from: your_sender@mail.com
        pushkin_email_sender_password: your_sender_password
        webhook_recipients: "recepient1@mail.com,recepient2@mail.com"
    
  4. Push all changes of the model to the dedicated project repository.

  5. Refresh pillars and synchronize Salt modules:

    salt '*' saltutil.refresh_pillar
    salt '*' saltutil.sync_modules
    
  6. If you have the running pushkin docker stack, remove it and apply the following Salt states:

    salt -C 'I@docker:swarm:role:master' state.sls docker.client