backend

Documentation

Index

• Constants
• Variables
• type ClaimObject
• type ClaimType
  • func GetClaimTypeFromString(s string) ClaimType
• type EntryObject
• type IndexObject
• type Object

Constants

const (
	// system defined common
	//KuidOwnerGroupKey     = "be.kuid.dev/owner-group"
	//KuidOwnerVersionKey   = "be.kuid.dev/owner-version"
	//KuidOwnerNameKey      = "be.kuid.dev/owner-name"
	//KuidOwnerNamespaceKey = "be.kuid.dev/owner-namespace"
	KuidOwnerKindKey  = "be.kuid.dev/owner-kind" // we need to track this to ensure a claim from an index is distinguished from a regular claim
	KuidClaimNameKey  = "be.kuid.dev/claim-name"
	KuidClaimUIDKey   = "be.kuid.dev/claim-uid"
	KuidClaimTypeKey  = "be.kuid.dev/claim-type"
	KuidIndexEntryKey = "be.kuid.dev/index-entry"
	// system defined ipam
	KuidIPAMIPPrefixTypeKey     = "ipam.be.kuid.dev/ipprefix-type"
	KuidIPAMClaimSummaryTypeKey = "ipam.be.kuid.dev/claim-summary-type" // used for easy lookup
	KuidIPAMddressFamilyKey     = "ipam.be.kuid.dev/address-family"
	KuidIPAMSubnetKey           = "ipam.be.kuid.dev/subnet" // this is the subnet in prefix annotation used for GW selection
	KuidIPAMDefaultGatewayKey   = "ipam.be.kuid.dev/default-gateway"

	// DNS used keys
	KuidINVNetworkKey  = "inv.kuid.dev/network"
	KuidINVEndpointKey = "inv.kuid.dev/endpoint-name"
	KuidINVHeadlessKey = "inv.kuid.dev/headless-name"
	KuidINVAliasKey    = "inv.kuid.dev/alias-name"
	KuidINVPortNS      = "port.kuid.dev"
	// Inventory
	KuidINVRegionKey           = "infra.be.kuid.dev/region"
	KuidINVAvailabilityZoneKey = "infra.be.kuid.dev/availability-zone"
	KuidINVSiteKey             = "infra.be.kuid.dev/site"
	KuidINVLocationKey         = "infra.be.kuid.dev/location"
	KuidINVRackKey             = "infra.be.kuid.dev/rack"
	KuidINVPositionKey         = "infra.be.kuid.dev/position" // position in the rack
	KuidINVNodeTypeKey         = "infra.be.kuid.dev/node-type"
	KuidINVNodeKey             = "infra.be.kuid.dev/node"
	KuidINVLinkKey             = "infra.be.kuid.dev/link"
	KuidINVLinkTypeKey         = "infra.be.kuid.dev/link-type"
	KuidINVPurpose             = "infra.be.kuid.dev/purpose"
	KuidINVExclude             = "infra.be.kuid.dev/exclude"
	// Network Inventory
	KuidINVNetworkDeviceType   = "network.infra.be.kuid.dev/device-type"     // edge, core or maybe p and pe
	KuidINVNetworkLinkBFD      = "link.network.infra.be.kuid.dev/bfd"        // enable or disable true or false
	KuidINVNetworkLinkBFDMinTX = "link.network.infra.be.kuid.dev/bfd-min-tx" //
	KuidINVNetworkLinkBFDMinRX = "link.network.infra.be.kuid.dev/bfd-min-rx" //
)

const (
	IndexReservedMinName = "rangereservedmin"
	IndexReservedMaxName = "rangereservedmax"
)

Variables

var BackendIPAMSystemKeys = sets.New[string](
	KuidIPAMIPPrefixTypeKey,
	KuidIPAMClaimSummaryTypeKey,
	KuidClaimTypeKey,
	KuidIPAMddressFamilyKey,
	KuidIPAMSubnetKey,
	KuidIPAMDefaultGatewayKey,
)

BackendIPAMSystemKeys defined the system IPAM keys used internally in the cache for faster label based lookups Used to filter the system keys from the information presented to the outside world when generating the IP Entry object

var BackendSystemKeys = sets.New[string](
	KuidClaimNameKey,
	KuidClaimUIDKey,
	KuidOwnerKindKey,
	KuidClaimTypeKey,
	KuidIndexEntryKey,
)

BackendSystemKeys defined the system keys used internally in the cache for faster label based lookups. Used to filter the system keys from the information presented to the outside world when generating the XXEntry object

Types

type ClaimObject

type ClaimObject interface {
	Object
	GetIndex() string
	GetSelector() *metav1.LabelSelector
	GetOwnerSelector() (labels.Selector, error)
	GetLabelSelector() (labels.Selector, error)
	GetClaimLabels() labels.Set
	ValidateOwner(labels labels.Set) error
	GetClaimType() ClaimType
	GetStaticID() *uint64
	GetStaticTreeID(typ string) tree.ID
	GetClaimID(typ string, id uint64) tree.ID
	GetStatusClaimID(typ string) tree.ID
	GetRange() *string
	GetRangeID(typ string) (tree.Range, error)
	GetTable(typ string, to, from uint64) table.Table
	SetStatusRange(*string)
	SetStatusID(*uint64)
	GetStatusID() *uint64
	GetClaimRequest() string
	GetClaimResponse() string
	GetClaimSet(typ string) (map[string]tree.ID, sets.Set[string], error)
	IsOwner(labels labels.Set) bool
	GetChoreoAPIVersion() string // a trick to translate the apiversion as per crd
}

type ClaimType

type ClaimType string

+k8s:openapi-gen=true ClaimType define the type of the claim

const (
	ClaimType_Invalid   ClaimType = "invalid"
	ClaimType_StaticID  ClaimType = "staticID"
	ClaimType_DynamicID ClaimType = "dynamicID"
	ClaimType_Range     ClaimType = "range"
)

func GetClaimTypeFromString

func GetClaimTypeFromString(s string) ClaimType

type EntryObject

type EntryObject interface {
	Object
	GetIndex() string
	GetClaimType() ClaimType
	GetSpecID() string
	GetChoreoAPIVersion() string // a trick to translate the apiversion as per crd
	IsIndexEntry() bool
}

type IndexObject

type IndexObject interface {
	Object
	GetTree() gtree.GTree
	GetType() string
	GetMinID() *uint64
	GetMaxID() *uint64
	GetMinClaim() ClaimObject
	GetMaxClaim() ClaimObject
	GetClaims() []ClaimObject
	GetMax() uint64
}

type Object

type Object interface {
	client.Object
	GetNamespacedName() types.NamespacedName
	GetKey() store.Key
	GetCondition(t condition.ConditionType) condition.Condition
	SetConditions(c ...condition.Condition)
	ValidateSyntax(s string) field.ErrorList
}