sigs.k8s.io/cluster-api@v1.7.1/api/v1beta1/index/node.go (about)

     1  /*
     2  Copyright 2021 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package index
    18  
    19  import (
    20  	"fmt"
    21  
    22  	corev1 "k8s.io/api/core/v1"
    23  	"sigs.k8s.io/controller-runtime/pkg/client"
    24  )
    25  
    26  const (
    27  	// NodeProviderIDField is used to index Nodes by ProviderID. Remote caches use this to find Nodes in a workload cluster
    28  	// out of management cluster machine.spec.providerID.
    29  	NodeProviderIDField = "spec.providerID"
    30  )
    31  
    32  // NodeByProviderID contains the logic to index Nodes by ProviderID.
    33  func NodeByProviderID(o client.Object) []string {
    34  	node, ok := o.(*corev1.Node)
    35  	if !ok {
    36  		panic(fmt.Sprintf("Expected a Node but got a %T", o))
    37  	}
    38  
    39  	if node.Spec.ProviderID == "" {
    40  		return nil
    41  	}
    42  
    43  	return []string{node.Spec.ProviderID}
    44  }