kubernetes

Documentation

Overview

Package kubernetes implements a discovery.kubernetes component.

Index

• Variables
• func New(opts component.Options, args Arguments) (*discovery.Component, error)
• type Arguments
  • func (args *Arguments) Convert() *promk8s.SDConfig
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type AttachMetadataConfig
• type NamespaceDiscovery
• type SelectorConfig

Variables

var DefaultConfig = Arguments{
	HTTPClientConfig: config.DefaultHTTPClientConfig,
}

DefaultConfig holds defaults for SDConfig.

Functions

func New

func New(opts component.Options, args Arguments) (*discovery.Component, error)

New returns a new instance of a discovery.kubernetes component.

Types

type Arguments

type Arguments struct {
	APIServer          config.URL              `river:"api_server,attr,optional"`
	Role               string                  `river:"role,attr"`
	KubeConfig         string                  `river:"kubeconfig_file,attr,optional"`
	HTTPClientConfig   config.HTTPClientConfig `river:",squash"`
	NamespaceDiscovery NamespaceDiscovery      `river:"namespaces,block,optional"`
	Selectors          []SelectorConfig        `river:"selectors,block,optional"`
	AttachMetadata     AttachMetadataConfig    `river:"attach_metadata,block,optional"`
}

Arguments configures the discovery.kubernetes component.

func (*Arguments) Convert

func (args *Arguments) Convert() *promk8s.SDConfig

Convert converts Arguments to the Prometheus SD type.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements river.Validator.

type AttachMetadataConfig

type AttachMetadataConfig struct {
	Node bool `river:"node,attr,optional"`
}

type NamespaceDiscovery

type NamespaceDiscovery struct {
	IncludeOwnNamespace bool     `river:"own_namespace,attr,optional"`
	Names               []string `river:"names,attr,optional"`
}

NamespaceDiscovery configures filtering rules for which namespaces to discover.

type SelectorConfig

type SelectorConfig struct {
	Role  string `river:"role,attr"`
	Label string `river:"label,attr,optional"`
	Field string `river:"field,attr,optional"`
}

SelectorConfig configures selectors to filter resources to discover.