Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare docs for 1.14 release #354

Merged
merged 2 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/cli/commands/botkube.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@ Quick Start:
$ botkube install # Install Botkube
$ botkube uninstall # Uninstall Botkube

Botkube Cloud:

$ botkube login # Login into Botkube Cloud
$ botkube migrate # Automatically migrates Open Source installation into Botkube Cloud

```
botkube [flags]
```
Expand All @@ -37,8 +32,6 @@ botkube [flags]

- [botkube config](botkube_config.md) - This command consists of multiple subcommands for working with Botkube configuration
- [botkube install](botkube_install.md) - install or upgrade Botkube in k8s cluster
- [botkube login](botkube_login.md) - Login to a Botkube Cloud
- [botkube migrate](botkube_migrate.md) - Automatically migrates Botkube installation into Botkube Cloud
- [botkube telemetry](botkube_telemetry.md) - Configure collection of anonymous analytics
- [botkube uninstall](botkube_uninstall.md) - uninstall Botkube from cluster
- [botkube version](botkube_version.md) - Print the CLI version
37 changes: 0 additions & 37 deletions docs/cli/commands/botkube_login.md

This file was deleted.

70 changes: 0 additions & 70 deletions docs/cli/commands/botkube_migrate.md

This file was deleted.

10 changes: 5 additions & 5 deletions docs/cli/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ brew install kubeshop/botkube/botkube
Alternatively, download the Botkube CLI binary and move it to a directory under your `$PATH`:

```shell
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.13.0/botkube-darwin-arm64
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-darwin-arm64
chmod +x botkube && mv botkube /usr/local/bin/botkube
```

Expand All @@ -48,7 +48,7 @@ brew install kubeshop/botkube/botkube
Alternatively, download the Botkube CLI binary and move it to a directory under your `$PATH`:

```shell
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.13.0/botkube-darwin-amd64
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-darwin-amd64
chmod +x botkube && mv botkube /usr/local/bin/botkube
```

Expand All @@ -59,7 +59,7 @@ chmod +x botkube && mv botkube /usr/local/bin/botkube
Download the Botkube CLI binary and move it to a directory under your `$PATH`:

```shell
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.13.0/botkube-linux-amd64
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-linux-amd64
chmod +x botkube && mv botkube /usr/local/bin/botkube
```

Expand All @@ -82,7 +82,7 @@ brew install kubeshop/botkube/botkube
Use <a href="https://curl.se/windows/" target="_blank" rel="noreferrer">curl</a> to download the Botkube CLI binary:

```shell
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.13.0/botkube-windows-amd64.exe
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-windows-amd64.exe
```

Move the binary to a directory under your `%PATH%`.
Expand All @@ -97,7 +97,7 @@ Use <a href="https://curl.se" target="_blank" rel="noreferrer">curl</a> to downl
export OS="" # allowed values: darwin, linux, windows
export ARCH="" # allowed values: amd64, arm64, armv7
#export SUFFIX=".exe" # uncomment if OS is 'windows'
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.13.0/botkube-${OS}-${ARCH}${SUFFIX}
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-${OS}-${ARCH}${SUFFIX}
```

Move the binary to a directory under your `PATH`.
Expand Down
4 changes: 2 additions & 2 deletions docs/features/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ rbac:
verbs: ["get", "watch", "list"]
```

