Skip to content

Commit

Permalink
Document notification and reorganize filter documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec committed Sep 20, 2022
1 parent 4db70eb commit 3e8c19d
Show file tree
Hide file tree
Showing 7 changed files with 162 additions and 149 deletions.
20 changes: 16 additions & 4 deletions docs/configuration/communication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ communications:
channels:
"primary-channel": # Your own alias for the channel configuration
name: general
notification:
# If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
disabled: true
bindings:
executors: # Executors configuration for a given channel
- kubectl-read-only
Expand All @@ -61,13 +64,13 @@ The example YAML configuration definition results in the following configuration
For Slack **Workspace 1**, as defined by the first communication group (`first-group`):

- sending notifications from `k8s-events` source to the `general` and `random` channels,
- ability to execute commands from `kubectl-read-only` configuration in the `general` channel. On `random` channel executors are not configured.
- Notifications from `k8s-events` source are sent to the `general` and `random` channels.
- Commands from the `kubectl-read-only` configuration can be executed in the `general` channel. On `random` channel executors are not configured.

For Slack **Workspace 2**, as defined by the second communication group (`second-group`):

- sending notifications from `k8s-events` source to the `general` channel,
- ability to execute commands in the `general` channel.
- Notifications are configured to be sent from the `k8s-events` source to the `general` channel. They are disabled by default, and can be enabled with `@BotKube` command or during BotKube upgrade.
- Commands from the `kubectl-read-only` configuration can be executed in the `general` channel.

## Source and Executor Bindings

Expand Down Expand Up @@ -107,6 +110,9 @@ communications:
"default":
# Slack channel name without '#' prefix where you have added BotKube and want to receive notifications in.
name: "SLACK_CHANNEL"
notification:
# If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
disabled: false
bindings:
# Executors configuration for a given channel.
executors:
Expand Down Expand Up @@ -140,6 +146,9 @@ communications:
# The Mattermost channel name for receiving BotKube alerts.
# The BotKube user needs to be added to it.
name: "MATTERMOST_CHANNEL"
notification:
# If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
disabled: false
bindings:
# Executors configuration for a given channel.
executors:
Expand Down Expand Up @@ -192,6 +201,9 @@ communications:
# Discord channel ID for receiving BotKube alerts.
# The BotKube user needs to be added to it.
id: "DISCORD_CHANNEL_ID"
notification:
# If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
disabled: false
bindings:
# Executors configuration for a given channel.
executors:
Expand Down
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: filters
title: "Adding a custom filter"
id: development
title: "Custom filter development"
sidebar_position: 5
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Filter
sidebar_position: 5
---

The filter configuration allows you to configure global filters which are used for all processed events.
The filter configuration allows you to configure global filters which are used for all processed events. The filters can be disabled or enabled using dedicated commands. See the [Usage](../usage/index.md) document for more details.

You can develop your own filter according to the [Filter Development Guide](../filters/index.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The general settings holds a general configuration for the BotKube backend. For
settings:
# Cluster name to differentiate incoming messages.
clusterName: not-configured
# If true, restarts the BotKube Pod on config changes.
# If true, restarts the BotKube Pod on config changes. Files with `_` name prefix are ignored.
configWatcher: true
# If true, notifies about new BotKube releases.
upgradeNotifier: true
Expand Down
Loading

0 comments on commit 3e8c19d

Please sign in to comment.