package
0.2.4
Repository: https://github.com/srl-labs/clabernetes.git
Documentation: pkg.go.dev

# Functions

AllocateTunnelIDs processes the given tunnels and allocates vnids.
GetTopologyKind returns the "kind" of topology this CR represents -- typically this will be "containerlab", but may be "kne" or perhaps others in the future as well.
NewConfigMapReconciler returns an instance of ConfigMapReconciler.
NewConnectivityReconciler returns an instance of ConnectivityReconciler.
NewController returns a new Controller.
NewDefinitionProcessor returns a definition processor for the given Topology.
NewDeploymentReconciler returns an instance of DeploymentReconciler.
NewPersistentVolumeClaimReconciler returns an instance of PersistentVolumeClaimReconciler.
NewReconcileData accepts a Topology object and returns a ReconcileData object.
NewReconciler creates a new generic Reconciler (TopologyReconciler).
NewRoleBindingReconciler returns an instance of RoleBindingReconciler.
NewServiceAccountReconciler returns an instance of ServiceAccountReconciler.
NewServiceExposeReconciler returns an instance of ServiceExposeReconciler.
NewServiceFabricReconciler returns an instance of ServiceFabricReconciler.
ReconcileResolve is a generic func to consolidate the more or less common pattern of resolving k8s objects that we need to reconcile in one of the "sub reconcilers" (i.e.
ResolveGlobalVsTopologyBool accepts a pointer to bool value from the global config as well as from a topology spec, and returns a normal bool of the proper value.
ResolveTopologyRemovePrefix returns true if the topology resource should strip the containerlab topology prefix from a resource (deployment/service) name.
ServiceConforms asserts if a given service conforms with a rendered service -- this isn't checking if the services are exactly the same, just checking that the parts clabernetes cares about are the same.

# Structs

ConfigMapReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
ConnectivityReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
Controller is the Containerlab topology controller object.
DeploymentReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
PersistentVolumeClaimReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
ReconcileData is a struct that holds data that is common during a reconciliation process regardless of the type of clabernetes topology that is being reconciled.
Reconciler (TopologyReconciler) is the base clabernetes topology reconciler that is embedded in all clabernetes topology controllers, it provides common methods for reconciling the common/standard resources that represent a clabernetes object (configmap, deployments, services, etc.).
RoleBindingReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
ServiceAccountReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
ServiceExposeReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.
ServiceFabricReconciler is a subcomponent of the "TopologyReconciler" but is exposed for testing purposes.

# Interfaces

DefinitionProcessor is an interface defining a definition processor -- that is, an object that accepts a clabernetes topology to update based on the included (probably containerlab, but maybe kne or others in the future) configuration.