config

Documentation

Overview

Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Index

• Variables
• type CaptureConfig
• type Config
  • func GetConfig(cfgFilename string) (*Config, error)
• type RetinaHubbleConfig
  • func (c RetinaHubbleConfig) Flags(flags *pflag.FlagSet)
• type Server

Variables

var (
	DefaultRetinaHubbleConfig = RetinaHubbleConfig{
		MetricsBindAddress:     ":18000",
		HealthProbeBindAddress: ":18001",
		LeaderElection:         false,
		ClusterName:            "default",
	}

	DefaultRetinaConfig = &Config{
		EnableTelemetry:          false,
		EnabledPlugin:            []string{"packetforward", "dropreason", "linuxutil", "dns"},
		EnablePodLevel:           true,
		LogLevel:                 "info",
		BypassLookupIPOfInterest: true,
	}

	Cell = cell.Module(
		"agent-config",
		"Agent Config",

		cell.Provide(func() *option.DaemonConfig {
			return option.Config
		}),

		cell.Config(DefaultRetinaHubbleConfig),

		cell.Provide(func(logger logrus.FieldLogger) (Config, error) {
			retinaConfigFile := filepath.Join(option.Config.ConfigDir, configFileName)
			conf, err := GetConfig(retinaConfigFile)
			if err != nil {
				logger.Error(err)
				conf = DefaultRetinaConfig
			}
			logger.Info(conf)
			return *conf, nil
		}),
		sharedconfig.Cell,
	)
)

Types

type CaptureConfig

type CaptureConfig struct {
	// Configurations to determine the capture workload image.
	//
	// Debug indicates whether to enable debug mode.
	// If true, the operator will pick the image from the test container registry for the capture workload.
	// Check pkg/capture/utils/capture_image.go for the detailed explanation of how debug capture image version is picked.
	// NOTE: CaptureImageVersion and CaptureImageVersionSource are used internally and not visible to the user.
	CaptureDebug bool `yaml:"captureDebug"`
	// ImageVersion defines the image version of the capture workload.
	CaptureImageVersion string `yaml:"-"`
	// VersionSource defines the source of the image version.
	CaptureImageVersionSource captureUtils.VersionSource `yaml:"-"`

	// JobNumLimit indicates the maximum number of jobs that can be created for each Capture.
	CaptureJobNumLimit int `yaml:"captureJobNumLimit"`
}

CaptureConfig defines the configuration for capture controller in the operator.

type Config

type Config struct {
	ApiServer                Server        `yaml:"apiServer"`
	LogLevel                 string        `yaml:"logLevel"`
	EnabledPlugin            []string      `yaml:"enabledPlugin"`
	MetricsInterval          time.Duration `yaml:"metricsInterval"`
	EnableTelemetry          bool          `yaml:"enableTelemetry"`
	EnableRetinaEndpoint     bool          `yaml:"enableRetinaEndpoint"`
	EnablePodLevel           bool          `yaml:"enablePodLevel"`
	RemoteContext            bool          `yaml:"remoteContext"`
	EnableAnnotations        bool          `yaml:"enableAnnotations"`
	BypassLookupIPOfInterest bool          `yaml:"bypassLookupIPOfInterest"`
}

func GetConfig

func GetConfig(cfgFilename string) (*Config, error)

type RetinaHubbleConfig

type RetinaHubbleConfig struct {
	// NOTE: metrics-bind-address and health-probe-bind-address should be used ONLY as container args (NOT in ConfigMap) to keep parity with non-enterprise Retina
	MetricsBindAddress     string
	HealthProbeBindAddress string

	LeaderElection bool
	ClusterName    string // the name of the cluster (primarily used for TLS)
}

RetinaHubbleConfig is a collection of configuration information needed by Retina-services for proper functioning.

func (RetinaHubbleConfig) Flags

func (c RetinaHubbleConfig) Flags(flags *pflag.FlagSet)

Flags is responsible for binding flags provided by the user to the various fields of the Config.

type Server

type Server struct {
	Host string `yaml:"host"`
	Port int    `yaml:"port"`
}