https://github.com/tmax-cloud/alarm-operator
https://github.com/tmax-cloud/alarm-operator
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmax-cloud/alarm-operator
- Owner: tmax-cloud
- Created: 2021-03-10T06:45:49.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-02T00:59:37.000Z (almost 5 years ago)
- Last Synced: 2025-10-28T08:13:43.187Z (9 months ago)
- Language: Go
- Size: 216 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alarm Operator
Alarm-operator provides notification mechanism based on kubernetes.
## Prerequisites
* go version v1.15.7+.
* kubectl version v1.18.6+.
* Access to a Kubernetes v1.19.4+ cluster.
## Getting started
### Installation
1. Build notifier server and push to your registry
```bash
export REG=
make docker-build
make docker-push
```
2. Install operator
```bash
make install && make deploy
```
### Generate Notification resource and Test notification endpoint
1. Generate SMTP credential Secret and SMTPConfig
```bash
cd config/sample/
# Edit SMTP information in smtpconfig.yaml
vi smtpconfig.yaml
kubectl apply -f smtpconfig.yaml
```
2. Generate Notification resource
```bash
# Edit information email_notification.yaml
kubectl apply -f email_notification.yaml
```
3. Send GET request to generated notification's Endpoint in pod
```bash
curl -XPOST
```
### Generate NotificationTrigger and Monitor resource and check
1. Generate Monitor resource
```bash
# Edit monitor.yaml before applying
kubectl apply -f monitor.yaml
```
2. Verify fetching resource correctly
```bash
kubectl get monitor -o yaml
```
3. Generate NotificationTrigger resource
```bash
# Edit information notificationtrigger.yaml
kubectl apply -f notificationtrigger.yaml
```
4. Verify if trigger working correctly
```bash
kubectl get monitor -o yaml
```
## Feature
* Mail notification
* Webhook notification (working)
* Slack notification (working)
* Monitoring resource and specify condition to trigger notification
## Development
## License