Support and Documentation

Integrations

Ops Desk ingests events from a variety of services that monitor resources. Referring to the illustration Typical Ops Desk topology, Ops Desk ingests events from PagerDuty, Travis CI, and server logs—all of which are monitoring three servers. To enable ingestion from services, you must integrate them with Ops Desk.

Adding an integration

This section describes how to integrate a most services into Ops Desk. For integrating an AWS service, see Adding an AWS integration.

Procedure. To integrate a service with Ops Desk:

  1. Obtain or generate the credentials for the service you want to integrate. See the table Creating a service's credentials for Ops Desk access for guidelines.

  2. In the left panel, click |mi-settings|.

  3. Click Integrations. The Integrations widget appears.

  4. For the service you want to integrate, do the following:

    1. Under Available click |mi-add_circle|. An integration widget appears.

    2. Enter the credentials you obtained in step 1.

    3. Click Done.

    4. Close the Integration widget.

The integration appears under Installed. You can now associate the integration with individual projects; for details, see Creating a project or Editing a project.

The following table provides the high-level steps for configuring the required Ops Desk permissions.

Table 103. Creating a service's credentials for Ops Desk access

Service

Configuration guideline

Google Cloud

In the GCP console—

  1. Create or view an existing service account.

  2. Create new keys for the service account in JSON format.

  3. Open the JSON file to saved to your computer, and enter the values in the New Google Cloud Platform Integration widget.

Azure

In the Azure console, or from the command line with the az client—

  1. Create a service principal object.

  2. Open the credentials file saved to your computer, and enter the values in the New Azure Integration widget.

Pingdom

  1. Obtain the API token for your Pingdom webhook.

  2. Enter the token in the New Pingdom Integration widget.

PagerDuty

  1. Obtain the API key for your PagerDuty webhook.

  2. Compose a list of masks used to retrieve entries from the PagerDuty log. The masks typically include field and a regular expression for the field's value. Log entries that have a field whose value matches the regular expression are ingested into Ops Desk.

  3. Enter the list of masks in the New PagerDuty Integration widget.

Travis CI

In the Travis CI console—

  1. Generate public and private tokens for the repository you want to integrate.

  2. Enter the tokens in the New Travis CI Integration widget.

Slack

Obtain the bot token for the channel you want to monitor, and enter it in the New Slack Integration widget.

Cloud Resources

  1. Determine which resources you want to include in the listing of instances.

  2. Enter those resources in the New Cloud Resources Integration widget.



Adding an AWS integration

This section describes how to integrate an AWS service into Ops Desk. For integrating all other services, see Adding an integration.

Procedure. To integrate a service with Ops Desk:

  1. In Ops Desk, do the following:

    1. In the left panel, click |mi-settings|.

    2. Click Integrations. The Integrations widget appears.

    3. Under Available, in Amazon Web Services, click |mi-add_circle|. An integration widget appears.

    4. In the Name field, enter a name for the integration.

    5. From the Credentials list, select Aws Assume Role Credentials.

    6. Copy the value in the field External ID into a text editor.

  2. In the AWS Console, do the following:

    1. Under IAM, click Roles.

    2. Click Create role.

    3. For the type of trusted entity, select Another AWS Account. The Specify accounts that can use this role widget appears.

    4. In the Account ID field, enter 074158061309.

    5. Mark Require external ID. An External ID field appears.

    6. In the External ID field, paste the ID you copied in step 1.f, above.

    7. Click Next.

    8. Assign the role the permission AdministratorAccess.

    9. Name the role ops-desk.

    10. Create the role.

    11. Copy the account ID, region, and session duration into a text editor.

  3. Returning to New Amazon Web Services Integration widget in Ops Desk, do the following:

    1. In the Session Duration field, paste the session duration from step 2.k.

    2. In the Credentials Region list, select the region from step 2.k.

    3. In the Account ID field, paste the account ID from step 2.k.

    4. In the Role Name field, enter ops-desk.

    5. Click Done.

    6. Close the Integration widget.

The integration appears under Installed. You can now associate the integration with individual projects; for details, see Creating a project or Editing a project.

Modifying an integration

Procedure. To modify an integrated service:

  1. In the left panel, click |mi-settings|.

  2. Click Integrations. The Integrations widget appears.

  3. For the service you want to modify, do the following:

    1. Under Installed, click |mi-more_horiz|, and then click Settings. An integration widget appears.

    2. Modify the credentials as required. For information about creating a service's credentials, see the table Creating a service's credentials for Ops Desk access.

    3. Click Done.

    4. Close the Integration widget.

Disabling or deleting an integration

When you disable or delete an integration, Ops Desk no longer ingests events from the corresponding service.

Procedure. To disable or delete an integration:

  1. In the left panel, click |mi-settings|.

  2. Click Integrations. The Integrations widget appears.

  3. For the service you want to disable or delete, do the following:

    1. Click |mi-more_horiz|.

    2. Select Disable or Delete.