Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logocomune/webhookdocker
A Keybase, Slack and WebEx integration to notify Docker Events via incoming webhook
https://github.com/logocomune/webhookdocker
docker docker-events golang keybase slack-incoming-webhooks webex
Last synced: 4 days ago
JSON representation
A Keybase, Slack and WebEx integration to notify Docker Events via incoming webhook
- Host: GitHub
- URL: https://github.com/logocomune/webhookdocker
- Owner: logocomune
- License: apache-2.0
- Created: 2020-03-31T22:32:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T15:30:19.000Z (29 days ago)
- Last Synced: 2024-11-05T22:41:15.241Z (10 days ago)
- Topics: docker, docker-events, golang, keybase, slack-incoming-webhooks, webex
- Language: Go
- Homepage:
- Size: 181 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webhook Docker
[](https://microbadger.com/images/logocomune/webhook-docker:1.3.1 "Get your own version badge on microbadger.com")
[](https://microbadger.com/images/logocomune/webhook-docker:1.3.1 "Get your own image badge on microbadger.com")
[](https://goreportcard.com/report/github.com/logocomune/webhookdocker)
A [Keybase](https://keybase.io), [Slack](https://slack.com) and [WebEx](https://www.webex.com/) integration to notify Docker Events via incoming webhook
## Keybase webhook setup
+ Add [webhookbot](https://keybase.io/webhookbot) from list of Bots
+ Create a new webhook for sending messages into the current conversation. You must supply a name as well to identify the webhook. Example: `!webhook create alerts`
+ Get the new URL to send webhooks
## Slack webhook setup
+ Setup [Incoming Slack](https://my.slack.com/services/new/incoming-webhook)
## WebEx webhook setup
+ Connect [Incoming Webhooks](https://apphub.webex.com/teams/applications/incoming-webhooks-cisco-systems)
## Run
Capture docker events and send to Keybase:
```shell
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro \
logocomune/webhook-docker:v1.3.1 --keybase-endpoint=https://bots.keybase.io/webhookbot/....
```
Capture docker events and send to Slack:
```shell
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro \
logocomune/webhook-docker:v1.3.1 --slack-endpoint=https://hooks.slack.com/services/....
```
Capture docker events and send to WebEx:
```shell
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro \
logocomune/webhook-docker:v1.3.1 --webex-endpoint=https://api.ciscospark.com/v1/webhooks/incoming/....
```
### Application options
| flag | Environment |type | Default | |
| --- | --- | --- | --- | --- |
| --node-name | WD_NODE_NAME |String| | Node name. If empty use the hostname |
| --hide-node-name | WD_HIDE_NODE_NAME |Boolean| false | Node name is omitted |
| --docker-external-instance-inspection | WD_DOCKER_EXTERNAL_INSTANCE_INSPECTION | String | Add an external inspection url. Eg: https://myhost.ext/inspection/#/containers/__ID__|
| --docker-show-running | WD_DOCKER_SHOW_RUNNING | Boolean | false | Send running container to webhook |
| --docker-listen-container-events | WD_DOCKER_LISTEN_CONTAINER_EVENTS | Boolean | true | Listen for container events |
| --docker-listen-network-events | WD_DOCKER_LISTEN_NETWORK_EVENTS | Boolean | true | Listen for network events |
| --docker-listen-volume-events |WD_DOCKER_LISTEN_VOLUME_EVENTS | Boolean | true | Listen for volume events |
| --docker-listen-container-actions | WD_DOCKER_LISTEN_CONTAINER_ACTIONS| Strings separated by ; | attach;create;destroy;detach;die;kill;oom;pause;rename;restart;start;stop;unpause;update | Docker container events |
| --docker-listen-network-actions | WD_DOCKER_LISTEN_NETWORK_ACTIONS | Strings separated by ; | create;connect;destroy;disconnect;remove | Docker network events |
| --docker-listen-volume-actions | WD_DOCKER_LISTEN_VOLUME_ACTIONS | Strings separated by ; | create;destroy;mount;unmount | Docker volume events |
| --docker-filter-container-name | WD_DOCKER_FILTER_CONTAINER_NAME | Regexp | |Filter events by container name (default all) |
| --docker-filter-negate-container-name | WD_DOCKER_FILTER_NEGATE_CONTAINER_NAME | Boolean | false | Negate the filter of container name |
| --docker-filter-image-name | WD_DOCKER_FILTER_IMAGE_NAME | Regexp | |Filter events by image name (default all) |
| --docker-filter-negate-image-name | WD_DOCKER_FILTER_NEGATE_IMAGE_NAME | Boolean | false | Negate the filter of image name |
| --keybase-endpoint | WD_KEYBASE_ENDPOINT | String | | Keybase endpoint for webhook |
| --slack-endpoint | WD_SLACK_ENDPOINT | String | | Slack endpoint for webhook |
| --webex-endpoint | WD_WEBEX_ENDPOINT | String | | WebEx endpoint for webhook |
#### Regexp Filters
Capture events of container with names with the following formats:
+ exec-1234
+ exec-abcd-12345
```shell
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro \
--docker-filter-container-name="^exec-.*$" \
logocomune/webhook-docker:latest --webex-endpoint=https://api.ciscospark.com/v1/webhooks/incoming/....
```
*Exclude* events of container with the following formats:
+ exec-1234
+ exec-abcd-12345
```shell
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro \
--docker-filter-container-name="^exec-.*$" \
--docker-filter-negate-container-name \
logocomune/webhook-docker:latest --webex-endpoint=https://api.ciscospark.com/v1/webhooks/incoming/....
```