Add Discord support #268

codenio · 2020-04-29T13:43:25Z

ISSUE TYPE

Feature Pull Request

SUMMARY

Add support for Discord:

This PR,

adds discord bot
adds discord notifier
adds required discord configurations into comm_config.yaml
adds discordgo module into go.mod
adds discord configs into all yaml files

Fixes #97

Steps For Creation and Integration:

Reach https://discordapp.com/developers/applications
Create New Application named Botkube and add a bot named Botkube into the Application
Copy the Application CLIENT ID and place it under Dischord.botid in comm-config.yaml
Copy Bot TOKEN and place it under Dischord.token in comm-config.yaml
Generate the URL with suitable permissions using the OAuth2 URL Generator available under OAuth2 section to the add bot to your Discord server

https://discordapp.com/oauth2/authorize?&client_id=<YOUR_CLIENT_ID>&scope=bot&permissions=<SET_OF_PERMISSIONS>

Paste the generated URL in a new tab, select the discord sever to which you want to add the bot and Authorise Bot addition.
Create a new channel and/or copy the CHANNEL ID of an existing one that you want to use and place it under Dischord.channel

  # Settings for Discord
  discord:
    enabled: true
    token: 'DISCORD_TOKEN'	    # BotKube Bot Token 
    botid: 'DISCORD_BOT_ID'         # BotKube Application Client ID 
    channel: 'DISCORD_CHANNEL_ID'   # Discord Channel id for receiving BotKube alerts 
    notiftype: short                # Change notification type short/long you want to receive. notiftype is optional and Default notification type is short (if not specified)

Note: Follow the first 4 mins of this Video Tutorial to understand the process visually.

Preview:

cmd/botkube/main.go

pkg/bot/discord.go

pkg/notify/discord.go

pkg/bot/discord.go

pkg/notify/discord.go

PrasadG193 · 2020-05-01T06:59:27Z

@codenio can we add integration tests?

codenio · 2020-05-02T11:48:32Z

added discord configs into all yaml files

PrasadG193 · 2020-05-06T06:01:51Z

@codenio The CI job is failing with

Step 9/17 : RUN GOOS=${GOOS_VAL} GOARCH=${GOARCH_VAL} go build -o /go/bin/botkube ./cmd/botkube
 ---> Running in 3dcedf3fac47
# github.com/docker/docker/pkg/term
exec: "gcc": executable file not found in $PATH
The command '/bin/sh -c GOOS=${GOOS_VAL} GOARCH=${GOARCH_VAL} go build -o /go/bin/botkube ./cmd/botkube' returned a non-zero code: 2
Makefile:39: recipe for target 'container-image' failed
make: *** [container-image] Error 2
The command "make container-image" exited with 2.

I think the docker dep you added needs gcc. Can you please update travis config to add gcc dep?

codenio · 2020-07-01T08:14:10Z

@PrasadG193, resolved the build issue and rebased this PR to develop.
can this be merged?

kingdevnl · 2020-07-25T09:09:48Z

I guess this has to be rebased again soon?

codenio · 2020-07-28T05:55:54Z

rebased and resolved issues

unixfox · 2020-07-28T09:21:40Z

Can this PR get reviewed again or/and merged? I'm using it on my own k8s cluster and it's working pretty well!

@codenio Seriously good job.

unixfox · 2020-07-28T10:21:17Z

I just found an odd bug.
I'm able to ping/send commands to the bot through the desktop Discord client but not on the Android Discord client.

The first message is from the Android Discord client and the second is from the desktop Discord client.

@codenio Could you try to replicate the bug by sending a ping to your botkube from your Android Discord client?

kingdevnl · 2020-07-28T12:05:53Z

How would i install the version of the PR onto a kube cluster?

kingdevnl · 2020-07-28T12:48:00Z

I tried to get it to run,

But gettings this error...

panic: http: multiple registrations for /metrics

goroutine 38 [running]:
net/http.(*ServeMux).Handle(0x3489840, 0x1d1852b, 0x8, 0x216d180, 0xc0002c71d0)
/usr/local/go/src/net/http/server.go:2391 +0x29c
net/http.Handle(...)
/usr/local/go/src/net/http/server.go:2434
github.com/infracloudio/botkube/pkg/metrics.ServeMetrics(0x1d0fdda, 0x4)
/app/pkg/metrics/metrics.go:29 +0x5f
created by main.startController
/app/cmd/botkube/main.go:81 +0x13d

unixfox · 2020-07-28T12:50:28Z

@kingdevnl I think something is broken in the develop branch of botkube.
If you use this commit it will work: a3ff62f

I have a docker image already built with that commit if you want to test:

image: quay.io/unixfox/botkube
tag: a3ff62f

onedr0p · 2020-08-07T10:52:17Z

@PrasadG193 are unit tests really holding up adding new notifier integrations, specifically this one? I understand tests are important, however they can always be added later on.

codenio · 2020-08-07T11:54:35Z

resolved it. can you check now..?

unixfox · 2020-08-07T12:44:30Z

Yes it's working without any error. Thank you!

onedr0p · 2020-08-07T18:14:00Z

