store

Documentation

Index

• type CacheStoreConfig
  • func DefaultCacheStoreConfig() CacheStoreConfig
  • func (c CacheStoreConfig) Sanitize()
  • func (c CacheStoreConfig) Validate() error
• type StoreConfig
  • func DefaultStoreConfig() *StoreConfig
  • func (s *StoreConfig) Sanitize()
  • func (s *StoreConfig) Validate() error
• type StoreType
• type UpsertConfig
  • func DefaultUpsertConfig() UpsertConfig
  • func (u *UpsertConfig) Sanitize()
  • func (u *UpsertConfig) Validate() error

Types

type CacheStoreConfig

type CacheStoreConfig struct {
	Enabled        bool          `yaml:"enabled" envconfig:"kuma_store_cache_enabled"`
	ExpirationTime time.Duration `yaml:"expirationTime" envconfig:"kuma_store_cache_expiration_time"`
}

func DefaultCacheStoreConfig

func DefaultCacheStoreConfig() CacheStoreConfig

func (CacheStoreConfig) Sanitize

func (c CacheStoreConfig) Sanitize()

func (CacheStoreConfig) Validate

func (c CacheStoreConfig) Validate() error

type StoreConfig

type StoreConfig struct {
	// Type of Store used in the Control Plane. Can be either "kubernetes", "postgres" or "memory"
	Type StoreType `yaml:"type" envconfig:"kuma_store_type"`
	// Postgres Store configuration
	Postgres *postgres.PostgresStoreConfig `yaml:"postgres"`
	// Kubernetes Store configuration
	Kubernetes *k8s.KubernetesStoreConfig `yaml:"kubernetes"`
	// Cache configuration
	Cache CacheStoreConfig `yaml:"cache"`
	// Upsert configuration
	Upsert UpsertConfig `yaml:"upsert"`
	// UnsafeDelete skips validation of resource delete.
	// For example you don't have to delete all Dataplane objects before you delete a Mesh
	UnsafeDelete bool `yaml:"unsafeDelete" envconfig:"kuma_store_unsafe_delete"`
}

Resource Store configuration

func DefaultStoreConfig

func DefaultStoreConfig() *StoreConfig

func (*StoreConfig) Sanitize

func (s *StoreConfig) Sanitize()

func (*StoreConfig) Validate

func (s *StoreConfig) Validate() error

type StoreType

type StoreType = string

const (
	KubernetesStore StoreType = "kubernetes"
	PostgresStore   StoreType = "postgres"
	MemoryStore     StoreType = "memory"
)

type UpsertConfig

type UpsertConfig struct {
	// Base time for exponential backoff on upsert (get and update) operations when retry is enabled
	ConflictRetryBaseBackoff time.Duration `yaml:"conflictRetryBaseBackoff" envconfig:"kuma_store_upsert_conflict_retry_base_backoff"`
	// Max retries on upsert (get and update) operation when retry is enabled
	ConflictRetryMaxTimes uint `yaml:"conflictRetryMaxTimes" envconfig:"kuma_store_upsert_conflict_retry_max_times"`
}

func DefaultUpsertConfig

func DefaultUpsertConfig() UpsertConfig

func (*UpsertConfig) Sanitize

func (u *UpsertConfig) Sanitize()

func (*UpsertConfig) Validate

func (u *UpsertConfig) Validate() error