Documentation
¶
Overview ¶
Package index provides indexes for the api.
Index ¶
- Constants
- func AddDefaultIndexes(ctx context.Context, mgr ctrl.Manager) error
- func ByClusterClassName(ctx context.Context, mgr ctrl.Manager) error
- func ByClusterClassRef(ctx context.Context, mgr ctrl.Manager) error
- func ByMachineNode(ctx context.Context, mgr ctrl.Manager) error
- func ByMachinePoolNode(ctx context.Context, mgr ctrl.Manager) error
- func ByMachinePoolProviderID(ctx context.Context, mgr ctrl.Manager) error
- func ByMachineProviderID(ctx context.Context, mgr ctrl.Manager) error
- func ClusterByClusterClassClassName(o client.Object) []string
- func ClusterByClusterClassRef(o client.Object) []string
- func ClusterClassRef(cc *clusterv1.ClusterClass) string
- func MachineByNodeName(o client.Object) []string
- func MachinePoolByNodeName(o client.Object) []string
- func NodeByProviderID(o client.Object) []string
Constants ¶
const (
// ClusterClassNameField is used by the Cluster controller to index Clusters by ClusterClass name.
ClusterClassNameField = "spec.topology.class"
// ClusterClassRefPath is used by the Cluster controller to index Clusters by ClusterClass name and namespace.
ClusterClassRefPath = "spec.topology.classRef"
)
const (
// MachineNodeNameField is used by the Machine Controller to index Machines by Node name, and add a watch on Nodes.
MachineNodeNameField = "status.nodeRef.name"
// MachineProviderIDField is used to index Machines by ProviderID. It's useful to find Machines
// in a management cluster from Nodes in a workload cluster.
MachineProviderIDField = "spec.providerID"
)
const (
// MachinePoolNodeNameField is used by the MachinePool Controller to index MachinePools by Node name, and add a watch on Nodes.
MachinePoolNodeNameField = "status.nodeRefs.name"
// MachinePoolProviderIDField is used to index MachinePools by ProviderID. It's useful to find MachinePools
// in a management cluster from Nodes in a workload cluster.
MachinePoolProviderIDField = "spec.providerIDList"
)
const (
// NodeProviderIDField is used to index Nodes by ProviderID. Remote caches use this to find Nodes in a workload cluster
// out of management cluster machine.spec.providerID.
NodeProviderIDField = "spec.providerID"
)
Variables ¶
This section is empty.
Functions ¶
func AddDefaultIndexes ¶
func AddDefaultIndexes(ctx context.Context, mgr ctrl.Manager) error
AddDefaultIndexes registers the default list of indexes.
func ByClusterClassName ¶
func ByClusterClassName(ctx context.Context, mgr ctrl.Manager) error
ByClusterClassName adds the cluster class name index to the managers cache.
func ByClusterClassRef ¶ added in v1.9.5
func ByClusterClassRef(ctx context.Context, mgr ctrl.Manager) error
ByClusterClassRef adds the cluster class name index to the managers cache.
func ByMachineNode ¶
func ByMachineNode(ctx context.Context, mgr ctrl.Manager) error
ByMachineNode adds the machine node name index to the managers cache.
func ByMachinePoolNode ¶ added in v1.4.2
func ByMachinePoolNode(ctx context.Context, mgr ctrl.Manager) error
ByMachinePoolNode adds the machinepool node name index to the managers cache.
func ByMachinePoolProviderID ¶ added in v1.4.2
func ByMachinePoolProviderID(ctx context.Context, mgr ctrl.Manager) error
ByMachinePoolProviderID adds the machinepool providerID index to the managers cache.
func ByMachineProviderID ¶
func ByMachineProviderID(ctx context.Context, mgr ctrl.Manager) error
ByMachineProviderID adds the machine providerID index to the managers cache.
func ClusterByClusterClassClassName ¶ added in v1.4.0
func ClusterByClusterClassClassName(o client.Object) []string
ClusterByClusterClassClassName contains the logic to index Clusters by ClusterClass name.
func ClusterByClusterClassRef ¶ added in v1.9.5
func ClusterByClusterClassRef(o client.Object) []string
ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name and namespace.
func ClusterClassRef ¶ added in v1.9.5
func ClusterClassRef(cc *clusterv1.ClusterClass) string
ClusterClassRef returns ClusterClass index key to be used for search.
func MachineByNodeName ¶ added in v1.4.0
func MachineByNodeName(o client.Object) []string
MachineByNodeName contains the logic to index Machines by Node name.
func MachinePoolByNodeName ¶ added in v1.4.2
func MachinePoolByNodeName(o client.Object) []string
MachinePoolByNodeName contains the logic to index MachinePools by Node name.
func NodeByProviderID ¶
func NodeByProviderID(o client.Object) []string
NodeByProviderID contains the logic to index Nodes by ProviderID.
Types ¶
This section is empty.