Working great on mobile now too with @unixfox docker image. Thanks you two!

onedr0p · 2020-09-04T01:33:13Z

Any update here from the maintainers? I've been using a docker image built from this PR for a month now and it works great.

@PrasadG193 MS team support was merged without integration tests, can this be too, please?

PrasadG193 · 2020-10-01T06:15:26Z

@codenio We can target and get this in in upcoming release. Could you please take a stab at adding documentation? We use hugo for hosting docs. The docs repo is: https://github.com/infracloudio/botkube-docs

PrasadG193 · 2020-10-01T06:17:46Z

We have improved test coverage for the notifier interface. For discord bot interface tests, we can revisit this later.

codenio · 2020-10-02T07:41:20Z

@PrasadG193 will certainly add corresponding docs, can we get this PR merged now..?

comm_config.yaml

deploy-all-in-one-tls.yaml

pkg/bot/discord.go

deploy-all-in-one-tls.yaml

deploy-all-in-one.yaml

helm/botkube/values.yaml

test/comm_config.yaml

This commit, - adds discord bot - adds discord notifier - adds required discord configurations into comm_config.yaml - adds discordgo module into go.mod - adds discord configs into all yaml files - adds apk add build-base into dockerfile Build Env

codenio · 2020-10-06T05:12:53Z

🙏 , feeling relieved., @ALL thanks for the extended support, thanks @PrasadG193 and @sanketsudake for the reviews and feedbacks.

PrasadG193 · 2020-10-06T05:18:14Z

Thanks for all the hard work and patience @codenio

kingdevnl · 2020-10-06T05:20:07Z

Realy thanks man <3

#### ISSUE TYPE  - Feature Pull Request ##### SUMMARY  **Add support for Discord:** This PR, - adds discord bot - adds discord notifier - adds required discord configurations into comm_config.yaml - adds discordgo module into go.mod - adds discord configs into all yaml files   Fixes kubeshop#97 ### Steps For Creation and Integration: 1. Reach https://discordapp.com/developers/applications 2. Create New Application named Botkube and add a bot named **Botkube** into the Application 3. Copy the Application **CLIENT ID** and place it under _Dischord.botid_ in comm-config.yaml 4. Copy Bot **TOKEN** and place it under _Dischord.token_ in comm-config.yaml 5. Generate the URL with suitable permissions using the OAuth2 URL Generator available under OAuth2 section to the add bot to your Discord server ``` https://discordapp.com/oauth2/authorize?&client_id=<YOUR_CLIENT_ID>&scope=bot&permissions=<SET_OF_PERMISSIONS> ``` 6. Paste the generated URL in a new tab, select the discord sever to which you want to add the bot and Authorise Bot addition. 7. Create a new channel and/or copy the **CHANNEL ID** of an existing one that you want to use and place it under _Dischord.channel_ ```yaml # Settings for Discord discord: enabled: true token: 'DISCORD_TOKEN' # BotKube Bot Token botid: 'DISCORD_BOT_ID' # BotKube Application Client ID channel: 'DISCORD_CHANNEL_ID' # Discord Channel id for receiving BotKube alerts notiftype: short # Change notification type short/long you want to receive. notiftype is optional and Default notification type is short (if not specified) ``` #### Note: Follow the first 4 mins of this [Video Tutorial](https://youtu.be/8o25pRbXdFw) to understand the process visually. ### Preview: ![ping](https://user-images.githubusercontent.com/30741615/80600577-3931cf00-8a4a-11ea-9215-a725a0b17256.png) ![pod-create-short](https://user-images.githubusercontent.com/30741615/80600638-55357080-8a4a-11ea-976f-b91e823c93bd.png) ![pod-error-long](https://user-images.githubusercontent.com/30741615/80600803-8dd54a00-8a4a-11ea-90e4-a205e93aba5f.png) ![file-attachment](https://user-images.githubusercontent.com/30741615/80600724-75fdc600-8a4a-11ea-9b10-1b5ac0e79548.png)

sanketsudake added the enhancement New feature or request label May 1, 2020

sanketsudake reviewed May 1, 2020

View reviewed changes

cmd/botkube/main.go Outdated Show resolved Hide resolved

pkg/bot/discord.go Outdated Show resolved Hide resolved

pkg/notify/discord.go Outdated Show resolved Hide resolved

pkg/notify/discord.go Outdated Show resolved Hide resolved

sanketsudake requested a review from PrasadG193 May 1, 2020 03:35

codenio force-pushed the feature/discord-integration branch from eb04291 to a1adfee Compare May 1, 2020 05:53

PrasadG193 reviewed May 1, 2020

View reviewed changes

codenio force-pushed the feature/discord-integration branch 6 times, most recently from 1861b0b to 86f0612 Compare May 2, 2020 11:47

codenio force-pushed the feature/discord-integration branch 5 times, most recently from c5efd84 to b7f39af Compare July 1, 2020 08:03

codenio force-pushed the feature/discord-integration branch from b7f39af to a3ff62f Compare July 1, 2020 13:17

