aibrain

Documentation

Index

• Constants
• Variables
• type BotkubeRunner
  • func NewBotkubeRunner(tracer trace.Tracer) (*BotkubeRunner, error)
  • func (r *BotkubeRunner) GetAgentStatus(ctx context.Context, _ []byte, _ *Payload) (string, error)
  • func (r *BotkubeRunner) GetStartupAgentConfiguration(ctx context.Context, _ []byte, p *Payload) (string, error)
• type Config
  • func (c *Config) Validate() error
• type ConfigWithDetails
• type KubectlRunner
  • func NewKubectlRunner(kubeconfigPath string, tracer trace.Tracer) *KubectlRunner
  • func (k *KubectlRunner) DescribeResource(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubectlRunner) GetEvents(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubectlRunner) GetResource(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubectlRunner) Logs(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubectlRunner) TopNodes(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubectlRunner) TopPods(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
• type KubescapeRunner
  • func NewKubescapeRunner(kubeconfigPath string, tracer trace.Tracer) *KubescapeRunner
  • func (k *KubescapeRunner) ScanCluster(ctx context.Context, _ []byte, _ *Payload) (string, error)
  • func (k *KubescapeRunner) ScanControl(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubescapeRunner) ScanImage(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
  • func (k *KubescapeRunner) ScanWorkload(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)
• type Payload
• type Source
  • func NewSource(version string) *Source
  • func (s *Source) HandleExternalRequest(ctx context.Context, in source.ExternalRequestInput) (source.ExternalRequestOutput, error)
  • func (s *Source) Metadata(context.Context) (api.MetadataOutput, error)
  • func (s *Source) Stream(ctx context.Context, in source.StreamInput) (source.StreamOutput, error)

Constants

const (
	PluginName = "ai-brain"
)

Variables

var (

	//go:embed config_schema.json
	ConfigJSONSchema string

	//go:embed webhook_schema.json
	IncomingWebhookJSONSchema string
)

Types

type BotkubeRunner

type BotkubeRunner struct {
	// contains filtered or unexported fields
}

BotkubeRunner is a runner that executes Botkube related commands.

func NewBotkubeRunner

func NewBotkubeRunner(tracer trace.Tracer) (*BotkubeRunner, error)

NewBotkubeRunner creates new runner instance.

func (*BotkubeRunner) GetAgentStatus

func (r *BotkubeRunner) GetAgentStatus(ctx context.Context, _ []byte, _ *Payload) (string, error)

GetAgentStatus returns Botkube Agent health status.

func (*BotkubeRunner) GetStartupAgentConfiguration

func (r *BotkubeRunner) GetStartupAgentConfiguration(ctx context.Context, _ []byte, p *Payload) (string, error)

GetStartupAgentConfiguration returns Botkube startup configuration.

type Config

type Config struct {
	Log                    config.Logger `yaml:"log"`
	OpenAIBaseURL          string        `yaml:"openAIBaseURL"`
	OpenAIAssistantID      string        `yaml:"openAIAssistantId"`
	HoneycombAPIKey        string        `yaml:"honeycombAPIKey"`
	HoneycombSampleRate    int           `yaml:"honeycombSampleRate"`
	VectorStoreIDForThread string        `yaml:"vectorStoreIDForThread"`
	Version                string
}

Config holds source configuration.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type ConfigWithDetails

type ConfigWithDetails struct {
	*config.Config           `yaml:",inline"`
	LoaderValidationWarnings string `yaml:"loaderValidationWarnings"`
	IncomingRequestPrompt    string `yaml:"incomingRequestPrompt,omitempty"`
}

ConfigWithDetails represents Botkube configuration with additional details.

type KubectlRunner

type KubectlRunner struct {
	// contains filtered or unexported fields
}

KubectlRunner is a runner that executes kubectl commands using a specific kubeconfig file.

func NewKubectlRunner

func NewKubectlRunner(kubeconfigPath string, tracer trace.Tracer) *KubectlRunner

NewKubectlRunner creates new runner instance.

func (*KubectlRunner) DescribeResource

func (k *KubectlRunner) DescribeResource(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

DescribeResource executes kubectl describe resource command.

func (*KubectlRunner) GetEvents

func (k *KubectlRunner) GetEvents(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

GetEvents executes kubectl get events command.

func (*KubectlRunner) GetResource

func (k *KubectlRunner) GetResource(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

GetResource executes kubectl get resource command.

func (*KubectlRunner) Logs

func (k *KubectlRunner) Logs(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

Logs executes kubectl logs command.

func (*KubectlRunner) TopNodes

func (k *KubectlRunner) TopNodes(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

TopNodes executes kubectl top nodes command.

func (*KubectlRunner) TopPods

func (k *KubectlRunner) TopPods(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

TopPods executes kubectl top pods command.

type KubescapeRunner

type KubescapeRunner struct {
	// contains filtered or unexported fields
}

func NewKubescapeRunner

func NewKubescapeRunner(kubeconfigPath string, tracer trace.Tracer) *KubescapeRunner

func (*KubescapeRunner) ScanCluster

func (k *KubescapeRunner) ScanCluster(ctx context.Context, _ []byte, _ *Payload) (string, error)

func (*KubescapeRunner) ScanControl

func (k *KubescapeRunner) ScanControl(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

func (*KubescapeRunner) ScanImage

func (k *KubescapeRunner) ScanImage(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

func (*KubescapeRunner) ScanWorkload

func (k *KubescapeRunner) ScanWorkload(ctx context.Context, rawArgs []byte, _ *Payload) (string, error)

type Payload

type Payload struct {
	Prompt    string `json:"prompt"`
	MessageID string `json:"messageId"`
}

Payload represents incoming webhook payload.

type Source

type Source struct {
	// contains filtered or unexported fields
}

Source implements AI source plugin.

func NewSource

func NewSource(version string) *Source

NewSource creates new source plugin instance.

func (*Source) HandleExternalRequest

func (s *Source) HandleExternalRequest(ctx context.Context, in source.ExternalRequestInput) (source.ExternalRequestOutput, error)

HandleExternalRequest handles incoming payload and returns an event based on it.

func (*Source) Metadata

func (s *Source) Metadata(context.Context) (api.MetadataOutput, error)

Metadata returns details about plugin.

func (*Source) Stream

func (s *Source) Stream(ctx context.Context, in source.StreamInput) (source.StreamOutput, error)

Stream implements Botkube source plugin.