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.

Sign up for GitHub

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

docs: add ai scan command for cluster scan #336

Merged
merged 1 commit into from
May 28, 2024
Merged

docs: add ai scan command for cluster scan #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/plugins/ai-assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The plugin provides the following features:
- Agent status and configuration,
- the latest Botkube documentation and other Botkube content.
- Keeping conversation context in the message threads.
- Kubernetes cluster scan.

## Get started

Expand Down Expand Up @@ -69,6 +70,11 @@ Here are a few examples to get you started:
- `@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?`

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also list the cluster scan feature in the ## Features section?

### AI cluster scan

The assistant can help you troubleshoot the Kubernetes cluster by performing a cluster-wide scan for any potential issues,
such as failing pods, high resource usage, or any other anomalies. To start the scan, use the `@Botkube ai scan` command.

## Configuration

Currently, the AI plugin doesn't have any configuration options.
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-1.11/plugins/ai-assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The plugin provides the following features:
- Agent status and configuration,
- the latest Botkube documentation and other Botkube content.
- Keeping conversation context in the message threads.
- Kubernetes cluster scan.

## Get started

Expand Down Expand Up @@ -69,6 +70,11 @@ Here are a few examples to get you started:
- `@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?`

### AI cluster scan

The assistant can help you troubleshoot the Kubernetes cluster by performing a cluster-wide scan for any potential issues,
such as failing pods, high resource usage, or any other anomalies. To start the scan, use the `@Botkube ai scan` command.

## Configuration

Currently, the AI plugin doesn't have any configuration options.
Expand Down
Loading