index

package

v0.4.2 Latest Latest Go to latest Published: Aug 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes-sigs/cluster-api

Links

Open Source Insights

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 ByMachineNode(ctx context.Context, mgr ctrl.Manager) error
func ByMachineProviderID(ctx context.Context, mgr ctrl.Manager) error
func NodeByProviderID(o client.Object) []string

Constants ¶

View Source

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"
)

View Source

const (
	// ClusterClassNameField is used by the Cluster controller to index Clusters by ClusterClass name.
	ClusterClassNameField = "spec.topology.class"
)

View Source

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 ByMachineNode ¶

func ByMachineNode(ctx context.Context, mgr ctrl.Manager) error

ByMachineNode adds the machine node name 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 NodeByProviderID ¶

func NodeByProviderID(o client.Object) []string

NodeByProviderID contains the logic to index Nodes by ProviderID.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL