package
3.4.2+incompatible
Repository: https://github.com/contiv/vpp.git
Documentation: pkg.go.dev

# Functions

DeleteAll is a helper function to prepare Delete for multiple key-value pairs into a single transaction.
NewAbortEventError is the constructor for the AbortEventError.
NewDBResync is a constructor for DBResync.
NewExternalConfigChange is a constructor for ExternalConfigChange.
NewExternalConfigResync is a constructor for ExternalConfigResync.
NewFatalError is the constructor for FatalError.
NewKubeStateData is a constructor for KubeStateData.
NewShutdownEvent is constructor for Shutdown event.
PutAll is a helper function to prepare Put for multiple key-value pairs into a single transaction.

# Constants

AfterError healing resync is triggered after an event processing ended with error.
BestEffort transaction continues even if non-fatal, non-abort error is returned (to get as close to the desired state as it is possible).
BestEffortIgnoreErrors is the same as BestEffort, but healing resync is NOT triggered in case of errors.
DownstreamResync triggers re-synchronization between vpp-agent and SB.
Forward event is processed by handlers in the exact same order as passed to the Controller - ensuring for every handler that its dependencies have already reacted to the event.
FullResync event requires to be reacted to by a full re-synchronization (Contiv -> VPP-agent <-> SB).
Periodic healing resync, when enabled in the configuration, is run periodically to trigger the Downstream resync (sync between vpp-agent and VPP/Linux).
Reverse event is processed by handlers in the backward order, ensuring for every handler that its dependencies are still in the pre-event state.
RevertOnFailure tells the Controller to stop event processing when any error is returned and to revert already executed changes.
Update event can be reacted to by an incremental change.
UpstreamResync triggers re-synchronization between Contiv and VPP-agent.

# Structs

AbortEventError tells controller to abort the processing of the event (and for Update/RevertOnFailure to revert the changes).
DBResync is a Resync Event that carries snapshot of the database for all watched Kubernetes resources and the external configuration (for vpp-agent).
ExternalConfigChange is an Update event that represents change for one or more keys from the external configuration (for vpp-agent).
ExternalConfigResync is a Resync event triggered by external config source.
FatalError tells Controller to abort the event loop and stop the agent as soon as possible.
HealingResync is supposed to "heal" the contiv-vswitch.
KubeStateChange is an Update event that represents change for one key from Kubernetes state data.
Shutdown event is triggered when the agent is being closed.
VerificationResync is used to verify the preservation of state consistency of Contiv plugins after any event.

# Interfaces

ConfigRetriever allows to read configuration in order to adjust a config item by multiple event handlers.
Event represents something that has happened and may cause some reaction.
EventHandler declares methods that event handler must implement.
EventLoop defines method for accessing the main event loop.
ResyncOperations lists operations needed to build transaction for Resync-type events.
Transaction defines operations needed to build and commit a transaction.
UpdateEvent can be reacted to by an incremental change, as opposed to the full re-synchronization.
UpdateOperations lists operations needed to build transaction for Update-type events.

# Type aliases

EventMethodType is either Resync or Update.
HealingResyncType is either Periodic or AfterError.
KeyValuePairs is a set of key-value pairs.
KubeStateData contains Kubernetes state data organized as key-value pairs sorted by the resource type.
UpdateDirectionType is either Forward or Reverse.
UpdateTransactionType is either BestEffort or RevertOnFailure.