config

Documentation

Index

• Variables
• type Communications
• type Config
  • func New() (*Config, error)
• type ElasticSearch
• type Index
• type K8SEvents
• type Mattermost
• type Resource
• type Settings
• type Slack

Variables

var ConfigFileName = "config.yaml"

ConfigFileName is a name of botkube configuration file

var Notify = true

Notify flag to toggle event notification

Types

type Communications

type Communications struct {
	Slack         Slack
	ElasticSearch ElasticSearch
	Mattermost    Mattermost
}

Communications channels to send events to

type Config

type Config struct {
	Resources       []Resource
	Recommendations bool
	Communications  Communications
	Events          K8SEvents
	Settings        Settings
}

Config structure of configuration yaml file

func New

func New() (*Config, error)

New returns new Config

type ElasticSearch

type ElasticSearch struct {
	Enabled  bool
	Username string
	Password string `yaml:",omitempty"`
	Server   string
	Index    Index
}

ElasticSearch config auth settings

type Index

type Index struct {
	Name     string
	Type     string
	Shards   int
	Replicas int
}

Index settings for ELS

type K8SEvents

type K8SEvents struct {
	Types []string
}

K8SEvents contains event types

type Mattermost

type Mattermost struct {
	Enabled bool
	URL     string
	Token   string
	Team    string
	Channel string
}

Mattermost configuration to authentication and send notifications

type Resource

type Resource struct {
	Name       string
	Namespaces []string
	Events     []string
}

Resource contains resources to watch

type Settings

type Settings struct {
	ClusterName  string
	AllowKubectl bool
}

Settings for multicluster support

type Slack

type Slack struct {
	Enabled bool
	Channel string
	Token   string `yaml:",omitempty"`
}

Slack configuration to authentication and send notifications