Skip to content

Commit 1948e5b

Browse files
authored
Merge pull request #4022 from replicatedhq/notifications-ga
[! wait to merge !] Remove Beta label from Event Notifications docs (GA)
2 parents 5c7827a + 9c24cd0 commit 1948e5b

6 files changed

Lines changed: 27 additions & 32 deletions

docs/reference/notifications-events-filters.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# Event types and filters (Beta)
1+
# Event types and filters
2+
For more information about the Event Notifications feature, see [About event notifications](/vendor/event-notifications).
23

3-
For more information about the Event Notifications (Beta) feature, see [About event notifications (Beta)](/vendor/event-notifications).
4-
5-
This topic lists the types of events supported for the Event Notifications (Beta) feature.
4+
This topic lists the types of events supported for the Event Notifications feature.
65

76
## Channel events
87

docs/vendor/event-notifications-create.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# Create event notification subscriptions (Beta)
2-
3-
This topic describes how to create event notification subscriptions in the Replicated Vendor Portal. For more information about the Event Notifications (Beta) feature, see [About event notifications (Beta)](/vendor/event-notifications).
1+
# Create event notification subscriptions
2+
This topic describes how to create event notification subscriptions in the Replicated Vendor Portal. For more information about the Event Notifications feature, see [About event notifications](/vendor/event-notifications).
43

54
## Create an event notification
65

@@ -22,15 +21,15 @@ To create an event notification subscription:
2221

2322
Subscription names can contain up to 255 ASCII characters (letters, numbers, and basic punctuation).
2423

25-
1. Select one or more event types to include in the subscription. For the full list of available event types, see [Event types and filters (Beta)](/reference/notifications-events-filters).
24+
1. Select one or more event types to include in the subscription. For the full list of available event types, see [Event types and filters](/reference/notifications-events-filters).
2625

2726
:::note
2827
Alternatively, click **Configure with AI instead**. With the AI-assisted notification builder, you can describe in natural language the events that you want to be notified about. For example, "Notify me when trial customers upload support bundles" or "Alert me when instances fall more than 3 versions behind on the Stable channel". The AI builder has context of pre-defined event types and filters, but cannot create new event types or filters.
2928
:::
3029

3130
1. (Optional) For each of the events that you selected, click the filter icon to configure event filters. Click **Done** to save the filters.
3231

