model

Documentation

Index

• func GetCreatedVersion(store LocatorStatusStore, sessionName string) string
• func GetDeletedVersion(store LocatorStatusStore) string
• func GetSha(version string) string
• func GetVersion(store LocatorStatusStore) string
• type HostName
  • func GetTargetHostNames(store LocatorStatusStore) []HostName
  • func NewHostName(host string) HostName
  • func (h *HostName) Match(name string) bool
  • func (h *HostName) String() string
• type LocatedReporter
• type Locator
• type LocatorStatus
• type LocatorStatusReporter
• type LocatorStatusStore
• type LocatorStore
  • func (l *LocatorStore) Clear()
  • func (l *LocatorStore) Report(status LocatorStatus)
  • func (l *LocatorStore) Store(kind ...string) []LocatorStatus
• type Modificator
• type ModificatorController
• type ModificatorRegistrar
• type ModificatorStatus
• type ModificatorStatusReporter
• type ModificatorStore
  • func (m *ModificatorStore) Report(status ModificatorStatus)
• type Ref
  • func (r *Ref) Hash() string
• type RefKindName
  • func ParseRefKindName(exp string) RefKindName
  • func (r RefKindName) String() string
  • func (r RefKindName) SupportsKind(kind string) bool
• type Resource
  • func (r *Resource) GetNamespaceName() string
• type Route
• type SessionContext
  • func (s *SessionContext) ToNamespacedName() types.NamespacedName
• type StatusAction
  • func Flip(action StatusAction) StatusAction
• type Sync
  • func NewSync(locators []Locator, modificators []Modificator) Sync

Functions

func GetCreatedVersion

func GetCreatedVersion(store LocatorStatusStore, sessionName string) string

GetCreatedVersion returns the new calculated version for the created resources if any. Returns unknown if not found.

func GetDeletedVersion

func GetDeletedVersion(store LocatorStatusStore) string

GetDeletedVersion returns the version for the deleted resources if any. Returns unknown if not found.

func GetSha

func GetSha(version string) string

GetSha computes a hash of the version and returns 8 characters substring of it.

func GetVersion

func GetVersion(store LocatorStatusStore) string

GetVersion returns the version for the created resources if any. Returns unknown if not found.

Types

type HostName

type HostName struct {
	Name      string
	Namespace string
}

HostName represents the Hostname of a service in a given namespace.

func GetTargetHostNames

func GetTargetHostNames(store LocatorStatusStore) []HostName

GetTargetHostNames returns a list of Host names that the target Deployment can be reached under.

func NewHostName

func NewHostName(host string) HostName

func (*HostName) Match

func (h *HostName) Match(name string) bool

Match returns true if this Hostname is equal to the short or long v of a dns name.

func (*HostName) String

func (h *HostName) String() string

String returns the String representation of a HostName.

type LocatedReporter

type LocatedReporter func(LocatorStatusStore)

type Locator

type Locator func(context SessionContext, ref Ref, store LocatorStatusStore, reporter LocatorStatusReporter) error

Locator should report on Resources that need some Action performed on them to satisfy the Ref.

type LocatorStatus

type LocatorStatus struct {
	Resource
	TimeStamp time.Time
	Labels    map[string]string
	Action    StatusAction
}

LocatorStatus is the action to perform an a given Resource as calculated by the Locators.

type LocatorStatusReporter

type LocatorStatusReporter func(LocatorStatus)

type LocatorStatusStore

type LocatorStatusStore func(kind ...string) []LocatorStatus

type LocatorStore

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

func (*LocatorStore) Clear

func (l *LocatorStore) Clear()

func (*LocatorStore) Report

func (l *LocatorStore) Report(status LocatorStatus)

func (*LocatorStore) Store

func (l *LocatorStore) Store(kind ...string) []LocatorStatus

type Modificator

type Modificator func(context SessionContext, ref Ref, store LocatorStatusStore, reporter ModificatorStatusReporter)

Modificator should perform the provided action on the given Resources provided by the Locator, e.g. Modify or Revert.

type ModificatorController

type ModificatorController func(LocatorStatusStore) bool

type ModificatorRegistrar

type ModificatorRegistrar func() (targetResourceType client.Object, modificator Modificator)

type ModificatorStatus

type ModificatorStatus struct {
	LocatorStatus
	Error   error
	Success bool
	Prop    map[string]string
	Target  *Resource
}

ModificatorStatus is the status of the given Locator action after it's been attempted performed.

type ModificatorStatusReporter

type ModificatorStatusReporter func(ModificatorStatus)

type ModificatorStore

type ModificatorStore struct {
	Stored []ModificatorStatus
}

ModificatorStore Dummy impl for testing purposes.

func (*ModificatorStore) Report

func (m *ModificatorStore) Report(status ModificatorStatus)

type Ref

type Ref struct {
	KindName  RefKindName
	Remove    bool
	Namespace string
	Strategy  string
	Args      map[string]string
}

Ref references the user specified Resource target and configuration.

func (*Ref) Hash

func (r *Ref) Hash() string

Hash returns a predictable hash version for this object.

type RefKindName

type RefKindName struct {
	Kind string
	Name string
}

RefKindName is the target Resource and optional Resource Kind.

func ParseRefKindName

func ParseRefKindName(exp string) RefKindName

ParseRefKindName parses a String() representation into a Object.

func (RefKindName) String

func (r RefKindName) String() string

String returns the string formatted kind/name.

func (RefKindName) SupportsKind

func (r RefKindName) SupportsKind(kind string) bool

SupportsKind returns true if kind match or the kind is empty.

type Resource

type Resource struct {
	Namespace string
	Kind      string
	Name      string
}

func (*Resource) GetNamespaceName

func (r *Resource) GetNamespaceName() string

type Route

type Route struct {
	Type  string
	Name  string
	Value string
}

Route references the strategy used to route to the target Refs.

type SessionContext

type SessionContext struct {
	context.Context //nolint:containedctx //reason needs refactoring https://github.com/maistra/istio-workspace/issues/1100

	Name      string
	Namespace string
	Route     Route
	Client    client.Client
	Log       logr.Logger
}

func (*SessionContext) ToNamespacedName

func (s *SessionContext) ToNamespacedName() types.NamespacedName

ToNamespacedName returns a types.NamespaceName object that represents this Session.

type StatusAction

type StatusAction string

StatusAction describes which type of operation was done/attempted to the target resource. Used to determine how to undo it.

const (
	// ActionCreate imply the whole Named Kind should be created.
	ActionCreate StatusAction = "create"
	// ActionDelete imply the whole Named Kind was created and should be deleted.
	ActionDelete StatusAction = "delete"
	// ActionModify imply the Named Kind should be modified.
	ActionModify StatusAction = "modify"
	// ActionRevert imply the Named Kind was modified and should be reverted to original state.
	ActionRevert StatusAction = "revert"
	// ActionLocated imply the resource was found, but nothing was changed.
	ActionLocated StatusAction = "located"

	// StrategyExisting holds the name of the existing strategy.
	StrategyExisting = "existing"
)

func Flip

func Flip(action StatusAction) StatusAction

type Sync

type Sync func(SessionContext, Ref, ModificatorController, LocatedReporter, ModificatorStatusReporter)

Sync is the entry point for ensuring the desired state for the given Ref is up-to-date.

func NewSync

func NewSync(locators []Locator, modificators []Modificator) Sync