diff --git a/docs/features/ai-assistant.mdx b/docs/features/ai-assistant.mdx new file mode 100644 index 00000000..8ed80ca9 --- /dev/null +++ b/docs/features/ai-assistant.mdx @@ -0,0 +1,14 @@ +--- +id: ai-assistant +title: AI Assistant +sidebar_position: 4 +--- + +import { Redirect } from "@docusaurus/router"; + + + +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). diff --git a/docs/features/rbac.md b/docs/features/rbac.md index d1e63539..a7b8cdcf 100644 --- a/docs/features/rbac.md +++ b/docs/features/rbac.md @@ -1,7 +1,7 @@ --- id: rbac title: RBAC -sidebar_position: 4 +sidebar_position: 5 --- Botkube allows plugins to access Kubernetes API by defining [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac) rules. diff --git a/docs/plugins/ai-assistant.mdx b/docs/plugins/ai-assistant.mdx index 1364c2d8..7b4dd519 100644 --- a/docs/plugins/ai-assistant.mdx +++ b/docs/plugins/ai-assistant.mdx @@ -8,7 +8,7 @@ sidebar_position: 3 **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 GPT-4o large language model with additional Kubernetes-related capabilities. +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 diff --git a/redirects.js b/redirects.js index 7bf84f2d..ba7461f4 100644 --- a/redirects.js +++ b/redirects.js @@ -66,8 +66,7 @@ function customRedirections() { { from: "/configuration/communication/", to: "/self-hosted-configuration/communication" }, { from: "/configuration/communication/vault-csi", to: "/self-hosted-configuration/communication/vault-csi" }, { from: "/configuration/executor/", to: "/plugins" }, - // TODO: add redirection on the second PR - // { from: "/configuration/executor/doctor", to: "/plugins/ai" }, + { from: "/configuration/executor/doctor", to: "/plugins/ai-assistant" }, { from: "/configuration/executor/exec", to: "/plugins/exec" }, { from: "/configuration/executor/flux", to: "/plugins/flux" }, { from: "/configuration/executor/helm", to: "/plugins/helm" }, @@ -85,8 +84,7 @@ function customRedirections() { { from: "/usage/automated-actions", to: "/features/actions" }, { from: "/usage/event-notifications", to: "/features/event-notifications" }, { from: "/usage/executor/", to: "/plugins" }, - // TODO: add redirection on the second PR - // { from: "/usage/executor/doctor", to: "/plugins/doctor" }, + { from: "/usage/executor/doctor", to: "/plugins/ai-assistant" }, { from: "/usage/executor/exec", to: "/plugins/exec" }, { from: "/usage/executor/flux", to: "/plugins/flux" }, { from: "/usage/executor/helm", to: "/plugins/helm" }, diff --git a/versioned_docs/version-1.11/features/ai-assistant.mdx b/versioned_docs/version-1.11/features/ai-assistant.mdx new file mode 100644 index 00000000..8ed80ca9 --- /dev/null +++ b/versioned_docs/version-1.11/features/ai-assistant.mdx @@ -0,0 +1,14 @@ +--- +id: ai-assistant +title: AI Assistant +sidebar_position: 4 +--- + +import { Redirect } from "@docusaurus/router"; + + + +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). diff --git a/versioned_docs/version-1.11/features/rbac.md b/versioned_docs/version-1.11/features/rbac.md index d1e63539..a7b8cdcf 100644 --- a/versioned_docs/version-1.11/features/rbac.md +++ b/versioned_docs/version-1.11/features/rbac.md @@ -1,7 +1,7 @@ --- id: rbac title: RBAC -sidebar_position: 4 +sidebar_position: 5 --- Botkube allows plugins to access Kubernetes API by defining [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac) rules. diff --git a/versioned_docs/version-1.11/plugins/ai-assistant.mdx b/versioned_docs/version-1.11/plugins/ai-assistant.mdx new file mode 100644 index 00000000..7b4dd519 --- /dev/null +++ b/versioned_docs/version-1.11/plugins/ai-assistant.mdx @@ -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"; + + + +### 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. diff --git a/versioned_docs/version-1.11/plugins/assets/ai-help-usage.png b/versioned_docs/version-1.11/plugins/assets/ai-help-usage.png new file mode 100644 index 00000000..f2ea6fae Binary files /dev/null and b/versioned_docs/version-1.11/plugins/assets/ai-help-usage.png differ