See the [`values.yaml`](https://github.com/kubeshop/botkube/blob/v1.13.0/helm/botkube/values.yaml) for more details.
See the [`values.yaml`](https://github.com/kubeshop/botkube/blob/v1.14.0/helm/botkube/values.yaml) for more details.

#### Defaults for user mapping when group mapping is used

Expand Down Expand Up @@ -134,7 +134,7 @@ executors:
This paragraph contains examples of RBAC configuration for different use cases.

:::tip
You can use `rbac.groups` or `extraObjects` overrides during Botkube installation to create custom RBAC resources. See the [`values.yaml`](https://github.com/kubeshop/botkube/blob/v1.13.0/helm/botkube/values.yaml) for more details.
You can use `rbac.groups` or `extraObjects` overrides during Botkube installation to create custom RBAC resources. See the [`values.yaml`](https://github.com/kubeshop/botkube/blob/v1.14.0/helm/botkube/values.yaml) for more details.
:::

### Kubectl executor with read-only Pod access based on static group mapping
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/discord/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ To deploy Botkube agent in your cluster, run:
export CLUSTER_NAME={cluster_name}
export ALLOW_KUBECTL={allow_kubectl}

botkube install --version v1.13.0 \
botkube install --version v1.14.0 \
--set communications.default-group.discord.enabled=true \
--set communications.default-group.discord.channels.default.id=${DISCORD_CHANNEL_ID} \
--set communications.default-group.discord.botID=${DISCORD_BOT_ID} \
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/elasticsearch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export ELASTICSEARCH_USERNAME={elasticsearch_username}
export ELASTICSEARCH_PASSWORD={elasticsearch_password}
export ELASTICSEARCH_INDEX_NAME={elasticsearch_index_name}

botkube install --version v1.13.0 \
botkube install --version v1.14.0 \
--set communications.default-group.elasticsearch.enabled=true \
--set communications.default-group.elasticsearch.server=${ELASTICSEARCH_ADDRESS} \
--set communications.default-group.elasticsearch.username=${ELASTICSEARCH_USERNAME} \
Expand Down
1 change: 0 additions & 1 deletion docs/installation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ You can enable multiple platform integrations using a single Botkube agent. <br/
{ name: "Slack", image: "/images/integrations/slack.svg", link: "installation/slack" },
{ name: "Mattermost", image: "/images/integrations/mattermost.svg", link: "installation/mattermost" },
{ name: "Discord", image: "/images/integrations/discord.svg", link: "installation/discord" },
{ name: "Teams", image: "/images/integrations/msteams.svg", link: "installation/teams" },
{ name: "Elasticsearch", image: "/images/integrations/elasticsearch.svg", link: "installation/elasticsearch" },
{ name: "Webhook", image: "/images/integrations/webhooks.svg", link: "installation/webhook" },
]}
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/mattermost/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export MATTERMOST_TEAM={mattermost_team_name}
export CLUSTER_NAME={cluster_name}
export ALLOW_KUBECTL={allow_kubectl}
botkube install --version v1.13.0 \
botkube install --version v1.14.0 \
--set communications.default-group.mattermost.enabled=true \
--set communications.default-group.mattermost.url=${MATTERMOST_SERVER_URL} \
--set communications.default-group.mattermost.token=${MATTERMOST_TOKEN} \
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/slack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export CLUSTER_NAME={cluster_name}
export ALLOW_KUBECTL={allow_kubectl}
export SLACK_CHANNEL_NAME={channel_name}
botkube install --version v1.13.0 \
botkube install --version v1.14.0 \
--set communications.default-group.socketSlack.enabled=true \
--set communications.default-group.socketSlack.channels.default.name=${SLACK_CHANNEL_NAME} \
--set communications.default-group.socketSlack.appToken=${SLACK_API_APP_TOKEN} \
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/webhook/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To deploy Botkube agent in your cluster, run:
export CLUSTER_NAME={cluster_name}
export WEBHOOK_URL={url}

botkube install --version v1.13.0 \
botkube install --version v1.14.0 \
--set communications.default-group.webhook.enabled=true \
--set communications.default-group.webhook.url=${WEBHOOK_URL} \
--set settings.clusterName=${CLUSTER_NAME}
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Kubectl plugin is hosted by the official Botkube plugin repository. First, m
plugins:
repositories:
botkube:
url: https://github.com/kubeshop/botkube/releases/download/v1.13.0/plugins-index.yaml
url: https://github.com/kubeshop/botkube/releases/download/v1.14.0/plugins-index.yaml
```
To enable Kubectl executor, add ``--set 'executors.k8s-default-tools.botkube/kubectl.enabled=true'` to a given Botkube [`install` command](../cli/commands/botkube_install.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Kubernetes plugin is hosted by the official Botkube plugin repository. First
plugins:
repositories:
botkube:
url: https://github.com/kubeshop/botkube/releases/download/v1.13.0/plugins-index.yaml
url: https://github.com/kubeshop/botkube/releases/download/v1.14.0/plugins-index.yaml
```

To enable Kubernetes source, add `--set 'sources.{configuration-name}.botkube/kubernetes.enabled=true'` to a given Botkube [`install` command](../cli/commands/botkube_install.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted-configuration/executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ healthCheckInterval: 10s
# Format: executors.{alias}
executors:
"tools":
botkube/echo@v1.13.0: # Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/echo@v1.14.0: # Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
enabled: true # If not enabled, plugin is not downloaded and started.
config: # Plugin's specific configuration.
changeResponseToUpperCase: true
Expand All @@ -104,7 +104,7 @@ plugins:
repositories:
# This repository serves officially supported Botkube plugins.
botkube:
url: https://github.com/kubeshop/botkube/releases/download/v1.13.0/plugins-index.yaml
url: https://github.com/kubeshop/botkube/releases/download/v1.14.0/plugins-index.yaml
# Other 3rd party repositories.
repo-name:
url: https://example.com/plugins-index.yaml
Expand Down
Loading
Loading