model

Documentation

Index

• Constants
• type HostName
  • func (h *HostName) Match(name string) bool
• type LocatedResourceStatus
  • func NewLocatedResource(kind, name string, labels map[string]string) LocatedResourceStatus
• type Locator
• type Mutator
• type Predicate
  • func All(predicates ...Predicate) Predicate
  • func Any(predicates ...Predicate) Predicate
  • func AnyKind(kinds ...string) Predicate
  • func Kind(kind string) Predicate
  • func Name(name string) Predicate
• type Ref
  • func (r *Ref) AddResourceStatus(ref ResourceStatus)
  • func (r *Ref) AddTargetResource(ref LocatedResourceStatus)
  • func (r *Ref) GetNewVersion(sessionName string) string
  • func (r *Ref) GetResources(predicate Predicate) []ResourceStatus
  • func (r *Ref) GetTargetHostNames() []HostName
  • func (r *Ref) GetTargets(predicate Predicate) []LocatedResourceStatus
  • func (r *Ref) GetVersion() string
  • func (r *Ref) RemoveResourceStatus(ref ResourceStatus)
• type ResourceAction
• type ResourceStatus
• type Revertor
• type Route
• type SessionContext

Constants

const (
	// StrategyExisting holds the name of the existing strategy
	StrategyExisting = "existing"
)

Types

type HostName

type HostName struct {
	Name      string
	Namespace string
}

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

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.

type LocatedResourceStatus

type LocatedResourceStatus struct {
	ResourceStatus

	Labels map[string]string
}

LocatedResourceStatus is a ResourceStatus with labels.

func NewLocatedResource

func NewLocatedResource(kind, name string, labels map[string]string) LocatedResourceStatus

NewLocatedResource is a simple helper to create LocatedResourceStatus.

type Locator

type Locator func(SessionContext, *Ref) bool

Locator should attempt to resolve a Ref.Name to a target Named kind, e.g. Deployment, DeploymentConfig. return false if nothing was found.

type Mutator

type Mutator func(SessionContext, *Ref) error

Mutator should create/modify a target Kind as required as needed * Add status to Ref for storage, failed or not.

type Predicate

type Predicate func(ResourceStatus) bool

Predicate base function to filter Resources.

func All

func All(predicates ...Predicate) Predicate

All Predicate returns true if all of the predicates match.

func Any

func Any(predicates ...Predicate) Predicate

Any Predicate returns true if any of the predicates match.

func AnyKind

func AnyKind(kinds ...string) Predicate

AnyKind is a shortcut Predicate for Any and Kind from strings.

func Kind

func Kind(kind string) Predicate

Kind Predicate returns true if kind matches resource.

func Name

func Name(name string) Predicate

Name Predicate returns true if name matches resource.

type Ref

type Ref struct {
	Name             string
	Namespace        string
	Strategy         string
	Args             map[string]string
	Targets          []LocatedResourceStatus
	ResourceStatuses []ResourceStatus
}

Ref references to a single Reference, e.g. Deployment, DeploymentConfig or GitRepo.

func (*Ref) AddResourceStatus

func (r *Ref) AddResourceStatus(ref ResourceStatus)

AddResourceStatus adds the status of an involved Resource to this ref.

func (*Ref) AddTargetResource

func (r *Ref) AddTargetResource(ref LocatedResourceStatus)

AddTargetResource adds the status of an involved Resource to this ref.

func (*Ref) GetNewVersion

func (r *Ref) GetNewVersion(sessionName string) string

GetNewVersion returns the new updated version name.

func (*Ref) GetResources

func (r *Ref) GetResources(predicate Predicate) []ResourceStatus

GetResources use a Predicate to filter the ResourceStatus.

func (*Ref) GetTargetHostNames

func (r *Ref) GetTargetHostNames() []HostName

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

func (*Ref) GetTargets

func (r *Ref) GetTargets(predicate Predicate) []LocatedResourceStatus

GetTargets use a Predicate to filter the LocatedResourceStatus.

func (*Ref) GetVersion

func (r *Ref) GetVersion() string

GetVersion returns the existing version name.

func (*Ref) RemoveResourceStatus

func (r *Ref) RemoveResourceStatus(ref ResourceStatus)

RemoveResourceStatus removes the status of an involved Resource to this ref.

type ResourceAction

type ResourceAction string

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

const (
	// ActionCreated imply the whole Named Kind was created and can be deleted
	ActionCreated ResourceAction = "created"
	// ActionModified imply the Named Kind has been modified and needs to be reverted to get back to original state
	ActionModified ResourceAction = "modified"
	// ActionFailed imply what ever was attempted failed. Assume current state is ok in clean up?
	ActionFailed ResourceAction = "failed"
	// ActionLocated imply the resource was found, but nothing was changed.
	ActionLocated ResourceAction = "located"
)

type ResourceStatus

type ResourceStatus struct {
	Kind string
	Name string
	// created, mutated, failed
	Action ResourceAction
	Prop   map[string]string
}

ResourceStatus holds information about the resources created/changed to fulfill a Ref.

type Revertor

type Revertor func(SessionContext, *Ref) error

Revertor should delete/modify a target Kind to return to the original state after a Mutator * Remove status from Ref unless there is a failure that requires retry.

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

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

SessionContext holds the context for a single session object, giving access to key things like REST Client and target Namespace.