Enabling event notifications for IBM® Storage Ceph® as a Service

As an administrator of IBM® Storage Ceph® as a Service, you might want to send notifications of events in IBM Storage Ceph as a Service to other users, or human destinations, by using email, SMS, or other supported delivery channels. Additionally, you might want to send these notifications of events to other applications to build logic by using event-driven programming using webhooks, for example. This is made possible by the integration between IBM® Storage Ceph® as a Service and IBM Cloud Event Notifications.

To send information to Event Notifications, you must connect your IBM Storage Ceph as a Service instance to Event Notifications. For more information about working with Event Notifications, see Getting started with Event Notifications.

How events are collected and sent by IBM® Storage Ceph® as a Service

When an event of interest takes place in your IBM Storage Ceph as a Service instance, IBM Storage Ceph as a Service communicates with a connected Event Notifications instance to forward a notification to a supported destination.

Events for IBM® Storage Ceph® as a Service

The following table lists the IBM Storage Ceph as a Service events.

Actions that generate event notifications
Event name Event type Subtype name Subtype Severity
IBM Storage Ceph as a Service Storage Capacity com.ibm.cloud.software-defined-storage.capacity Allocated block storage at 50% of capacity block_capacity_50_percent low
Allocated block storage at 80% of capacity block_capacity_80_percent medium
Allocated block storage at 100% of capacity block_capacity_100_percent high
Allocated object storage at 50% of capacity object_capacity_50_percent low
Allocated object storage at 80% of capacity object_capacity_80_percent medium
Allocated object storage at 100% of capacity object_capacity_100_percent high
IBM Storage Ceph as a Service S3 Certificates com.ibm.cloud.software-defined-storage.s3-certificate S3 certificate has expired s3_cert_expired high
S3 certificate will expire in 1 day s3_cert_expire_1_day high
S3 certificate will expire in 10 days s3_cert_expire_10_day high
S3 certificate will expire in 30 days s3_cert_expire_30_day medium
S3 certificate will expire in 60 days s3_cert_expire_60_day medium
S3 certificate will expire in 90 days s3_cert_expire_90_day low

Enabling notifications

Events that are generated by an instance of the IBM Storage Ceph as a Service can be forwarded to an Event Notifications service instance that is available in the same account. You can configure only one IBM Storage Ceph as a Service instance to one Event Notifications service instance.

Connecting to Event Notifications in the console

Before you can enable notifications for IBM Storage Ceph as a Service, be sure that you have an Event Notifications service instance that is in the same account as your IBM Storage Ceph as a Service instance. Then, you can use the Settings > Event Notifications section in the IBM Storage Ceph as a Service UI to connect the services.

  1. In the console, click the Navigation Menu icon Navigation Menu icon > Resource list.

  2. Select your instance of IBM Storage Ceph as a Service.

  3. In the IBM Storage Ceph as a Service navigation, click Settings.

  4. In the Event Notifications section, click Connect.

  5. Review the source details for the connection. Optionally, provide a description.

  6. Select the resource group and Event Notifications service instance that you want to connect.

    If an IAM authorization between IBM Storage Ceph as a Service and Event Notifications doesn't exist in your account, a dialog is displayed. Follow the prompts to grant access between the services.

    1. To grant access between IBM Storage Ceph as a Service and Event Notifications, click Authorize.
    2. Select Event Notifications as the target service.
    3. From the list of instances, select the Event Notifications service instance that you want to authorize.
    4. Select the Event Source Manager role.
    5. Click Review.
    6. Click Assign.

  7. To confirm the connection, click Connect.

Delivering notifications to select destinations

After you enable notifications for IBM Storage Ceph as a Service, create topics and subscriptions in Event Notifications so that alerts can be forwarded and delivered to your selected destinations.

For a complete list of supported destinations, see the Event Notifications documentation.

Email notifications

You can use the IBM Cloud email service as a delivery channel for IBM Storage Ceph as a Service event notifications. Create an Event Notifications subscription between an existing topic and the IBM Cloud email service to forward your alerts to various recipients by email.

An email from IBM Cloud that contains information about IBM Storage Ceph as a Service event resembles the following example:

Subject: Replace S3 certificate (expires in 90 days)

Body: S3 certificate will expire in 90 days. Please replace your S3 certificate.

To receive detailed information about an event notification in your email, select the Add notification payload option when you create an Event Notifications subscription. Your email displays the notification payload details that are associated with the event.

Webhooks

You can configure a webhook destination so that an incoming notification can be consumed programmatically by an app or service. For more information about setting up webhooks, check out the Event Notifications documentation.

Notification payload details

Successful events that are generated by IBM Storage Ceph as a Service contain various fields that help you to identify the source and details of an event.

Event notifications from IBM Storage Ceph as a Service contain only metadata properties, such as names or identifiers of resources. Sensitive data, for example API keys or passwords, are not included in generated events.

The properties that are sent to Event Notifications vary depending on the event type. For example, if an S3 certificate expiration event takes place, IBM Storage Ceph as a Service sends a notification payload to Event Notifications that is similar to the following example.

{
    "ibmendefaultlong": "S3 certificate will expire in 90 days. Please replace your S3 certificate.",
    "ibmendefaultshort": "Replace S3 certificate (expires 90 days)",
    "ibmenseverity": "low",
    "ibmensourceid": "crn:v1:staging:public:software-defined-storage:satloc_dal_crmid4v20tl6u8usf790:a/3faf73b8d12b47fa6ce87494f8ae7686:0c81f602-5142-4809-9e42-31de8453416a::",
    "id": "38eb4721-db9b-4ba6-a5e7-cdd9cce66763",
    "source": "crn:v1:staging:public:software-defined-storage:satloc_dal_crmid4v20tl6u8usf790:a/3faf73b8d12b47fa6ce87494f8ae7686:0c81f602-5142-4809-9e42-31de8453416a::",
    "specversion": "1.0",
    "time": "2025-04-23T21:13:44.301Z",
    "type": "com.ibm.cloud.software-defined-storage.s3-certificate:s3_cert_expire_90_day"
}

Review the following table for more information about event notification properties.

Properties in an event notification payload
Property Description
ibmendefaultlong This message is used in case the event that is routed to a destination that needs a human readable text, but a destination-specific attribute is not specified.
ibmendefaultshort This message is used in case the event that is routed to a destination that needs a human readable text, but a destination-specific attribute is not specified.
ibmenseverity The severity of the event.
ibmensourceid This is the ID of the source that is created in Event Notifications. This is available in the Event Notifications UI in the "Sources" section.
id A unique identifier that identifies each event.
source This is the identifier of the event producer (that is, the IBM Storage Ceph as a Service CRN).
specversion It is the version of the Cloud Events specification that Event Notifications currently supports. This value must be set to "1.0".
time UTC timestamp when the event occurred. Must be in the RFC 3339 format.
type This describes the type of event. It is of the form <event-type-name>:<sub-type>.