Integrations

Manages ClusterControl integration modules. Starting from version 1.5.0, there are two modules available:

• 3rd Party Notifications via clustercontrol-notifications package.
• Cloud Provider integration via clustercontrol-cloud and clustercontrol-clud packages.

3^rd Party Notifications

Configures third-party notifications on events triggered by ClusterControl. allowing users to integrate ClusterControl into your company’s communication channels, incident response systems, and workflow applications. To prevent users from receiving too many notifications, ClusterControl integrations also allow users to send out only specific critical alerts or warnings (see Warning Events and Critical Events).

Supported services are:

Note that events are only created when either of the following occurred:

• Alarm created
• Alarm ended

Thus, if you already have alarms raised and then you create, for example, a Slack (or any other) integration, you will never see events for the alarms already raised/created before you created the Slack integration. You will only see alarms created after the integration.

Warning Events

Critical Events

Webhook Integrations

For webhook integrations, ClusterControl will raise an alarm by sending the JSON data using the HTTP POST method to the configured endpoint. The webhook endpoint should receive the following example event if a new alarm is created:

{
  "id": 470,
  "status": "CREATED",
  "component": "Node",
  "hostname": "192.168.20.62",
  "title": "Server disconnected",
  "message": "PostgreSQL server on 192.168.20.62:5432 disconnected: Connect failure: Watchdog: Failed connection to [email protected]:5432. timeout expired\n",
  "recommendation": "Check node status on UI and error log of failed server.",
  "severity": "CRITICAL"
}

The above event was created and sent out to the webhook endpoint after ClusterControl has detected that one of our database servers (192.168.20.62) was down. After the server came back online, ClusterControl would then send another event with the same alarm ID (470) with a different status “ENDED”, indicating the above alarm has ended and the node is back operational:

{
  "id": 470,
  "status": "ENDED",
  "component": "Node",
  "hostname": "192.168.20.62",
  "title": "Server disconnected",
  "message": "PostgreSQL server on 192.168.20.62:5432 disconnected: Connect failure: Watchdog: Failed connection to [email protected]:5432. timeout expired\n",
  "recommendation": "Check node status on UI and error log of failed server.",
  "severity": "CRITICAL"
}

Commonly, the “ended” event has an almost identical response text with the “created” event except for the “status” value.

Cloud Providers

Manages resources and credentials for cloud providers. Note that this new feature requires two modules called clustercontrol-cloud and clustercontrol-clud. The former is a helper daemon that extends CMON’s capability of cloud communication, while the latter is a file manager client to upload and download files on cloud instances. Both packages are dependencies of the clustercontrol UI package, which will be installed automatically if does not exist.

The credentials that have been set up here can be used to:

• Manage cloud resources (instances, virtual network, subnet)
• Deploy databases in the cloud
• Upload backup to cloud storage

To create a cloud profile, click on Add Cloud Credentials and follow the wizard accordingly. Supported cloud providers are:

• Amazon Web Service
• Google Cloud Platform
• Microsoft Azure

Amazon Web Services Credential

The stored AWS credential will be used by ClusterControl to list out Amazon EC2 instances, spin new instances when deploying a cluster, and upload/download backups to AWS S3.

To create an access key for your AWS account root user:

1. Use your AWS account email address and password to sign in to the AWS Management Console as the AWS account root user.
2. On the IAM Dashboard page, choose your account name in the navigation bar, and then choose My Security Credentials.
3. If you see a warning about accessing the security credentials for your AWS account, choose to Continue to Security Credentials.
4. Expand the Access keys (access key ID and secret access key) section.
5. Choose Create New Access Key. Then choose Download Key File to save the access key ID and secret access key to a file on your computer. After you close the dialog box, you can’t retrieve this secret access key again.

AWS Instances

Lists out your AWS instances. You can perform simple AWS instance management tasks directly from ClusterControl, which uses your defined AWS credentials to connect to the AWS API.

AWS VPC

This allows you to conveniently manage your VPC from ClusterControl, which uses your defined AWS credentials to connect to AWS VPC. Most of the functionalities are dynamically populated and integrated to have the same look and feel as the AWS VPC console. Thus, you may refer to the VPC User Guide for details on how to manage AWS VPC.

Google Cloud Platform Credentials

To create a service account:

1. Open the Service Accounts page in the Cloud Platform Console.
2. Select your project and click Continue.
3. In the left navigation, click Service accounts.
4. Look for the service account for which you wish to create a key, click on the vertical ellipses button in that row, and click Create key.
5. Select JSON as the Key type and click Create

Microsoft Azure Credentials

In order to provide access to Azure services, you need to register an application and grant it access to your Azure resources.

1. Create an application:
   1. log in to Microsoft Azure portal → Azure Active Directory → App registrations → New application registration.
   2. Provide a name and URL for the application. Select “Web app / API” for the type of application you want to create.
   3. After specifying the values, click Create.
2. Get application ID and authentication key:
   1. From App registrations in Azure Active Directory, select your application.
   2. Copy the Application ID. You should pass that value as application_id.
   3. To generate an authentication key, select Manage → Certificates & secrets → New client secret.
   4. Provide a description of the key and a duration for the key. When done, select Save.
   5. After saving the key, the value of the key is displayed. Copy this value because you are not able to retrieve the key later. Pass this value as client_secret.
3. Get tenant ID:
   1. Go to Microsoft Azure portal → Azure Active Directory → Properties for your Azure AD tenant.
   2. Copy the Directory ID. Pass this value as tenant_id.
4. Get subscription ID:
   1.Go to Microsoft Azure portal → Subscriptions.
   2. Select your subscription from the list.
   3. Copy the Subscription ID. Pass this value as subscription_id.
5. Create a resource group:
   1. Go to Microsoft Azure portal → Resource groups → Add.
   2.Fill in the values and click Create.
   3. Copy the Resource group name and use it as resource_group in the credentials.
   4. Wait until the Resource group is created and click Go to Resource group → Access control (IAM) → Add → Add Role Assignment.
   5. Select Contributor as a Role then put your application’s name into search input and select it from the list.
   6. Click Save.
6. Create a storage account (for Upload Backup to Cloud feature):
   1. Go to Microsoft Azure portal → Storage accounts → Add.
   2. Fill in the Name and select Blob storage as Account kind.
   3. Copy the Name value and use it as storage_account in credentials.
   4. Select Enabled for Secure transfer required, select Subscription and Resource group (use the same Resource group as in the previous steps).
   5. Select the storage Location and then click Create.

Finally, create a new text file on your workstation and copy all the required information retrieved from the previous steps in a JSON format. For example:

{
  "application_id":"7f649053-xxxx-xxxx-xxxx-2179c1fa83b8",
  "client_secret":"jbzW9tj4AyXHDkfO/KoTL9OP5EexpD6jeHROo2S4xxxx",
  "tenant_id":"ce6b8358-xxxx-xxxx-xxxx-49b8c7a5cbc2",
  "subscription_id":"6fafe95c-xxxx-xxxx-xxxx-1c33daa1c2c3",
  "resource_group":"cc",
  "storage_account":"mybackupazure"
}

Then, when configuring the Azure credentials, load the above text file under Read from JSON field. Take note that storage_account value is optional.

The uploaded backup will be available under BLOB CONTAINERS storage. You can verify its existence in the cloud by going to Microsoft Azure portal → Storage Accounts → [your storage account] → Storage Explorer → BLOB CONTAINERS.

S3-Compatible Storage Provider Credentials

ClusterControl 1.9.0 introduces support for any cloud storage provider that supports AWS’s S3-compatible object storage API.