Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/squat/fluxcdbot
A Telegram bot for Flux CD
https://github.com/squat/fluxcdbot
bot cd flux gitops kubernetes telegram
Last synced: 3 months ago
JSON representation
A Telegram bot for Flux CD
- Host: GitHub
- URL: https://github.com/squat/fluxcdbot
- Owner: squat
- License: apache-2.0
- Created: 2021-02-08T17:32:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-17T12:57:56.000Z (over 3 years ago)
- Last Synced: 2024-06-21T17:06:16.735Z (8 months ago)
- Topics: bot, cd, flux, gitops, kubernetes, telegram
- Language: Go
- Homepage:
- Size: 3.12 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FluxCD Bot
`fluxcdbot` is a Telergram bot for [Flux](https://github.com/fluxcd/flux2).
`fluxcdbot` accepts webhooks from the [Flux notification-controller](https://github.com/fluxcd/notification-controller) and forwards the messages to corresponding Telegram chat.
[](https://github.com/squat/fluxcdbot/actions?query=workflow%3ACI)
[](https://goreportcard.com/report/github.com/squat/fluxcdbot)
## Overview
In order to subscribe to Telegram messages from the bot, send `/start` to the bot via chat.
The bot will in turn respond with a unique webhook URL specific to this chat.
The given webhook URL can then be configured with the notification-controller using the `Provider` and `Alert` custom resources.
For example, the following snippet could be used to forward all updates to the chat:
```shell
cat <<'EOF' | kubectl apply -f -
apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Provider
metadata:
name: fluxcdbot
spec:
type: generic
secretRef:
name: fluxcdbot
---
apiVersion: v1
kind: Secret
metadata:
name: fluxcdbot
stringData:
address:
---
apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Alert
metadata:
name: fluxcdbot
spec:
providerRef:
name: fluxcdbot
eventSeverity: info
eventSources:
- kind: Kustomization
name: flux-system
namespace: flux-system
EOF
```
Note, webhook URLs should be treated as secrets as anyone with access to the URL can make requests to the bot, which will then send messages to the URL's corresponding chat.
Webhook URLs can be rotated by sending `/rotate` to the bot.
## Installation
In order to deploy `fluxcdbot` to a Kubernetes cluster, first generate a Telegram bot API token using the [BotFather](https://t.me/botfather).
Next, create a Kubernetes Secret for the bot containing this token, e.g.:
```shell
kubectl create secret generic fluxcdbot --from-literal=token=
```
Finally, deploy the example manifest included in this repository, modifying the base URL as needed:
```shell
kubectl apply -f https://raw.githubusercontent.com/squat/fluxcdbot/main/manifests/fluxcdbot.yaml
```
## Usage
[embedmd]:# (tmp/help.txt)
```txt
Usage of bin/linux/amd64/fluxcdbot:
-database string
The path to the directory to use for the database. (default "/var/fluxcdbot")
-listen string
The address at which to listen. (default ":8080")
-listen-internal string
The address at which to listen for health and metrics. (default ":9090")
-log-level string
Log level to use. Possible values: all, debug, info, warn, error, none (default "info")
-tmp string
The path to a directory to use for temporary storage. (default "/tmp/fluxcdbot")
-token string
The Telegram API token.
-url string
The URL clients should use to commincate with this server. (default "http://127.0.0.1:8080")
-version
Print version and exit
```