Skip to content

Commit cced671

Browse files
authored
Update Helm chart description and error wording (#1445)
1 parent 85e70ab commit cced671

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

helm/botkube/Chart.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ home: https://botkube.io
44
version: v9.99.9-dev
55
appVersion: v9.99.9-dev
66
icon: https://docs.botkube.io/images/botkube-black.svg
7-
description: Controller for the Botkube Slack app which helps you monitor your Kubernetes cluster,
8-
debug deployments and run specific checks on resources in the cluster.
7+
description: A virtual SRE, powered by AI.
98
sources:
109
- https://github.com/kubeshop/botkube
1110
keywords:

helm/botkube/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Version: v9.99.9-dev](https://img.shields.io/badge/Version-v9.99.9--dev-informational?style=flat-square) ![AppVersion: v9.99.9-dev](https://img.shields.io/badge/AppVersion-v9.99.9--dev-informational?style=flat-square)
44

5-
Controller for the Botkube Slack app which helps you monitor your Kubernetes cluster, debug deployments and run specific checks on resources in the cluster.
5+
A virtual SRE, powered by AI.
66

77
**Homepage:** <https://botkube.io>
88

@@ -122,13 +122,13 @@ Controller for the Botkube Slack app which helps you monitor your Kubernetes clu
122122
| [aliases](./values.yaml#L497) | object | See the `values.yaml` file for full object. | Custom aliases for given commands. The aliases are replaced with the underlying command before executing it. Aliases can replace a single word or multiple ones. For example, you can define a `k` alias for `kubectl`, or `kgp` for `kubectl get pods`. |
123123
| [existingCommunicationsSecretName](./values.yaml#L518) | string | `""` | Configures existing Secret with communication settings. It MUST be in the `botkube` Namespace. To reload Botkube once it changes, add label `botkube.io/config-watch: "true"`. |
124124
| [communications](./values.yaml#L525) | object | See the `values.yaml` file for full object. | Map of communication groups. Communication group contains settings for multiple communication platforms. The property name under `communications` object is an alias for a given configuration group. You can define multiple communication groups with different names. |
125-
| [communications.default-group.socketSlack.enabled](./values.yaml#L530) | bool | `false` | If true, enables Slack bot. |
125+
| [communications.default-group.socketSlack.enabled](./values.yaml#L530) | bool | `false` | If true, enables bot for Slack. |
126126
| [communications.default-group.socketSlack.channels](./values.yaml#L534) | object | `{"default":{"bindings":{"executors":["k8s-default-tools"],"sources":["k8s-err-events","k8s-recommendation-events"]},"name":"SLACK_CHANNEL"}}` | Map of configured channels. The property name under `channels` object is an alias for a given configuration. |
127127
| [communications.default-group.socketSlack.channels.default.name](./values.yaml#L537) | string | `"SLACK_CHANNEL"` | Slack channel name without '#' prefix where you have added Botkube and want to receive notifications in. |
128128
| [communications.default-group.socketSlack.channels.default.bindings.executors](./values.yaml#L540) | list | `["k8s-default-tools"]` | Executors configuration for a given channel. |
129129
| [communications.default-group.socketSlack.channels.default.bindings.sources](./values.yaml#L543) | list | `["k8s-err-events","k8s-recommendation-events"]` | Notification sources configuration for a given channel. |
130-
| [communications.default-group.socketSlack.botToken](./values.yaml#L548) | string | `""` | Slack bot token for your own Slack app. [Ref doc](https://api.slack.com/authentication/token-types). |
131-
| [communications.default-group.socketSlack.appToken](./values.yaml#L551) | string | `""` | Slack app-level token for your own Slack app. [Ref doc](https://api.slack.com/authentication/token-types). |
130+
| [communications.default-group.socketSlack.botToken](./values.yaml#L548) | string | `""` | Bot token for your own app for Slack. [Ref doc](https://api.slack.com/authentication/token-types). |
131+
| [communications.default-group.socketSlack.appToken](./values.yaml#L551) | string | `""` | App-level token for your own app for Slack. [Ref doc](https://api.slack.com/authentication/token-types). |
132132
| [communications.default-group.mattermost.enabled](./values.yaml#L555) | bool | `false` | If true, enables Mattermost bot. |
133133
| [communications.default-group.mattermost.botName](./values.yaml#L557) | string | `"Botkube"` | User in Mattermost which belongs the specified Personal Access token. |
134134
| [communications.default-group.mattermost.url](./values.yaml#L559) | string | `"MATTERMOST_SERVER_URL"` | The URL (including http/https schema) where Mattermost is running. e.g https://example.com:9243 |

helm/botkube/values.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ communications:
526526
'default-group':
527527
## Settings for Slack with Socket Mode.
528528
socketSlack:
529-
# -- If true, enables Slack bot.
529+
# -- If true, enables bot for Slack.
530530
enabled: false
531531
# -- Map of configured channels. The property name under `channels` object is an alias for a given configuration.
532532
#
@@ -543,10 +543,10 @@ communications:
543543
sources:
544544
- k8s-err-events
545545
- k8s-recommendation-events
546-
# -- Slack bot token for your own Slack app.
546+
# -- Bot token for your own app for Slack.
547547
# [Ref doc](https://api.slack.com/authentication/token-types).
548548
botToken: ''
549-
# -- Slack app-level token for your own Slack app.
549+
# -- App-level token for your own app for Slack.
550550
# [Ref doc](https://api.slack.com/authentication/token-types).
551551
appToken: ''
552552
## Settings for Mattermost.

pkg/bot/slack_cloud.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,7 @@ func quotaExceeded() interactive.CoreMessage {
741741
Sections: []api.Section{
742742
{
743743
Base: api.Base{
744-
Description: "You cannot use the Botkube Cloud Slack application within your plan. The command executions are blocked.",
744+
Description: "You cannot use the Botkube app for Slack within your Botkube Cloud plan. The command executions are blocked.",
745745
},
746746
},
747747
},

pkg/bot/slack_socket.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ func NewSocketSlack(log logrus.FieldLogger, commGroupMetadata CommGroupMetadata,
7878

7979
authResp, err := client.AuthTest()
8080
if err != nil {
81-
return nil, fmt.Errorf("while testing the ability to do auth Slack request: %w", slackError(err, ""))
81+
return nil, fmt.Errorf("while testing the ability to do authenticated Slack request: %w", slackError(err, ""))
8282
}
8383
botID := authResp.UserID
8484

0 commit comments

Comments
 (0)