#Cluster Notification

Cluster Notification provides independent notification capabilities for workload clusters, supporting multiple channels and flexible configurations to ensure stable and efficient message delivery in distributed environments.

#Prerequisites

• ACP version: >= v4.2
• Plugin version: >= v1.0

#Install

#Download Plugin Package from AlaudaCloud

Login to AlaudaCloud and download the latest Alauda Container Platform Cluster Notification plugin package.

#Push the Plugin to Platform with violet

Use violet to push the Alauda Container Platform Cluster Notification plugin to platform:

violet push aiops-notification-business.ALL.vx.x.x.tgz \
  --platform-address https://<platform-address>/ \
  --platform-username <username> \
  --platform-password '<password>'

#Install via web console

1. Navigate to Administrator > Marketplace > Cluster Plugins
2. Search for Alauda Container Platform Cluster Notification and click to view its details
3. Click Install
4. Select the target cluster and confirm the installation

#Install via YAML

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  annotations:
    cpaas.io/display-name: aiops-notification-business
    cpaas.io/module-name: '{"en": "Alauda Container Platform Cluster Notification",
      "zh": "Alauda Container Platform Cluster Notification"}'
  labels:
    cpaas.io/cluster-name: <cluster-name>               # Target cluster name
    cpaas.io/module-name: aiops-notification-business
    cpaas.io/module-type: plugin
    cpaas.io/product: Platform-Center
  name: aiops-notification-<cluster-name>             # Resource name            
spec:
  version: v1.0.0                                       # Plugin version

#Upgrade

#Compatibility Matrix

The table below lists supported versions of Alauda Container Platform Cluster Notification:

#Upgrade Path Guidelines

#Patch-Level Upgrade

• Description: Cluster Notification supports patch-level upgrades within the same minor version and can be upgraded directly.
• Prerequisite: ACP version must satisfy the compatibility matrix above.
• Example: v1.0.0 -> v1.0.1

#Configure Email Service

After the plugin is installed, it does not come with any notification configuration by default. Users need to manually create the relevant YAML configuration. The configuration needs to be created in the same cluster as the plugin.

#Email Server Config

apiVersion: v1
kind: Secret
metadata:
  annotations:
  labels:
    cpaas.io/notification.server.category: Email
    cpaas.io/notification.server.type: Email
  name: platform-email-server
  namespace: cpaas-system
type: NotificationServer
data:
  displayNameEn: RW1haWw=
  displayNameZh: 6YKu5Lu2
  from: dGVzdEBleGFtcGxlLmNvbQo=
  host: bWFpbC5leGFtcGxlLmNvbQo=
  insecureSkipVerify: dHJ1ZQ==
  password: MTIzNDU2Cg==
  port: NDY1
  sslEnabled: dHJ1ZQ==
  username: dGVzdEBleGFtcGxlLmNvbQo=

#Field Descriptions

Note: All field values in the secret data must be encoded using base64. Users only need to update the information in the data section.