-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce AI Assistant documentation (#333)
* Introduce AI Assistant documentation * Add redirect to the AI assistant plugin docs
- Loading branch information
Showing
11 changed files
with
190 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
id: ai-assistant | ||
title: AI Assistant | ||
sidebar_position: 4 | ||
--- | ||
|
||
import { Redirect } from "@docusaurus/router"; | ||
|
||
<Redirect to="/plugins/ai-assistant" /> | ||
|
||
Botkube AI Assistant capabilities are delivered in a form of a Botkube plugin. | ||
|
||
Redirecting to the Botkube AI Assistant plugin documentation. | ||
If you are not redirected automatically, click [here](../plugins/ai-assistant.mdx). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
id: ai-assistant | ||
title: "AI Assistant" | ||
sidebar_position: 3 | ||
--- | ||
|
||
:::info | ||
**This plugin is hosted by the [Botkube Cloud](https://app.botkube.io) plugin repository and requires active Botkube Cloud account.** | ||
::: | ||
|
||
The AI Assistant plugin makes it easier than ever for teams to identify, diagnose, and troubleshoot issues in any Kubernetes cluster. It is powered by the OpenAI's `GPT-4o` large language model with additional Kubernetes-related capabilities. | ||
|
||
## Features | ||
|
||
The plugin provides the following features: | ||
|
||
- "AI Help" button for Kubernetes event analysis. | ||
- Answering arbitrary questions or instructions. | ||
- Kubernetes cluster troubleshooting based on: | ||
- `kubectl` commands, | ||
- container logs, | ||
- Kubernetes events, | ||
- resource usage (CPU/memory). | ||
- Answering Botkube questions or instructions based on: | ||
- Agent status and configuration, | ||
- the latest Botkube documentation and other Botkube content. | ||
- Keeping conversation context in the message threads. | ||
|
||
## Get started | ||
|
||
## Enable the plugin | ||
|
||
You can enable the plugin as a part of Botkube instance configuration. | ||
|
||
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs. | ||
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance. | ||
3. Navigate to the platform tab which you want to configure. | ||
4. Click **Add plugin** button. | ||
5. Select the AI plugin. | ||
6. Click **Save** button. | ||
|
||
## Usage | ||
|
||
### Highlights | ||
|
||
To see the AI assistant in action, watch the video: | ||
|
||
import ReactPlayer from "react-player"; | ||
|
||
<ReactPlayer controls url="https://www.youtube.com/watch?v=VzXUL7rch-4" /> | ||
|
||
### AI Help for Kubernetes events | ||
|
||
Click on the **AI Help** button to get an analysis of the event. | ||
|
||
![AI Help](assets/ai-help-usage.png "AI Help") | ||
|
||
### AI questions and instructions | ||
|
||
To ask the Botkube AI Assistant any question, use the `@Botkube ai` command prefix. | ||
|
||
Here are a few examples to get you started: | ||
|
||
- `@Botkube ai are my pods in default namespace up and running?` | ||
- `@Botkube ai how many nodes are there?` | ||
- `@Botkube ai output a yaml for Kubernetes pod with nginx image` | ||
- `@Botkube what's the current Botkube status?` | ||
- `@Botkube ai what's the difference between Botkube sources and executors?` | ||
- `@Botkube ai what Botkube plugins are available to install? List all of them with one sentence description and link to the docs.` | ||
- `@Botkube ai who's the Botkube maintainer?` | ||
|
||
## Configuration | ||
|
||
Currently, the AI plugin doesn't have any configuration options. | ||
|
||
## Limitations | ||
|
||
- The conversation context is stored in-memory and will be cleared on Botkube Agent restart. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
id: ai-assistant | ||
title: AI Assistant | ||
sidebar_position: 4 | ||
--- | ||
|
||
import { Redirect } from "@docusaurus/router"; | ||
|
||
<Redirect to="/plugins/ai-assistant" /> | ||
|
||
Botkube AI Assistant capabilities are delivered in a form of a Botkube plugin. | ||
|
||
Redirecting to the Botkube AI Assistant plugin documentation. | ||
If you are not redirected automatically, click [here](../plugins/ai-assistant.mdx). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
id: ai-assistant | ||
title: "AI Assistant" | ||
sidebar_position: 3 | ||
--- | ||
|
||
:::info | ||
**This plugin is hosted by the [Botkube Cloud](https://app.botkube.io) plugin repository and requires active Botkube Cloud account.** | ||
::: | ||
|
||
The AI Assistant plugin makes it easier than ever for teams to identify, diagnose, and troubleshoot issues in any Kubernetes cluster. It is powered by the OpenAI's `GPT-4o` large language model with additional Kubernetes-related capabilities. | ||
|
||
## Features | ||
|
||
The plugin provides the following features: | ||
|
||
- "AI Help" button for Kubernetes event analysis. | ||
- Answering arbitrary questions or instructions. | ||
- Kubernetes cluster troubleshooting based on: | ||
- `kubectl` commands, | ||
- container logs, | ||
- Kubernetes events, | ||
- resource usage (CPU/memory). | ||
- Answering Botkube questions or instructions based on: | ||
- Agent status and configuration, | ||
- the latest Botkube documentation and other Botkube content. | ||
- Keeping conversation context in the message threads. | ||
|
||
## Get started | ||
|
||
## Enable the plugin | ||
|
||
You can enable the plugin as a part of Botkube instance configuration. | ||
|
||
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs. | ||
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance. | ||
3. Navigate to the platform tab which you want to configure. | ||
4. Click **Add plugin** button. | ||
5. Select the AI plugin. | ||
6. Click **Save** button. | ||
|
||
## Usage | ||
|
||
### Highlights | ||
|
||
To see the AI assistant in action, watch the video: | ||
|
||
import ReactPlayer from "react-player"; | ||
|
||
<ReactPlayer controls url="https://www.youtube.com/watch?v=VzXUL7rch-4" /> | ||
|
||
### AI Help for Kubernetes events | ||
|
||
Click on the **AI Help** button to get an analysis of the event. | ||
|
||
![AI Help](assets/ai-help-usage.png "AI Help") | ||
|
||
### AI questions and instructions | ||
|
||
To ask the Botkube AI Assistant any question, use the `@Botkube ai` command prefix. | ||
|
||
Here are a few examples to get you started: | ||
|
||
- `@Botkube ai are my pods in default namespace up and running?` | ||
- `@Botkube ai how many nodes are there?` | ||
- `@Botkube ai output a yaml for Kubernetes pod with nginx image` | ||
- `@Botkube what's the current Botkube status?` | ||
- `@Botkube ai what's the difference between Botkube sources and executors?` | ||
- `@Botkube ai what Botkube plugins are available to install? List all of them with one sentence description and link to the docs.` | ||
- `@Botkube ai who's the Botkube maintainer?` | ||
|
||
## Configuration | ||
|
||
Currently, the AI plugin doesn't have any configuration options. | ||
|
||
## Limitations | ||
|
||
- The conversation context is stored in-memory and will be cleared on Botkube Agent restart. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.