Skip to content

Commit

Permalink
Use official Botkube app for Microsoft Teams in docs (#330)
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec authored May 20, 2024
1 parent dbf9742 commit c386720
Show file tree
Hide file tree
Showing 39 changed files with 93 additions and 195 deletions.
Binary file modified docs/installation/teams/assets/cloud_teams_add_app.png
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.
Binary file modified docs/installation/teams/assets/cloud_teams_download_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 13 additions & 25 deletions docs/installation/teams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ title: "Microsoft Teams"
sidebar_position: 5
---

## Botkube Cloud Microsoft Teams App
## Botkube app for Microsoft Teams

The Botkube Cloud Microsoft Teams app offers several advanced features:
The Botkube app for Microsoft Teams offers several advanced features:

- Simplified installation into your Microsoft Teams workspace
- Multi-cluster executor support with a single Microsoft Teams app
- Manage Teams channels directly from the Botkube web app and ensure the Botkube bot is invited to the correct channels

The Botkube Cloud Microsoft Teams app uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.
The Botkube app for Microsoft Teams uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.

You can directly try Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.
You can directly try Botkube app for Microsoft Teams for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.

## Prerequisites

- A Botkube Cloud account.

You can try out the Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).
You can try out the Botkube app for Microsoft Teams for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).

## Create a Botkube Cloud Instance with Microsoft Teams

Expand All @@ -40,30 +40,18 @@ You can directly try Botkube Cloud Microsoft Teams app for free by creating an a

Proceed with the next section.

### Install Botkube app to your Microsoft Teams organization and add it to your team
### Install Botkube app to your team

1. Download the Botkube Cloud Microsoft Teams app by clicking the `Download Botkube App for Teams` button.
1. Install Botkube app for Microsoft Teams from the official app catalog by clicking the `Install Botkube App for Teams` button.

![Download Teams App](assets/cloud_teams_download_app.png "Download Teams App")
![Install Botkube App for Microsoft Teams](assets/cloud_teams_download_app.png "Install Botkube App for Microsoft Teams")

