Skip to content

Issue 249 - OSS 1.5.0 release doc updates #250

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

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c04dbb4
updated
uma-kt Apr 3, 2025
1c54b58
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 3, 2025
a92970f
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 8, 2025
576f60d
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 8, 2025
75d0570
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 8, 2025
1ce19c3
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 8, 2025
65eb490
Merge branch 'master' of https://github.com/kubeslice/docs
uma-kt Apr 8, 2025
a25a0a8
added new version folder and config files
uma-kt Apr 14, 2025
48125eb
updated parameters in the controller values file
uma-kt Apr 14, 2025
1f02960
updated the release notes
uma-kt Apr 16, 2025
0005b38
updated the anchor links
uma-kt Apr 16, 2025
67bd060
updated the anchor links
uma-kt Apr 16, 2025
ea9a9e4
updated the anchor links
uma-kt Apr 16, 2025
ae31435
updated the configuration
uma-kt Apr 17, 2025
7bfd441
updated the release notes
uma-kt Apr 17, 2025
b1aea81
updated
uma-kt Apr 17, 2025
f03c8d0
updated
uma-kt Apr 17, 2025
4a4c926
updated
uma-kt Apr 17, 2025
51b927d
updated
uma-kt Apr 17, 2025
c082303
updated
uma-kt Apr 21, 2025
445115e
fixed review comments
uma-kt Apr 21, 2025
0326e62
fixed review comments
uma-kt Apr 21, 2025
05ea759
fixed review comments
uma-kt Apr 22, 2025
5155d13
fixed the review comments
uma-kt Apr 29, 2025
1bcb2a3
resolved merge conflicts
veenamj-avesha Jun 24, 2025
9584f35
ported FAQs into version 1.5.0
veenamj-avesha Jun 24, 2025
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: 6 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const config = {
'https://github.com/kubeslice/docs/tree/master/',
routeBasePath: '/',
includeCurrentVersion: false,
lastVersion: '1.4.0',
lastVersion: '1.5.0',
versions:{

/***
Expand All @@ -65,6 +65,11 @@ const config = {
* }
*
*/
'1.5.0':{
label: '1.5.0',
path: '1.5.0',
banner: 'none'
},
'1.4.0':{
label: '1.4.0',
path: '1.4.0',
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4,314 changes: 1,163 additions & 3,151 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/theme/DocVersionBanner/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,4 @@ export default function DocVersionBanner({className}) {
);
}
return null;
}
}
210 changes: 210 additions & 0 deletions versioned_docs/version-1.5.0/add-ons/add-ons-slack-events.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
# Slack Event Monitoring
In this topic, you discover the step-by-step process of creating a vibrant Slack app
and seamlessly integrating both kube-state-metrics (KSM) events and KubeSlice events into
a dynamic Slack channel. Unleash the power of real-time updates and vibrant notifications,
making your Slack workspace a hub of insightful information. Let's dive in and explore
this exciting integration journey!

## Create an App

Create an app using the Slack API in your workspace.

To create an app:

