iosnapshot

Documentation

Index

• type History
  • func NewHistory(cache cache.SnapshotCache, settings *gloov1.Settings) History

Types

type History

type History interface {
	// SetApiSnapshot sets the latest ApiSnapshot
	SetApiSnapshot(latestInput *v1snap.ApiSnapshot)
	// SetKubeGatewayClient sets the client to use for Kubernetes CRUD operations when
	// Kubernetes Gateway integration is enabled. If this is not set, then no Kubernetes
	// Gateway resources will be returned from `GetInputSnapshot`.
	SetKubeGatewayClient(kubeGatewayClient client.Client)
	// GetInputSnapshot gets the input snapshot for all components.
	GetInputSnapshot(ctx context.Context) ([]byte, error)
	// GetProxySnapshot returns the Proxies generated for all components.
	GetProxySnapshot(ctx context.Context) ([]byte, error)
	// GetXdsSnapshot returns the entire cache of xDS snapshots
	// NOTE: This contains sensitive data, as it is the exact inputs that used by Envoy
	GetXdsSnapshot(ctx context.Context) ([]byte, error)
}

History represents an object that maintains state about the running system The ControlPlane will use the Setters to update the last known state, and the Getters will be used by the Admin Server

func NewHistory

func NewHistory(cache cache.SnapshotCache, settings *gloov1.Settings) History

NewHistory returns an implementation of the History interface