33-
For more information about how the Vendor Portal uses filters to trigger notifications, see [Events and filters](/vendor/event-notifications#events-and-filters) in _About event notifications (Beta)_.
32+
For more information about how the Vendor Portal uses filters to trigger notifications, see [Events and filters](/vendor/event-notifications#events-and-filters) in _About event notifications_.
3433

3534
![Event filters](/images/notification-event-filters.png)
3635

@@ -54,9 +53,9 @@ To create an event notification subscription:
5453
- Must respond with a 2xx status code (200-299) for successful delivery
5554
- Response time must be less than five seconds
5655

57-
1. (Recommended) Enter a signing secret for HMAC signature verification. For more information, see [Verify webhook signatures](event-notifications-webhooks#verify-webhook-signatures) in _Configure and test webhooks (Beta)_.
56+
1. (Recommended) Enter a signing secret for Hash-based Message Authentication Code (HMAC) signature verification. For more information, see [Verify webhook signatures](event-notifications-webhooks#verify-webhook-signatures) in _Configure and test webhooks_.
5857

59-
1. (Optional) Expand **Advanced configuration** to add custom HTTP headers for authenticating with your endpoint (for example, `Authorization: Bearer token`). For more information, see [About adding custom HTTP headers](event-notifications-webhooks#custom-headers) in _Configure and test webhooks (Beta)_.
58+
1. (Optional) Expand **Advanced configuration** to add custom HTTP headers for authenticating with your endpoint (for example, `Authorization: Bearer token`). For more information, see [About adding custom HTTP headers](event-notifications-webhooks#custom-headers) in _Configure and test webhooks_.
6059

6160
<img alt="Webhook delivery fields" src="/images/notification-webhook-delivery.png" width="600px"/>
6261

docs/vendor/event-notifications-manage.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# Manage event notification subscriptions (Beta)
2-
3-
This topic describes how to view, edit, mute, disable, and delete event notifications in the Replicated Vendor Portal. For more information about the Event Notifications (Beta) feature, see [About event notifications (Beta)](/vendor/event-notifications).
1+
# Manage event notification subscriptions
2+
This topic describes how to view, edit, mute, disable, and delete event notifications in the Replicated Vendor Portal. For more information about the Event Notifications feature, see [About event notifications](/vendor/event-notifications).
43

54
## View notification subscriptions
65

docs/vendor/event-notifications-webhooks.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# Configure and test webhooks (Beta)
2-
3-
This topic describes how to configure and test webhooks for event notifications. For information about how to create a notification using a webhook URL, see [Create event notification subscriptions (Beta)](/vendor/event-notifications-create).
1+
# Configure and test webhooks
2+
This topic describes how to configure and test webhooks for event notifications. For information about how to create a notification using a webhook URL, see [Create event notification subscriptions](/vendor/event-notifications-create).
43

54
Webhooks allow you to receive notifications as HTTP POST requests to an endpoint you control. This enables integration with services like Slack, PagerDuty, custom monitoring systems, and other tools that support webhook integrations.
65

docs/vendor/event-notifications.mdx

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# About event notifications (Beta)
2-
3-
This topic provides an overview of the Event Notifications (Beta) feature, which allows you to set up notifications for key events from the Vendor Portal.
1+
# About event notifications
2+
This topic provides an overview of the Event Notifications feature, which allows you to set up notifications for key events from the Vendor Portal.
43

54
## Overview
65

@@ -12,7 +11,7 @@ The following shows an example of the notifications **Overview** page:
1211

1312
[View a larger version of this image](/images/notifications-overview.png)
1413

15-
The Vendor Portal queues events to Amazon Simple Queue Service (SQS) for reliable processing, and matches notifications against your custom event filters in real time. You can receive notifications through email or webhook. For information about how to create and subscribe to event notifications, see [Create event notification subscriptions (Beta)](event-notifications-create).
14+
The Vendor Portal queues events to Amazon Simple Queue Service (SQS) for reliable processing, and matches notifications against your custom event filters in real time. You can receive notifications through email or webhook. For information about how to create and subscribe to event notifications, see [Create event notification subscriptions](event-notifications-create).
1615

1716
## Events and filters
1817

@@ -22,7 +21,7 @@ This section describes the types of events and filters that are available for cr
2221

2322
You can create notifications for various types of events, including events related to application instances, customers, support bundles, releases, and channels. For example, you can get a notification when an instance reaches a Ready state in the customer environment, when the customer uploads a new support bundle, or when a customer license is expiring soon.
2423

25-
For the full list of available event types and event-specific filters, see [Event types and filters (Beta)](/reference/notifications-events-filters).
24+
For the full list of available event types and event-specific filters, see [Event types and filters](/reference/notifications-events-filters).
2625

2726
### Multi-event notifications
2827

@@ -34,7 +33,7 @@ For example, if you create a notification with both the **Release Created** and
3433

3534
You can configure a unique set of filters for each event that you add to a notification. An event must match _all_ its filters to trigger the notification (AND logic).
3635

37-
The filters available depend on the event type. All events support filtering by application name. Other common filters that apply to most event types include the channel, customer name, and license type. For more information, see [Event types and filters (Beta)](/reference/notifications-events-filters).
36+
The filters available depend on the event type. All events support filtering by application name. Other common filters that apply to most event types include the channel, customer name, and license type. For more information, see [Event types and filters](/reference/notifications-events-filters).
3837

3938
### Filters with multiple values
4039

@@ -89,21 +88,21 @@ For more information, see [Configure RBAC policies](team-management-rbac-configu
8988

9089
## Limitations
9190

92-
Event Notifications (Beta) has the following limitations:
91+
Event Notifications has the following limitations:
9392

9493
- Notification events generated are not included in the [Instance Bulk Data Export API](instance-data-export)
9594
- It is possible to create a notification for some resource types, such as customers and support bundles, but not to access the notification linked asset due to your allowed user permissions. This is most likely to impact teams with [enterprise and custom RBAC policies](team-management-rbac-configuring). For example, someone with the [Sales RBAC role](team-management-rbac-configuring) can create a notification for a customer uploading a support bundle, but does not have permission to view the linked specific customer bundle due to their RBAC role permissions.
9695
- The Release Assets Downloaded event might fire per chart or image if the customer pulls each separately as part of your installation instructions. Because release assets might be shared across many of your release versions, the Vendor Portal records the event at the chart/image level and does not associate the event with a specific release version. If you find this alert too noisy, reach out to us to further discuss your specific use case.
9796

9897
## Comparison to instance notifications (Classic)
9998

100-
Event Notifications (Beta) is the next generation of instance notification functionality in the Vendor Portal. Compared to [Instance Notifications (Classic)](instance-notifications-config), Event Notifications offers more event types, fine-grained filtering, flexible delivery routing, notification history tracking, and better access control.
99+
Event Notifications is the next generation of instance notification functionality in the Vendor Portal. Compared to [Instance Notifications (Classic)](instance-notifications-config), Event Notifications offers more event types, fine-grained filtering, flexible delivery routing, notification history tracking, and better access control.
101100

102-
You can use Event Notifications (Beta) concurrently with Instance Notifications (Classic) while you evaluate and transition.
101+
You can use Event Notifications concurrently with Instance Notifications (Classic) while you evaluate and transition.
103102

104-
The following table compares the functionality offered by Instance Notifications (Classic) and Event Notifications (Beta):
103+
The following table compares the functionality offered by Instance Notifications (Classic) and Event Notifications:
105104

106-
| Feature | Instance Notifications (Classic) | Event Notifications (Beta) |
105+
| Feature | Instance Notifications (Classic) | Event Notifications |
107106
|---------|------------------------------|---------------------------|
108107
| **Event Types** | Three event types: App Status, System Events, Custom Metrics | More than 20 event types across six categories |
109108
| **Scope** | Per-instance subscriptions | Team-wide with flexible filtering |

docs/vendor/instance-notifications-config.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import NotificationsAbout from "../partials/instance-insights/_notifications-abo
44
# Configure instance notifications (classic)
55

66
:::caution
7-
Event Notifications (Beta) replaces Instance Notifications (Classic), offering more event types, better filtering, and improved delivery options. While Instance Notifications (Classic) is still supported, Replicated recommends using Event Notifications (Beta). For more information about how to configure event notifications, see [About Event Notifications (Beta)](event-notifications).
7+
Event Notifications replaces Instance Notifications (Classic), offering more event types, better filtering, and improved delivery options. While Instance Notifications (Classic) is still supported, Replicated recommends using Event Notifications. For more information about how to configure event notifications, see [About Event Notifications](event-notifications).
88
:::
99

1010
<NotificationsAbout/>
@@ -21,7 +21,7 @@ Instance notifications can be disabled when they are no longer needed. For examp
2121

2222
## Prerequisite
2323

24-
For Slack notifications, you must configure a Slack webhook in the Vendor Portal at the Team level before you can turn on instance notifications. For more information, see [Configuring a Slack Webhook (Beta)](team-management-slack-config).
24+
For Slack notifications, you must configure a Slack webhook in the Vendor Portal at the Team level before you can turn on instance notifications. For more information, see [Configuring a Slack Webhook](team-management-slack-config).
2525

2626
For email notification, no prior configuration is required. The email address listed in your Vendor Portal account settings is used.
2727

@@ -64,6 +64,6 @@ There is a 30-second buffer between event detection and notifications being sent
6464

6565
## See also
6666

67-
- [Event Notifications (Beta)](event-notifications) - New notification system with more event types and better filtering
68-
- [Create Event Notification Subscriptions (Beta)](event-notifications-create) - Get started with Event Notifications
67+
- [Event Notifications](event-notifications) - New notification system with more event types and better filtering
68+
- [Create Event Notification Subscriptions](event-notifications-create) - Get started with Event Notifications
6969
- [Comparison: Classic vs. Event Notifications](event-notifications#comparison-to-instance-notifications-classic) - Feature comparison

0 commit comments

Comments
 (0)