1. Sideload the Botkube app to your Microsoft Teams organization via Teams Admin Center, following the [official documentation](https://learn.microsoft.com/en-us/microsoftteams/teams-custom-app-policies-and-settings#upload-a-custom-app-using-teams-admin-center).
Alternatively, you can search for the "Botkube" app in the Microsoft Teams app catalog and click the **Add** button.

:::info
This step requires administrator permissions on your Microsoft Teams organization. Sideloading app is needed only once for the whole organization.
:::

- Ensure the Botkube app is allowed for the organization in the [Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps)

![Teams Admin Center](assets/cloud_teams_admin_center.png "Teams Admin Center")
![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Add the Botkube app to your team.

1. In your Microsoft Teams application, navigate to the **Apps** tab.
1. Select the **Built for your organization** tab.
1. On the Botkube app card, click on the **Add** button.

![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Click the **Add to a team** button.

![Add app to team](assets/cloud_teams_botkube_app_add.png "Add app to team")
Expand Down Expand Up @@ -137,7 +125,7 @@ Go back to the Botkube Cloud instance creation.

![Microsoft Teams Create](assets/cloud_teams_create.png "Microsoft Teams create")

## Using Botkube Cloud Microsoft Teams App
## Using Botkube app for Microsoft Teams

You can start using Botkube Cloud Microsoft Teams by typing `@Botkube cloud help` in one of the channels in the team you configured in one of the previous steps.

Expand Down Expand Up @@ -178,12 +166,12 @@ After this point, all of your commands will be executed on the default instance.

### RBAC `ChannelName` mapping

Same as other communication platforms, Botkube Cloud Microsoft Teams app supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
Same as other communication platforms, Botkube app for Microsoft Teams supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
However, because of the Microsoft Teams API limitation, for the default team channel the `ChannelName` is always `General`, regardless of the actual localized channel name.

## Limitations

Botkube Cloud Microsoft Teams App currently doesn't support the following features yet:
Botkube app for Microsoft Teams currently doesn't support the following features yet:

- Processing states from selected dropdowns, e.g., used for the `kubectl` command builder. In a result, the command builder is not available.
- Adding 👀 and ✅ reactions to messages indicating process status.
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.
50 changes: 16 additions & 34 deletions versioned_docs/version-1.10/installation/teams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,54 @@ title: "Microsoft Teams"
sidebar_position: 5
---

:::info

The previous Microsoft Teams integration has been deprecated. If you need to use the legacy Microsoft Teams integration, see the [Botkube 1.5 Documentation](https://969c27c7.botkube-docs-58l.pages.dev/1.5/installation/teams/). It is recommended to migrate to the new Microsoft Teams app per the below instructions.

:::

## Botkube Cloud Microsoft Teams App
## Botkube app for Microsoft Teams

The Botkube Cloud Microsoft Teams app offers several advanced features:
The Botkube app for Microsoft Teams offers several advanced features:

- Simplified installation into your Microsoft Teams workspace
- Multi-cluster executor support with a single Microsoft Teams app
- Manage Teams channels directly from the Botkube web app and ensure the Botkube bot is invited to the correct channels

The Botkube Cloud Microsoft Teams app uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.
The Botkube app for Microsoft Teams uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.

You can directly try Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.
You can directly try Botkube app for Microsoft Teams for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.

## Prerequisites

- A Botkube Cloud account.

You can try out the Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).
You can try out the Botkube app for Microsoft Teams for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).

## Create a Botkube Cloud Instance with Microsoft Teams

### Connect Botkube Cloud to your Kubernetes cluster

1. Go to Botkube Cloud [Web App](https://app.botkube.io/) and click on `New Instance` button.

![New Instance](assets/cloud_teams_new_instance.png "Create new instance")
![New Instance](../assets/cloud_new_instance.png "Create new instance")

1. Install Botkube Agent on your Kubernetes cluster by following the instructions on the page.

![Install Agent](assets/cloud_teams_install.png "Install Agent")
![Install Agent](../assets/cloud_install.png "Install Agent")

1. Click `Add platform` dropdown, and select `Teams` option.

![Teams Platform Select](assets/cloud_teams_select_platform.png "Select Teams platform")

Proceed with the next section.

### Install Botkube app to your Microsoft Teams organization and add it to your team
### Install Botkube app to your team

1. Download the Botkube Cloud Microsoft Teams app by clicking the `Download Botkube App for Teams` button.
1. Install Botkube app for Microsoft Teams from the official app catalog by clicking the `Install Botkube App for Teams` button.

![Download Teams App](assets/cloud_teams_download_app.png "Download Teams App")
![Install Botkube App for Microsoft Teams](assets/cloud_teams_download_app.png "Install Botkube App for Microsoft Teams")

1. Sideload the Botkube app to your Microsoft Teams organization via Teams Admin Center, following the [official documentation](https://learn.microsoft.com/en-us/microsoftteams/teams-custom-app-policies-and-settings#upload-a-custom-app-using-teams-admin-center).
Alternatively, you can search for the "Botkube" app in the Microsoft Teams app catalog and click the **Add** button.

:::info
This step requires administrator permissions on your Microsoft Teams organization. Sideloading app is needed only once for the whole organization.
:::

- Ensure the Botkube app is allowed for the organization in the [Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps)

![Teams Admin Center](assets/cloud_teams_admin_center.png "Teams Admin Center")
![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Add the Botkube app to your team.

1. In your Microsoft Teams application, navigate to the **Apps** tab.
1. Select the **Built for your organization** tab.
1. On the Botkube app card, click on the **Add** button.

![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Click the **Add to a team** button.

![Add app to team](assets/cloud_teams_botkube_app_add.png "Add app to team")
Expand Down Expand Up @@ -143,7 +125,7 @@ Go back to the Botkube Cloud instance creation.

![Microsoft Teams Create](assets/cloud_teams_create.png "Microsoft Teams create")

## Using Botkube Cloud Microsoft Teams App
## Using Botkube app for Microsoft Teams

You can start using Botkube Cloud Microsoft Teams by typing `@Botkube cloud help` in one of the channels in the team you configured in one of the previous steps.

Expand Down Expand Up @@ -178,18 +160,18 @@ After this point, all of your commands will be executed on the default instance.
Remember to execute the displayed command to completely remove Botkube and related resources from your cluster.
:::

![Cloud Teams Instance Delete](assets/cloud_teams_instance_delete.png "Cloud Microsoft Teams instances delete")
![Cloud Teams Instance Delete](../assets/cloud_instance_delete.png "Cloud Microsoft Teams instances delete")

## Caveats

### RBAC `ChannelName` mapping

Same as other communication platforms, Botkube Cloud Microsoft Teams app supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
Same as other communication platforms, Botkube app for Microsoft Teams supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
However, because of the Microsoft Teams API limitation, for the default team channel the `ChannelName` is always `General`, regardless of the actual localized channel name.

## Limitations

Botkube Cloud Microsoft Teams App currently doesn't support the following features yet:
Botkube app for Microsoft Teams currently doesn't support the following features yet:

- Processing states from selected dropdowns, e.g., used for the `kubectl` command builder. In a result, the command builder is not available.
- Adding 👀 and ✅ reactions to messages indicating process status.
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.
50 changes: 16 additions & 34 deletions versioned_docs/version-1.11/installation/teams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,54 @@ title: "Microsoft Teams"
sidebar_position: 5
---

:::info

The previous Microsoft Teams integration has been deprecated. If you need to use the legacy Microsoft Teams integration, see the [Botkube 1.5 Documentation](https://969c27c7.botkube-docs-58l.pages.dev/1.5/installation/teams/). It is recommended to migrate to the new Microsoft Teams app per the below instructions.

:::

## Botkube Cloud Microsoft Teams App
## Botkube app for Microsoft Teams

The Botkube Cloud Microsoft Teams app offers several advanced features:
The Botkube app for Microsoft Teams offers several advanced features:

- Simplified installation into your Microsoft Teams workspace
- Multi-cluster executor support with a single Microsoft Teams app
- Manage Teams channels directly from the Botkube web app and ensure the Botkube bot is invited to the correct channels

The Botkube Cloud Microsoft Teams app uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.
The Botkube app for Microsoft Teams uses Botkube's cloud services to manage channels and route source events and executor commands. Currently, it requires a manual side-loading of the app, but we are working on getting it listed in Microsoft AppSource.

You can directly try Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.
You can directly try Botkube app for Microsoft Teams for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app.

## Prerequisites

- A Botkube Cloud account.

You can try out the Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).
You can try out the Botkube app for Microsoft Teams for free by creating an account in the [Botkube Cloud app](https://app.botkube.io).

## Create a Botkube Cloud Instance with Microsoft Teams

### Connect Botkube Cloud to your Kubernetes cluster

1. Go to Botkube Cloud [Web App](https://app.botkube.io/) and click on `New Instance` button.

![New Instance](assets/cloud_teams_new_instance.png "Create new instance")
![New Instance](../assets/cloud_new_instance.png "Create new instance")

1. Install Botkube Agent on your Kubernetes cluster by following the instructions on the page.

![Install Agent](assets/cloud_teams_install.png "Install Agent")
![Install Agent](../assets/cloud_install.png "Install Agent")

1. Click `Add platform` dropdown, and select `Teams` option.

![Teams Platform Select](assets/cloud_teams_select_platform.png "Select Teams platform")

Proceed with the next section.

### Install Botkube app to your Microsoft Teams organization and add it to your team
### Install Botkube app to your team

1. Download the Botkube Cloud Microsoft Teams app by clicking the `Download Botkube App for Teams` button.
1. Install Botkube app for Microsoft Teams from the official app catalog by clicking the `Install Botkube App for Teams` button.

![Download Teams App](assets/cloud_teams_download_app.png "Download Teams App")
![Install Botkube App for Microsoft Teams](assets/cloud_teams_download_app.png "Install Botkube App for Microsoft Teams")

1. Sideload the Botkube app to your Microsoft Teams organization via Teams Admin Center, following the [official documentation](https://learn.microsoft.com/en-us/microsoftteams/teams-custom-app-policies-and-settings#upload-a-custom-app-using-teams-admin-center).
Alternatively, you can search for the "Botkube" app in the Microsoft Teams app catalog and click the **Add** button.

:::info
This step requires administrator permissions on your Microsoft Teams organization. Sideloading app is needed only once for the whole organization.
:::

- Ensure the Botkube app is allowed for the organization in the [Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps)

![Teams Admin Center](assets/cloud_teams_admin_center.png "Teams Admin Center")
![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Add the Botkube app to your team.

1. In your Microsoft Teams application, navigate to the **Apps** tab.
1. Select the **Built for your organization** tab.
1. On the Botkube app card, click on the **Add** button.

![Add Botkube App](assets/cloud_teams_add_app.png "Add Botkube App")

1. Click the **Add to a team** button.

![Add app to team](assets/cloud_teams_botkube_app_add.png "Add app to team")
Expand Down Expand Up @@ -143,7 +125,7 @@ Go back to the Botkube Cloud instance creation.

![Microsoft Teams Create](assets/cloud_teams_create.png "Microsoft Teams create")

## Using Botkube Cloud Microsoft Teams App
## Using Botkube app for Microsoft Teams

You can start using Botkube Cloud Microsoft Teams by typing `@Botkube cloud help` in one of the channels in the team you configured in one of the previous steps.

Expand Down Expand Up @@ -178,18 +160,18 @@ After this point, all of your commands will be executed on the default instance.
Remember to execute the displayed command to completely remove Botkube and related resources from your cluster.
:::

![Cloud Teams Instance Delete](assets/cloud_teams_instance_delete.png "Cloud Microsoft Teams instances delete")
![Cloud Teams Instance Delete](../assets/cloud_instance_delete.png "Cloud Microsoft Teams instances delete")

## Caveats

### RBAC `ChannelName` mapping

Same as other communication platforms, Botkube Cloud Microsoft Teams app supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
Same as other communication platforms, Botkube app for Microsoft Teams supports RBAC along with [all mappings](../../configuration/rbac.md#mapping-types).
However, because of the Microsoft Teams API limitation, for the default team channel the `ChannelName` is always `General`, regardless of the actual localized channel name.

## Limitations

Botkube Cloud Microsoft Teams App currently doesn't support the following features yet:
Botkube app for Microsoft Teams currently doesn't support the following features yet:

- Processing states from selected dropdowns, e.g., used for the `kubectl` command builder. In a result, the command builder is not available.
- Adding 👀 and ✅ reactions to messages indicating process status.
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

0 comments on commit c386720

Please sign in to comment.