Skip to content

Commit

Permalink
Update Helm chart description and error wording (#1445)
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec authored May 13, 2024
1 parent 85e70ab commit cced671
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 11 deletions.
3 changes: 1 addition & 2 deletions helm/botkube/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ home: https://botkube.io
version: v9.99.9-dev
appVersion: v9.99.9-dev
icon: https://docs.botkube.io/images/botkube-black.svg
description: Controller for the Botkube Slack app which helps you monitor your Kubernetes cluster,
debug deployments and run specific checks on resources in the cluster.
description: A virtual SRE, powered by AI.
sources:
- https://github.com/kubeshop/botkube
keywords:
Expand Down
8 changes: 4 additions & 4 deletions helm/botkube/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![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)

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

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

Expand Down Expand Up @@ -122,13 +122,13 @@ Controller for the Botkube Slack app which helps you monitor your Kubernetes clu
| [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`. |
| [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"`. |
| [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. |
| [communications.default-group.socketSlack.enabled](./values.yaml#L530) | bool | `false` | If true, enables Slack bot. |
| [communications.default-group.socketSlack.enabled](./values.yaml#L530) | bool | `false` | If true, enables bot for Slack. |
| [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. |
| [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. |
| [communications.default-group.socketSlack.channels.default.bindings.executors](./values.yaml#L540) | list | `["k8s-default-tools"]` | Executors configuration for a given channel. |
| [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. |
| [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). |
| [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). |
| [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). |
| [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). |
| [communications.default-group.mattermost.enabled](./values.yaml#L555) | bool | `false` | If true, enables Mattermost bot. |
| [communications.default-group.mattermost.botName](./values.yaml#L557) | string | `"Botkube"` | User in Mattermost which belongs the specified Personal Access token. |
| [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 |
Expand Down
6 changes: 3 additions & 3 deletions helm/botkube/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ communications:
'default-group':
## Settings for Slack with Socket Mode.
socketSlack:
# -- If true, enables Slack bot.
# -- If true, enables bot for Slack.
enabled: false
# -- Map of configured channels. The property name under `channels` object is an alias for a given configuration.
#
Expand All @@ -543,10 +543,10 @@ communications:
sources:
- k8s-err-events
- k8s-recommendation-events
# -- Slack bot token for your own Slack app.
# -- Bot token for your own app for Slack.
# [Ref doc](https://api.slack.com/authentication/token-types).
botToken: ''
# -- Slack app-level token for your own Slack app.
# -- App-level token for your own app for Slack.
# [Ref doc](https://api.slack.com/authentication/token-types).
appToken: ''
## Settings for Mattermost.
Expand Down
2 changes: 1 addition & 1 deletion pkg/bot/slack_cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,7 @@ func quotaExceeded() interactive.CoreMessage {
Sections: []api.Section{
{
Base: api.Base{
Description: "You cannot use the Botkube Cloud Slack application within your plan. The command executions are blocked.",
Description: "You cannot use the Botkube app for Slack within your Botkube Cloud plan. The command executions are blocked.",
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/bot/slack_socket.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func NewSocketSlack(log logrus.FieldLogger, commGroupMetadata CommGroupMetadata,

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

Expand Down

0 comments on commit cced671

Please sign in to comment.