1. Open the [Slack API](https://api.slack.com/apps) console.

2. Click the **Create an App** button.

![events](/images/version-1.4.0/monitoring-events/kubernetes-events1.png)

3. Select **From an app manifest** to configure your app scopes and settings.

![events](/images/version-1.4.0/monitoring-events/kubernetes-events2.png)

4. Select a workspace where you want to create an app and click **Next**.

![events](/images/version-1.4.0/monitoring-events/kubernetes-events3.png)

5. In the **Enter app manifest below** section, click on the **YAML** tab and enter the following manifest:

```yaml
display_information:
name: Botkube
description: Botkube
background_color: "#a653a6"
features:
bot_user:
display_name: Botkube
always_online: false
oauth_config:
scopes:
bot:
- channels:read
- app_mentions:read
- chat:write
- files:write
- users:read # Remote configuration only: Used to get Real Name for audit reporting
settings:
event_subscriptions:
bot_events:
- app_mention
interactivity:
is_enabled: true
org_deploy_enabled: false
socket_mode_enabled: true
token_rotation_enabled: false
```

6. Click **Next**.

7. In the **Review summary & create your app** section, review the details and click **Create**.

![events](/images/version-1.4.0/monitoring-events/kubernetes-events4.png)


## Install an App

Once you have successfully created your app, you will be directed to an application details page that provides you with the option to install the app in your desired workspace.

To install an app to your workspace:

1. Go to **Settings** > **Basic Information** on the left sidebar.

2. In the **Building Apps for Slack** section, under **Install your app**, click the **Install to workspace** button.

3. Click **Allow** to finish the installation.


## Get an OAuth Token

During the configuration process of botkube in Slack, it is essential to provide the OAuth token for authentication purposes. This token serves as a secure credential that verifies the identity of the botkube integration and enables seamless communication between Slack and botkube.

To get an oauth token for your workspace:

1. Go to **Features** > **OAuth & Permissions** on the left sidebar.

2. Copy the **Bot User OAuth Token** and save the token for later use while deploying the
**kubeslice-botkube** bundle on the controller and worker clusters.

![events](/images/version-1.4.0/monitoring-events/bot-user-oauth-token.png)


## Get an App-Level Token

To establish a web socket connection with Slack App using Socket Mode, you need an
App-Level token. This token is specifically required to facilitate the communication and interaction between your Slack App and the web socket, ensuring a smooth and uninterrupted connection.

To get an app-level token:

1. Go to **Settings** > **Basic Information** on the left sidebar.

2. Click the **Generate Token and Scopes** button.

![events](/images/version-1.4.0/monitoring-events/app-level-token.png)

3. In the **Generate an app-level token** section, enter a token name. For example, `botkube` is a token name.

![events](/images/version-1.4.0/monitoring-events/generate-app-level-token.png)

4. Click **Add Scope** and select **connections:write scope**.

5. Click **Generate**.

6. Review the details and click **Done**. Copy the app-level token for later use while deploying the
**kubeslice-botkube** bundle on the controller and worker clusters.

## Create Slack Channel for Events

Once you have successfully installed the Botkube application, you will notice a new bot user named `botkube` added to your workspace.

Next, proceed to create **two channels** within your workspace to receive KSM and KubeSlice events. Save the channel names for later use.

![events](/images/version-1.4.0/monitoring-events/create-channel1.png)

To receive notifications in a specific Slack channel, you need to add the Botkube bot. This can be done by inviting the **@Botkube** user to the desired channel.

![events](/images/version-1.4.0/monitoring-events/add-bot-to-channel.png)



## Deploy the kubeslice-botkube Bundle

To deploy the **kubeslice-botkube** bundle:

1. Switch the context to controller cluster.

```
kubectx <cluster_name>
```

2. Add the **kubeslice-botkube** repo using the following command:

```
helm repo add kubeslice/botkube
```

3. Use the following command to create the `botkube` namespace on the controller and worker clusters.

```
kubectl create ns botkube
```

4. Use the following command to deploy the **kubeslice-botkube** bundle on the **controller cluster**:

:::note
Replace the `ksm_channel_name`, `kubeslice_event_channel_name`, `cluster_name`, `app_token`, and `bot_token` in the command below with your values.
:::

```
helm install kubeslice-botkube kubeslice/botkube --set "sources.k8s-controller-events.botkube/kubernetes.enabled=true" --namespace botkube \
--set communications.default-group.socketSlack.enabled=true \
--set communications.default-group.socketSlack.channels.default.name=<ksm_channel_name> \
--set communications.default-group.socketSlack.channels.kubeslice.name=<kubeslice_event_channel_name> \
--set communications.default-group.socketSlack.appToken=<app_token> \
--set communications.default-group.socketSlack.botToken=<bot_token> \
--set settings.clusterName=<cluster_name> \
--set 'executors.k8s-default-tools.botkube/kubectl.enabled'=true \
--set 'executors.k8s-default-tools.botkube/helm.enabled'=true
```

5. Switch the context to worker cluster(s).

```
kubectx <cluster_name>
```

6. Use the following command to deploy the **kubeslice-botkube** bundle on each of the **worker cluster(s)**:

:::note
Replace the `ksm_channel_name`, `kubeslice_event_channel_name`, `cluster_name`, `app_token`, and `bot_token` in the command below with your values.
:::

```
helm install kubeslice-botkube kubeslice/botkube --set "sources.k8s-worker-events.botkube/kubernetes.enabled=true" --namespace botkube \
--set communications.default-group.socketSlack.enabled=true \
--set communications.default-group.socketSlack.channels.default.name=<ksm_channel_name> \
--set communications.default-group.socketSlack.channels.kubeslice.name=<kubeslice_event_channel_name> \
--set communications.default-group.socketSlack.appToken=<app_token> \
--set communications.default-group.socketSlack.botToken=<bot_token> \
--set settings.clusterName=<cluster_name> \
--set 'executors.k8s-default-tools.botkube/kubectl.enabled'=true \
--set 'executors.k8s-default-tools.botkube/helm.enabled'=true
```

### Slack KSM Events

After deploying the charts in the workspace, you will start receiving notifications. The KSM events received in the Slack channel are depicted in the figures below:


![events](/images/version-1.4.0/monitoring-events/ksm-events.png)

### Slack KubeSlice Events
#### Controller Events
The Slack channel displays the KubeSlice events for the controller cluster, as depicted in the following figure.

![events](/images/version-1.4.0/monitoring-events/kubeslice-controller-events.png)

#### Worker Events
The Slack channel displays the KubeSlice events for the worker cluster, as depicted in the following figure.

![events](/images/version-1.4.0/monitoring-events/kubeslice-worker-events.png)
Loading
Loading