Persist filters, notifications and source bindings state from commands

[pkosiec]

Description

Changes proposed in this pull request:

• Persist filters, notifications and source bindings state from commands
  • Source bindings implementation split out from Notification Presets #710 and is introduced here

Limitations

1. Notifications state for MS Teams is not preserved due to the limitation of the MS Teams integration.
2. Runtime state reload may take a few or more (even 30+) seconds, as stated here. To avoid this issue, we could use ConfigMap informers for Config Watcher.

To do

• Documentation: Update documentation for filters and notifiers persistence botkube-docs#143
• Testing
• Ensure Helm chart values are properly merged across Helm chart upgrades - as a follow-up PR Merge persistent config ConfigMaps between Helm upgrades #762

Testing

export WS_SLACK_BOT_TOKEN=""
export WS_SLACK_APP_TOKEN=""
export DISCORD_TOKEN=""

cat > /tmp/values.yaml << ENDOFFILE
communications:
  'default-group':
    socketSlack:
      enabled: true
      botToken: "${WS_SLACK_BOT_TOKEN}"
      appToken: "${WS_SLACK_APP_TOKEN}"
      token: ""
      channels:
        'default':
          name: botkube-test
          notification:
            disabled: true
          bindings:
            executors:
              - kubectl-read-only
            sources:
              - k8s-events
        'second':
          name: botkube-demo
          bindings:
            executors:
              - kubectl-read-only
            sources:
              - k8s-events

    discord:
      enabled: true
      botID: "976786722706821120"
      token: "${DISCORD_TOKEN}"
      channels:
        'default':
          id: "{id1}"
          notification:
              disabled: true
          bindings:
            executors:
              - kubectl-read-only
            sources:
              - k8s-events
        'test':
          id: "{id2}"
          bindings:
            executors:
              - kubectl-read-only
            sources:
              - k8s-events
        'test2':
          id: "{id3}"
          bindings:
            executors:
              - kubectl-read-only
            sources:
              - k8s-events
      notification:
        type: short

settings:
  clusterName: dev
executors:
  'kubectl-read-only':
    kubectl:
      enabled: true
analytics:
  disable: true
image:
  #registry: docker.io
  #repository: pkosiec/botkube
  #tag: '746-PR'
  repository: kubeshop/pr/botkube
  tag: '746-PR'
  pullPolicy: Always  
ENDOFFILE
helm install botkube ./helm/botkube -n botkube --create-namespace  -f /tmp/values.yaml

Get ConfigMaps:

kubectl get cm -n botkube botkube-runtime-config -oyaml
kubectl get cm -n botkube botkube-startup-config -oyaml

Run command on any configured channel:

@BotKube filters disable NodeEventsChecker

Get ConfigMap:

kubectl get cm -n botkube botkube-startup-config -oyaml

Notice that the Pod doesn't restart.

Run command on botkube-test channel on Slack:

@BotKube notifier start

And e.g. on test channel on Discord:

@BotKube notifier stop

See the ConfigMaps again:

kubectl get cm -n botkube botkube-runtime-config -oyaml
kubectl get cm -n botkube botkube-startup-config -oyaml

You can trigger some notifications:

k delete po -n kube-system -l k8s-app=metrics-server

Also, edit the runtime ConfigMap and e.g. change sources for a given channel:

k edit cm -n botkube botkube-runtime-config

Wait until Pod restarts.

Related issue(s)

#704

[ezodude]

Left a comment - otherwise the code looks fine.

[ezodude]

Quick question:

Other than the tests and theConfigPersistenceManager interface, is there anywhere else in the code that uses this method?

Maybe I missed it.

[pkosiec]

Very good question - I'm sorry I forgot to describe it: this will be used by @mszostok here: #747
(Not sure which PR comes first, but we agreed together on the interface and the actual persistency is implemented in my PR). So it's actually a part of the "source bindings edit" feature 🙂

[pkosiec]

Update: looks as Mateusz merged his PR, so after I rebase this PR this part will persist source bindings from the edit command 👍

[ezodude]

About to test locally.

[ezodude]

In the PR testing section:

@botkube NextGen filters disable NodeEventsChecker

What does "NextGen" refer to here?

The command: @BotKube filters disable NodeEventsChecker runs fine without it.

[pkosiec]

@ezodude
I have BotKube NextGen app inside my workspace, and yeah, it's my custom name 😄 So please use @BotKube or whatever name you have for your Slack app 👍 thanks!

[ezodude]

Ran the code locally, all works.

[ezodude]

👍

[pkosiec]

Thanks @ezodude for review. I rebased the PR and tested all the communication platforms:

• Discord
• Slack
• Teams
• Mattermost

Both Source Bindings + notifications are properly persisted after small changes b8130d2 👍