overlay

Documentation

Index

• Constants
• type Conf
  • func GetConf() (*Conf, error)
  • func (conf *Conf) Key() string
  • func (conf *Conf) SetDefaults()
  • func (conf *Conf) Validate() error
• type Overlay
• type Store
  • func NewStore(ctx context.Context, conf *Conf, confW *config.Wrapper) (*Store, error)
  • func (s *Store) Close() (outErr error)
  • func (s *Store) Driver() string
  • func (s *Store) GetFirstMatch(ctx context.Context, candidates []namer.ModuleID) (*runtimev1.RunnablePolicySet, error)
  • func (s *Store) GetOverlayPolicyLoader(ctx context.Context, schemaMgr schema.Manager) (engine.PolicyLoader, error)
  • func (s *Store) InspectPolicies(ctx context.Context, params storage.ListPolicyIDsParams) (map[string]*responsev1.InspectPoliciesResponse_Result, error)
  • func (s *Store) ListPolicyIDs(ctx context.Context, params storage.ListPolicyIDsParams) ([]string, error)
  • func (s *Store) ListSchemaIDs(ctx context.Context) ([]string, error)
  • func (s *Store) LoadSchema(ctx context.Context, url string) (io.ReadCloser, error)
  • func (s *Store) Reload(ctx context.Context) error

Constants

const DriverName = "overlay"

Types

type Conf

type Conf struct {
	// BaseDriver is the default storage driver
	BaseDriver string `yaml:"baseDriver" conf:"required,example=blob"`
	// FallbackDriver is the secondary or fallback storage driver
	FallbackDriver string `yaml:"fallbackDriver" conf:"required,example=disk"`
	// FallbackErrorThreshold is the max number of errors we allow within the fallbackErrorWindow period
	FallbackErrorThreshold int `yaml:"fallbackErrorThreshold,omitempty" conf:",example=5"`
	// FallbackErrorWindow is the cyclic period within which we aggregate failures
	FallbackErrorWindow time.Duration `yaml:"fallbackErrorWindow" conf:",example=5m"`
}

Conf is required (if driver is set to 'overlay') configuration for overlay storage driver. +desc=This section is required only if storage.driver is overlay.

func GetConf

func GetConf() (*Conf, error)

func (*Conf) Key

func (conf *Conf) Key() string

func (*Conf) SetDefaults

func (conf *Conf) SetDefaults()

func (*Conf) Validate

func (conf *Conf) Validate() error

type Overlay

type Overlay interface {
	// GetOverlayPolicyLoader returns a PolicyLoader implementation that wraps two SourceStores
	GetOverlayPolicyLoader(ctx context.Context, schemaMgr schema.Manager) (engine.PolicyLoader, error)
}

The interface is defined here because placing in storage causes a circular dependency, probably because it blurs the lines by implementing `SourceStore` whilst having a dependency on `schema` in order to build the compile managers in the GetOverlayPolicyLoader method.

type Store

type Store struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore(ctx context.Context, conf *Conf, confW *config.Wrapper) (*Store, error)

func (*Store) Close

func (s *Store) Close() (outErr error)

func (*Store) Driver

func (s *Store) Driver() string

func (*Store) GetFirstMatch

func (s *Store) GetFirstMatch(ctx context.Context, candidates []namer.ModuleID) (*runtimev1.RunnablePolicySet, error)

func (*Store) GetOverlayPolicyLoader

func (s *Store) GetOverlayPolicyLoader(ctx context.Context, schemaMgr schema.Manager) (engine.PolicyLoader, error)

GetOverlayPolicyLoader instantiates both the base and fallback policy loaders and then returns itself.

func (*Store) InspectPolicies

func (s *Store) InspectPolicies(ctx context.Context, params storage.ListPolicyIDsParams) (map[string]*responsev1.InspectPoliciesResponse_Result, error)

func (*Store) ListPolicyIDs

func (s *Store) ListPolicyIDs(ctx context.Context, params storage.ListPolicyIDsParams) ([]string, error)

func (*Store) ListSchemaIDs

func (s *Store) ListSchemaIDs(ctx context.Context) ([]string, error)

func (*Store) LoadSchema

func (s *Store) LoadSchema(ctx context.Context, url string) (io.ReadCloser, error)

func (*Store) Reload

func (s *Store) Reload(ctx context.Context) error