Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valentin2105/k8s-mattermost
Mattermost Bot to interact with Kubernetes
https://github.com/valentin2105/k8s-mattermost
bot go golang kubernetes mattermost
Last synced: 21 days ago
JSON representation
Mattermost Bot to interact with Kubernetes
- Host: GitHub
- URL: https://github.com/valentin2105/k8s-mattermost
- Owner: valentin2105
- License: mit
- Created: 2018-08-08T06:14:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-28T22:49:48.000Z (about 5 years ago)
- Last Synced: 2024-10-11T19:46:52.628Z (about 1 month ago)
- Topics: bot, go, golang, kubernetes, mattermost
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8s-mattermost
[](https://goreportcard.com/report/github.com/valentin2105/k8s-mattermost)
[](https://github.com/dwyl/esta/issues)
### What is it ?
**k8s-mattermost** is a bot that connects to a Mattermost channel's websocket and watches for kubectl commands.
By default, you can trigger the bot with `!k ` :
```
!k - get cs # You can use "-" if ressource doesn't get namespace
!k kube-system get deploy
!k all get pod # You can use "all" to show all namespaces
```
The configuration is located in the `config.toml.dist` file (you should rename it to `config.toml`) :
```
[general]
bot_name = "k8s-bot"
kubectl_path = "/usr/local/bin/kubectl"
[mattermost]
host = "your-mattermost.org"
channel_name = "kubernetes"
team_name = "your-team"
user_login = "[email protected]"
user_password = "averystr0ngpassw0rd"
```
You can load a different config file using the `-c ` flag.
### How can you run it ?
You can fetch the latest build for Linux with :
```
wget https://github.com/valentin2105/k8s-mattermost/releases/download/v0.1.1/k8s-mattermost
chmod +x k8s-mattermost
./k8s-mattermost -c config.toml
```
Or run it using Docker :
```
docker run \
-e K8S_API="https://k8s-api.url:6443" \
-e K8S_TOKEN="yourClusterToken" \
-e TEAM="your-team" \
-e LOGIN="[email protected]" \
-e PASSWORD="averystr0ngpassw0rd" \
-e SERVER="your-mattermost.org" \
-e CHANNEL="your-channel" \
valentinnc/k8s-mattermost
```
Or build it from source :
```
# install dep
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
# clone repo
mkdir -p $GOPATH/src/github.com/valentin2105/ && cd $GOPATH/src/github.com/valentin2105/
git clone https://github.com/valentin2105/k8s-mattermost.git && cd k8s-mattermost
# fetch dependencies
dep ensure
# build app
go build
```
### Screenshot
