engine

Documentation

Overview

Package engine implements core engine of Aptomi, which does policy resolution (resolve), diff calculation between states (diff), and state enforcement by applying actions (apply).

Index

• Constants
• Variables
• type PolicyData
  • func (policyData *PolicyData) Add(obj lang.Base)
  • func (policyData *PolicyData) GetGeneration() runtime.Generation
  • func (policyData *PolicyData) GetName() string
  • func (policyData *PolicyData) GetNamespace() string
  • func (policyData *PolicyData) Remove(obj lang.Base) bool
  • func (policyData *PolicyData) SetGeneration(gen runtime.Generation)
• type PolicyDataMetadata
• type Revision
  • func (revision *Revision) GetGeneration() runtime.Generation
  • func (revision *Revision) GetName() string
  • func (revision *Revision) GetNamespace() string
  • func (revision *Revision) SetGeneration(gen runtime.Generation)
• type RevisionProgress

Constants

const (
	// RevisionStatusInProgress represents Revision status with apply in progress
	RevisionStatusInProgress = "inprogress"
	// RevisionStatusSuccess represents Revision status with apply successfully finished
	RevisionStatusSuccess = "success"
	// RevisionStatusError represents Revision status with apply finished with error
	RevisionStatusError = "error"
)

const RevisionName = "revision"

RevisionName is the name of the only revision that exists in DB (but with many generations)

Variables

var (
	// ActionObjects is a list of informational objects for all actions
	ActionObjects = []*runtime.Info{
		component.CreateActionObject,
		component.UpdateActionObject,
		component.DeleteActionObject,
		component.AttachDependencyActionObject,
		component.DetachDependencyActionObject,
		component.EndpointsActionObject,
		global.PostProcessActionObject,
	}

	// Objects is the list of informational objects for all objects in the engine
	Objects = runtime.AppendAll([]*runtime.Info{
		PolicyDataObject,
		RevisionObject,
		resolve.ComponentInstanceObject,
	}, ActionObjects)
)

var PolicyDataKey = runtime.KeyFromParts(runtime.SystemNS, PolicyDataObject.Kind, runtime.EmptyName)

PolicyDataKey is the default key for the policy object (there is only one policy exists but with multiple generations)

var PolicyDataObject = &runtime.Info{
	Kind:        "policy",
	Storable:    true,
	Versioned:   true,
	Constructor: func() runtime.Object { return &PolicyData{} },
}

PolicyDataObject is an informational data structure with Kind and Constructor for PolicyData

var RevisionKey = runtime.KeyFromParts(runtime.SystemNS, RevisionObject.Kind, runtime.EmptyName)

RevisionKey is the default key for the Revision object (there is only one Revision exists but with multiple generations)

var RevisionObject = &runtime.Info{
	Kind:        "revision",
	Storable:    true,
	Versioned:   true,
	Constructor: func() runtime.Object { return &Revision{} },
}

RevisionObject is Info for Revision

Types

type PolicyData

type PolicyData struct {
	runtime.TypeKind `yaml:",inline"`
	Metadata         PolicyDataMetadata

	// Objects stores all policy objects in map: namespace -> kind -> name -> generation
	Objects map[string]map[string]map[string]runtime.Generation
}

PolicyData is a struct which contains references to a generation for each object included into the policy

func (*PolicyData) Add

func (policyData *PolicyData) Add(obj lang.Base)

Add adds an object to PolicyData

func (*PolicyData) GetGeneration

func (policyData *PolicyData) GetGeneration() runtime.Generation

GetGeneration returns PolicyData generation

func (*PolicyData) GetName

func (policyData *PolicyData) GetName() string

GetName returns PolicyData name

func (*PolicyData) GetNamespace

func (policyData *PolicyData) GetNamespace() string

GetNamespace returns PolicyData namespace

func (*PolicyData) Remove

func (policyData *PolicyData) Remove(obj lang.Base) bool

Remove deletes an object from PolicyData

func (*PolicyData) SetGeneration

func (policyData *PolicyData) SetGeneration(gen runtime.Generation)

SetGeneration sets PolicyData generation

type PolicyDataMetadata

type PolicyDataMetadata struct {
	Generation runtime.Generation
	UpdatedAt  time.Time
	UpdatedBy  string
}

PolicyDataMetadata is the metadata for PolicyData object that includes generation

type Revision

type Revision struct {
	runtime.TypeKind `yaml:",inline"`
	Metadata         runtime.GenerationMetadata

	// Policy represents generation of the corresponding policy
	Policy runtime.Generation

	Status    string
	Progress  RevisionProgress
	AppliedAt time.Time
}

Revision is a "milestone" in applying

func (*Revision) GetGeneration

func (revision *Revision) GetGeneration() runtime.Generation

GetGeneration returns Revision generation

func (*Revision) GetName

func (revision *Revision) GetName() string

GetName returns Revision name

func (*Revision) GetNamespace

func (revision *Revision) GetNamespace() string

GetNamespace returns Revision namespace

func (*Revision) SetGeneration

func (revision *Revision) SetGeneration(gen runtime.Generation)

SetGeneration returns Revision generation

type RevisionProgress

type RevisionProgress struct {
	Current int
	Total   int
}

RevisionProgress represents revision applying progress