dubbo_cp

Documentation

Index

• Variables
• type Config
  • func (c Config) GetEnvoyAdminPort() uint32
  • func (c Config) IsFederatedZoneCP() bool
  • func (c Config) IsNonFederatedZoneCP() bool
  • func (c *Config) PostProcess() error
  • func (c *Config) Sanitize()
  • func (c *Config) Validate() error
• type DDSEventBasedWatchdog
  • func DefaultEventBasedWatchdog() DDSEventBasedWatchdog
• type Defaults
  • func DefaultDefaultsConfig() *Defaults
• type GeneralConfig
  • func DefaultGeneralConfig() *GeneralConfig

Variables

var DefaultConfig = func() Config {
	return Config{
		BootstrapServer:       bootstrap.DefaultBootstrapServerConfig(),
		DeployMode:            core.UniversalMode,
		Mode:                  core.Zone,
		XdsServer:             xds.DefaultXdsServerConfig(),
		Store:                 store.DefaultStoreConfig(),
		Runtime:               runtime.DefaultRuntimeConfig(),
		Bufman:                bufman.DefaultBufmanConfig(),
		General:               DefaultGeneralConfig(),
		Defaults:              DefaultDefaultsConfig(),
		Multizone:             multizone.DefaultMultizoneConfig(),
		Diagnostics:           diagnostics.DefaultDiagnosticsConfig(),
		DpServer:              dp_server.DefaultDpServerConfig(),
		Admin:                 admin.DefaultAdminConfig(),
		DubboConfig:           dubbo.DefaultServiceNameMappingConfig(),
		EventBus:              eventbus.Default(),
		DDSEventBasedWatchdog: DefaultEventBasedWatchdog(),
	}
}

Types

type Config

type Config struct {
	// General configuration
	General *GeneralConfig `json:"general,omitempty"`
	// DeployMode Type, can be either "kubernetes" or "universal" and "half"
	DeployMode core.DeployMode `json:"deploy_mode,omitempty" envconfig:"DUBBO_DEPLOYMODE"`
	// Mode in which dubbo CP is running. Available values are: "test", "global", "zone"
	Mode core.CpMode `json:"mode" envconfig:"DUBBO_MODE"`
	// Configuration of Bootstrap Server, which provides bootstrap config to Dataplanes
	BootstrapServer *bootstrap.BootstrapServerConfig `json:"bootstrapServer,omitempty"`
	// Resource Store configuration
	Store *store.StoreConfig `json:"store,omitempty"`
	// Envoy XDS server configuration
	XdsServer *xds.XdsServerConfig `json:"xdsServer,omitempty"`
	// admin console configuration
	Admin *admin.Admin `json:"admin"`
	// DeployMode-specific configuration
	Runtime *runtime.RuntimeConfig `json:"runtime,omitempty"`
	// Multizone Config
	Multizone *multizone.MultizoneConfig `json:"multizone,omitempty"`
	// Default dubbo entities configuration
	Defaults *Defaults `json:"defaults,omitempty"`
	// Diagnostics configuration
	Diagnostics *diagnostics.DiagnosticsConfig `json:"diagnostics,omitempty"`
	// Proxy holds configuration for proxies
	Proxy xds.Proxy `json:"proxy"`
	// Dataplane Server configuration
	DpServer *dp_server.DpServerConfig `json:"dpServer"`
	// EventBus is a configuration of the event bus which is local to one instance of CP.
	EventBus eventbus.Config `json:"eventBus"`
	// SNP configuration
	DubboConfig           dubbo.DubboConfig     `json:"dubbo_config"`
	Bufman                bufman.Bufman         `json:"bufman"`
	DDSEventBasedWatchdog DDSEventBasedWatchdog `json:"dds_event_based_watchdog"`
}

func (Config) GetEnvoyAdminPort

func (c Config) GetEnvoyAdminPort() uint32

func (Config) IsFederatedZoneCP

func (c Config) IsFederatedZoneCP() bool

func (Config) IsNonFederatedZoneCP

func (c Config) IsNonFederatedZoneCP() bool

func (*Config) PostProcess

func (c *Config) PostProcess() error

func (*Config) Sanitize

func (c *Config) Sanitize()

func (*Config) Validate

func (c *Config) Validate() error

type DDSEventBasedWatchdog

type DDSEventBasedWatchdog struct {
	// How often we flush changes when experimental event based watchdog is used.
	FlushInterval config_types.Duration `json:"flushInterval" envconfig:"DUBBO_EXPERIMENTAL_DDS_EVENT_BASED_WATCHDOG_FLUSH_INTERVAL"`
	// How often we schedule full DDS resync when experimental event based watchdog is used.
	FullResyncInterval config_types.Duration `json:"fullResyncInterval" envconfig:"DUBBO_EXPERIMENTAL_DDS_EVENT_BASED_WATCHDOG_FULL_RESYNC_INTERVAL"`
	// If true, then initial full resync is going to be delayed by 0 to FullResyncInterval.
	DelayFullResync bool `json:"delayFullResync" envconfig:"DUBBO_EXPERIMENTAL_DDS_EVENT_BASED_WATCHDOG_DELAY_FULL_RESYNC"`
}

func DefaultEventBasedWatchdog

func DefaultEventBasedWatchdog() DDSEventBasedWatchdog

type Defaults

type Defaults struct {
	config.BaseConfig

	// If true, it skips creating the default Mesh
	SkipMeshCreation bool `json:"skipMeshCreation" envconfig:"DUBBO_DEFAULTS_SKIP_MESH_CREATION"`
}

func DefaultDefaultsConfig

func DefaultDefaultsConfig() *Defaults

type GeneralConfig

type GeneralConfig struct {
	config.BaseConfig

	// DNSCacheTTL represents duration for how long Dubbo CP will cache result of resolving dataplane's domain name
	DNSCacheTTL config_types.Duration `json:"dnsCacheTTL" envconfig:"DUBBO_GENERAL_DNS_CACHE_TTL"`
	// TlsCertFile defines a path to a file with PEM-encoded TLS cert that will be used across all the Dubbo Servers.
	TlsCertFile string `json:"tlsCertFile" envconfig:"DUBBO_GENERAL_TLS_CERT_FILE"`
	// TlsKeyFile defines a path to a file with PEM-encoded TLS key that will be used across all the Dubbo Servers.
	TlsKeyFile string `json:"tlsKeyFile" envconfig:"DUBBO_GENERAL_TLS_KEY_FILE"`
	// TlsMinVersion defines the minimum TLS version to be used
	TlsMinVersion string `json:"tlsMinVersion" envconfig:"DUBBO_GENERAL_TLS_MIN_VERSION"`
	// TlsMaxVersion defines the maximum TLS version to be used
	TlsMaxVersion string `json:"tlsMaxVersion" envconfig:"DUBBO_GENERAL_TLS_MAX_VERSION"`
	// TlsCipherSuites defines the list of ciphers to use
	TlsCipherSuites []string `json:"tlsCipherSuites" envconfig:"DUBBO_GENERAL_TLS_CIPHER_SUITES"`
	// WorkDir defines a path to the working directory
	// Dubbo stores in this directory autogenerated entities like certificates.
	// If empty then the working directory is $HOME/.dubbo
	WorkDir string `json:"workDir" envconfig:"DUBBO_GENERAL_WORK_DIR"`
}

func DefaultGeneralConfig

func DefaultGeneralConfig() *GeneralConfig