codenio force-pushed the feature/discord-integration branch 2 times, most recently from 0934042 to 4e0e433 Compare July 28, 2020 05:34

codenio force-pushed the feature/discord-integration branch from 2a33846 to b5b3a25 Compare August 7, 2020 11:53

codenio force-pushed the feature/discord-integration branch from b5b3a25 to f748cf2 Compare October 1, 2020 16:23

codenio force-pushed the feature/discord-integration branch from f748cf2 to a59ef56 Compare October 2, 2020 08:44

codenio mentioned this pull request Oct 2, 2020

Bug Fix e2e tests #389

Merged

PrasadG193 reviewed Oct 5, 2020

View reviewed changes

comm_config.yaml Outdated Show resolved Hide resolved

comm_config.yaml Outdated Show resolved Hide resolved

deploy-all-in-one-tls.yaml Outdated Show resolved Hide resolved

pkg/bot/discord.go Outdated Show resolved Hide resolved

pkg/bot/discord.go Show resolved Hide resolved

codenio force-pushed the feature/discord-integration branch 3 times, most recently from 8d1e519 to dc5aeaf Compare October 5, 2020 10:07

PrasadG193 reviewed Oct 5, 2020

View reviewed changes

deploy-all-in-one-tls.yaml Outdated Show resolved Hide resolved

deploy-all-in-one.yaml Outdated Show resolved Hide resolved

helm/botkube/values.yaml Outdated Show resolved Hide resolved

test/comm_config.yaml Outdated Show resolved Hide resolved

codenio force-pushed the feature/discord-integration branch 3 times, most recently from 5ed968f to d1c864b Compare October 6, 2020 02:56

Add Discord support

80522a4

This commit, - adds discord bot - adds discord notifier - adds required discord configurations into comm_config.yaml - adds discordgo module into go.mod - adds discord configs into all yaml files - adds apk add build-base into dockerfile Build Env

codenio force-pushed the feature/discord-integration branch from d1c864b to 80522a4 Compare October 6, 2020 03:26

PrasadG193 approved these changes Oct 6, 2020

View reviewed changes

PrasadG193 added the ready-to-merge label Oct 6, 2020

mergify bot merged commit ad9a738 into kubeshop:develop Oct 6, 2020

unixfox mentioned this pull request Oct 6, 2020

update botkube unixfox/k8s#19

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Discord support #268

Add Discord support #268

codenio commented Apr 29, 2020 •

edited

Loading

PrasadG193 commented May 1, 2020

codenio commented May 2, 2020

PrasadG193 commented May 6, 2020 •

edited

Loading

codenio commented Jul 1, 2020 •

edited

Loading

kingdevnl commented Jul 25, 2020

codenio commented Jul 28, 2020

unixfox commented Jul 28, 2020

unixfox commented Jul 28, 2020 •

edited

Loading

kingdevnl commented Jul 28, 2020

kingdevnl commented Jul 28, 2020

unixfox commented Jul 28, 2020 •

edited

Loading

onedr0p commented Aug 7, 2020

codenio commented Aug 7, 2020

unixfox commented Aug 7, 2020

onedr0p commented Aug 7, 2020

onedr0p commented Sep 4, 2020 •

edited

Loading

PrasadG193 commented Oct 1, 2020

PrasadG193 commented Oct 1, 2020

codenio commented Oct 2, 2020

codenio commented Oct 6, 2020

PrasadG193 commented Oct 6, 2020

kingdevnl commented Oct 6, 2020

Add Discord support #268

Add Discord support #268

Conversation

codenio commented Apr 29, 2020 • edited Loading

ISSUE TYPE

SUMMARY

Steps For Creation and Integration:

Note: Follow the first 4 mins of this Video Tutorial to understand the process visually.

Preview:

PrasadG193 commented May 1, 2020

codenio commented May 2, 2020

PrasadG193 commented May 6, 2020 • edited Loading

codenio commented Jul 1, 2020 • edited Loading

kingdevnl commented Jul 25, 2020

codenio commented Jul 28, 2020

unixfox commented Jul 28, 2020

unixfox commented Jul 28, 2020 • edited Loading

kingdevnl commented Jul 28, 2020

kingdevnl commented Jul 28, 2020

unixfox commented Jul 28, 2020 • edited Loading

onedr0p commented Aug 7, 2020

codenio commented Aug 7, 2020

unixfox commented Aug 7, 2020

onedr0p commented Aug 7, 2020

onedr0p commented Sep 4, 2020 • edited Loading

PrasadG193 commented Oct 1, 2020

PrasadG193 commented Oct 1, 2020

codenio commented Oct 2, 2020

codenio commented Oct 6, 2020

PrasadG193 commented Oct 6, 2020

kingdevnl commented Oct 6, 2020

codenio commented Apr 29, 2020 •

edited

Loading

PrasadG193 commented May 6, 2020 •

edited

Loading

codenio commented Jul 1, 2020 •

edited

Loading

unixfox commented Jul 28, 2020 •

edited

Loading

unixfox commented Jul 28, 2020 •

edited

Loading

onedr0p commented Sep 4, 2020 •

edited

Loading