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

     1  /*
     2  Copyright 2018 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  	"context"
    21  	"time"
    22  
    23  	"github.com/pkg/errors"
    24  	restclient "k8s.io/client-go/rest"
    25  	"k8s.io/client-go/tools/clientcmd"
    26  	"sigs.k8s.io/controller-runtime/pkg/client"
    27  
    28  	kcfg "sigs.k8s.io/cluster-api/util/kubeconfig"
    29  )
    30  
    31  const (
    32  	defaultClientTimeout = 10 * time.Second
    33  )
    34  
    35  // ClusterClientGetter returns a new remote client.
    36  type ClusterClientGetter func(ctx context.Context, sourceName string, c client.Client, cluster client.ObjectKey) (client.Client, error)
    37  
    38  // NewClusterClient returns a Client for interacting with a remote Cluster using the given scheme for encoding and decoding objects.
    39  func NewClusterClient(ctx context.Context, sourceName string, c client.Client, cluster client.ObjectKey) (client.Client, error) {
    40  	restConfig, err := RESTConfig(ctx, sourceName, c, cluster)
    41  	if err != nil {
    42  		return nil, err
    43  	}
    44  	ret, err := client.New(restConfig, client.Options{Scheme: c.Scheme()})
    45  	if err != nil {
    46  		return nil, errors.Wrapf(err, "failed to create client for Cluster %s/%s", cluster.Namespace, cluster.Name)
    47  	}
    48  	return ret, nil
    49  }
    50  
    51  // RESTConfig returns a configuration instance to be used with a Kubernetes client.
    52  func RESTConfig(ctx context.Context, sourceName string, c client.Reader, cluster client.ObjectKey) (*restclient.Config, error) {
    53  	kubeConfig, err := kcfg.FromSecret(ctx, c, cluster)
    54  	if err != nil {
    55  		return nil, errors.Wrapf(err, "failed to retrieve kubeconfig secret for Cluster %s/%s", cluster.Namespace, cluster.Name)
    56  	}
    57  
    58  	restConfig, err := clientcmd.RESTConfigFromKubeConfig(kubeConfig)
    59  	if err != nil {
    60  		return nil, errors.Wrapf(err, "failed to create REST configuration for Cluster %s/%s", cluster.Namespace, cluster.Name)
    61  	}
    62  
    63  	restConfig.UserAgent = DefaultClusterAPIUserAgent(sourceName)
    64  	restConfig.Timeout = defaultClientTimeout
    65  
    66  	return restConfig, nil
    67  }