config

Documentation

Index

• type CloudEvent
• type Config
• type Diff
• type Discord
• type Flock
• type Handler
• type Hipchat
• type Lark
• type MSTeams
• type Mattermost
• type Message
• type NamespacesConfig
• type Resource
• type ResourceConfig
• type SMTP
• type SMTPAuth
• type Slack
• type SlackWebhook
• type Webhook

Types

type CloudEvent

type CloudEvent struct {
	Enabled bool
	Url     string
}

CloudEvent contains CloudEvent configuration

type Config

type Config struct {
	// Handlers know how to send notifications to specific services.
	Handler Handler

	// Resources to watch.
	Resource Resource

	// Configurations for namespaces ot watch or ignore
	NamespacesConfig NamespacesConfig
	// Message properties .
	Message Message
	// Diff properties .
	Diff Diff
}

Config struct contains statemonitor configuration

type Diff

type Diff struct {
	//IgnorePath for all resources
	IgnorePath []string
}

type Discord

type Discord struct {
	Enabled    bool
	WebhookURL string
}

type Flock

type Flock struct {
	Enabled bool
	// URL of the flock API.
	Url string
}

Flock contains flock configuration

type Handler

type Handler struct {
	Slack        Slack
	SlackWebhook SlackWebhook
	Hipchat      Hipchat
	Mattermost   Mattermost
	Flock        Flock
	Webhook      Webhook
	CloudEvent   CloudEvent
	MSTeams      MSTeams
	SMTP         SMTP
	Lark         Lark
	Discord      Discord
}

Handler contains handler configuration

type Hipchat

type Hipchat struct {
	Enabled bool
	// Hipchat token.
	Token string
	// Room name.
	Room string
	// URL of the hipchat server.
	Url string
}

Hipchat contains hipchat configuration

type Lark

type Lark struct {
	Enabled bool
	// Webhook URL.
	WebhookURL string
}

Lark contains lark configuration

type MSTeams

type MSTeams struct {
	Enabled bool
	// MSTeams API Webhook URL.
	WebhookURL string
}

MSTeams contains MSTeams configuration

type Mattermost

type Mattermost struct {
	Enabled  bool
	Channel  string
	Url      string
	Username string
}

Mattermost contains mattermost configuration

type Message

type Message struct {
	// Message title.
	Title string
}

Message contains message configuration.

type NamespacesConfig

type NamespacesConfig struct {
	// For watching specific namespaces, leave it empty for watching all.
	// this config is ignored when watching namespaces as resource
	Include []string
	// For ignoring specific namespaces
	Exclude []string
}

type Resource

type Resource struct {
	Deployment            ResourceConfig
	ReplicationController ResourceConfig
	ReplicaSet            ResourceConfig
	DaemonSet             ResourceConfig
	StatefulSet           ResourceConfig
	Services              ResourceConfig
	Pod                   ResourceConfig
	Job                   ResourceConfig
	Node                  ResourceConfig
	ClusterRole           ResourceConfig
	ClusterRoleBinding    ResourceConfig
	ServiceAccount        ResourceConfig
	PersistentVolume      ResourceConfig
	Namespace             ResourceConfig
	Secret                ResourceConfig
	ConfigMap             ResourceConfig
	Ingress               ResourceConfig
	HPA                   ResourceConfig
	Event                 ResourceConfig
	CoreEvent             ResourceConfig
}

Resource contains resource configuration

type ResourceConfig

type ResourceConfig struct {
	Enabled bool
	// process events based on its type
	//create, update, delete
	//if empty, all events will be processed
	IncludeEvenTypes []string
	IgnorePath       []string
}

type SMTP

type SMTP struct {
	Enabled bool
	// Destination e-mail address.
	To string
	// Sender e-mail address .
	From string
	// Smarthost, aka "SMTP server"; address of server used to send email.
	Smarthost string
	// Subject of the outgoing emails.
	Subject string
	// Extra e-mail headers to be added to all outgoing messages.
	Headers map[string]string
	// Authentication parameters.
	Auth SMTPAuth
	// If "true" forces secure SMTP protocol (AKA StartTLS).
	RequireTLS bool
	// SMTP hello field (optional)
	Hello string
}

SMTP contains SMTP configuration.

type SMTPAuth

type SMTPAuth struct {
	Enabled bool
	// Username for PLAN and LOGIN auth mechanisms.
	Username string
	// Password for PLAIN and LOGIN auth mechanisms.
	Password string
	// Identity for PLAIN auth mechanism
	Identity string
	// Secret for CRAM-MD5 auth mechanism
	Secret string
}

type Slack

type Slack struct {
	// Enable slack notifications.
	Enabled bool
	// Slack "legacy" API token.
	Token string
	// Slack channel.
	Channel string
}

Slack contains slack configuration

type SlackWebhook

type SlackWebhook struct {
	Enabled bool
	// Slack channel.
	Channel string
	// Slack Username.
	Username string
	// Slack Emoji.
	Emoji string
	// Slack Webhook Url.
	Slackwebhookurl string
}

SlackWebhook contains slack configuration

type Webhook

type Webhook struct {
	Enabled bool
	// Webhook URL.
	Url     string
	Cert    string
	TlsSkip bool
}

Webhook contains webhook configuration