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

     1  /*
     2  Copyright 2020 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 remote
    18  
    19  import (
    20  	corev1 "k8s.io/api/core/v1"
    21  	"sigs.k8s.io/controller-runtime/pkg/client"
    22  
    23  	"sigs.k8s.io/cluster-api/api/v1beta1/index"
    24  )
    25  
    26  // Index is a helper to model the info passed to cache.IndexField.
    27  type Index struct {
    28  	Object       client.Object
    29  	Field        string
    30  	ExtractValue client.IndexerFunc
    31  }
    32  
    33  // NodeProviderIDIndex is used to index Nodes by ProviderID.
    34  var NodeProviderIDIndex = Index{
    35  	Object:       &corev1.Node{},
    36  	Field:        index.NodeProviderIDField,
    37  	ExtractValue: index.NodeByProviderID,
    38  }