Add --kubeconfig flag for out-of-cluster auth

kubernetes-sigs · Jul 4, 2024 · 21c583c · 21c583c
1 parent 6015f5d
commit 21c583c
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 40 deletions.
diff --git a/cmd/main.go b/cmd/main.go
@@ -68,7 +68,7 @@ func main() {
 
 	switch cmd {
 	case "pre-stop-hook":
-		clientset, clientErr := metadata.DefaultKubernetesAPIClient()
+		clientset, clientErr := metadata.DefaultKubernetesAPIClient(options.Kubeconfig)()
 		if clientErr != nil {
 			klog.ErrorS(err, "unable to communicate with k8s API")
 		} else {
@@ -140,7 +140,7 @@ func main() {
 
 	cfg := metadata.MetadataServiceConfig{
 		EC2MetadataClient: metadata.DefaultEC2MetadataClient,
-		K8sAPIClient:      metadata.DefaultKubernetesAPIClient,
+		K8sAPIClient:      metadata.DefaultKubernetesAPIClient(options.Kubeconfig),
 	}
 
 	region := os.Getenv("AWS_REGION")

diff --git a/pkg/cloud/metadata/k8s.go b/pkg/cloud/metadata/k8s.go
@@ -27,56 +27,70 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
+	"k8s.io/client-go/tools/clientcmd"
 	"k8s.io/client-go/util/cert"
 	"k8s.io/klog/v2"
 )
 
 type KubernetesAPIClient func() (kubernetes.Interface, error)
 
-var DefaultKubernetesAPIClient = func() (kubernetes.Interface, error) {
-	// creates the in-cluster config
-	config, err := rest.InClusterConfig()
-	if err != nil {
-		if errors.Is(err, os.ErrNotExist) {
-			klog.InfoS("InClusterConfig failed to read token file, retrieving file from sandbox mount point")
-			// CONTAINER_SANDBOX_MOUNT_POINT env is set upon container creation in containerd v1.6+
-			// it provides the absolute host path to the container volume.
-			sandboxMountPoint := os.Getenv("CONTAINER_SANDBOX_MOUNT_POINT")
-			if sandboxMountPoint == "" {
-				return nil, fmt.Errorf("CONTAINER_SANDBOX_MOUNT_POINT environment variable is not set")
-			}
-
-			tokenFile := filepath.Join(sandboxMountPoint, "var", "run", "secrets", "kubernetes.io", "serviceaccount", "token")
-			rootCAFile := filepath.Join(sandboxMountPoint, "var", "run", "secrets", "kubernetes.io", "serviceaccount", "ca.crt")
-
-			token, tokenErr := os.ReadFile(tokenFile)
+func DefaultKubernetesAPIClient(kubeconfig string) KubernetesAPIClient {
+	return func() (clientset kubernetes.Interface, err error) {
+		var config *rest.Config
+		if kubeconfig != "" {
+			config, err = clientcmd.NewNonInteractiveDeferredLoadingClientConfig(
+				&clientcmd.ClientConfigLoadingRules{ExplicitPath: kubeconfig},
+				&clientcmd.ConfigOverrides{},
+			).ClientConfig()
 			if err != nil {
-				return nil, tokenErr
-			}
-
-			tlsClientConfig := rest.TLSClientConfig{}
-			if _, certErr := cert.NewPool(rootCAFile); err != nil {
-				return nil, fmt.Errorf("expected to load root CA config from %s, but got err: %w", rootCAFile, certErr)
-			} else {
-				tlsClientConfig.CAFile = rootCAFile
-			}
-
-			config = &rest.Config{
-				Host:            "https://" + net.JoinHostPort(os.Getenv("KUBERNETES_SERVICE_HOST"), os.Getenv("KUBERNETES_SERVICE_PORT")),
-				TLSClientConfig: tlsClientConfig,
-				BearerToken:     string(token),
-				BearerTokenFile: tokenFile,
+				return nil, err
 			}
 		} else {
+			// creates the in-cluster config
+			config, err = rest.InClusterConfig()
+			if err != nil {
+				if errors.Is(err, os.ErrNotExist) {
+					klog.InfoS("InClusterConfig failed to read token file, retrieving file from sandbox mount point")
+					// CONTAINER_SANDBOX_MOUNT_POINT env is set upon container creation in containerd v1.6+
+					// it provides the absolute host path to the container volume.
+					sandboxMountPoint := os.Getenv("CONTAINER_SANDBOX_MOUNT_POINT")
+					if sandboxMountPoint == "" {
+						return nil, fmt.Errorf("CONTAINER_SANDBOX_MOUNT_POINT environment variable is not set")
+					}
+
+					tokenFile := filepath.Join(sandboxMountPoint, "var", "run", "secrets", "kubernetes.io", "serviceaccount", "token")
+					rootCAFile := filepath.Join(sandboxMountPoint, "var", "run", "secrets", "kubernetes.io", "serviceaccount", "ca.crt")
+
+					token, tokenErr := os.ReadFile(tokenFile)
+					if err != nil {
+						return nil, tokenErr
+					}
+
+					tlsClientConfig := rest.TLSClientConfig{}
+					if _, certErr := cert.NewPool(rootCAFile); err != nil {
+						return nil, fmt.Errorf("expected to load root CA config from %s, but got err: %w", rootCAFile, certErr)
+					} else {
+						tlsClientConfig.CAFile = rootCAFile
+					}
+
+					config = &rest.Config{
+						Host:            "https://" + net.JoinHostPort(os.Getenv("KUBERNETES_SERVICE_HOST"), os.Getenv("KUBERNETES_SERVICE_PORT")),
+						TLSClientConfig: tlsClientConfig,
+						BearerToken:     string(token),
+						BearerTokenFile: tokenFile,
+					}
+				} else {
+					return nil, err
+				}
+			}
+		}
+		// creates the clientset
+		clientset, err = kubernetes.NewForConfig(config)
+		if err != nil {
 			return nil, err
 		}
+		return clientset, nil
 	}
-	// creates the clientset
-	clientset, err := kubernetes.NewForConfig(config)
-	if err != nil {
-		return nil, err
-	}
-	return clientset, nil
 }
 
 func KubernetesAPIInstanceInfo(clientset kubernetes.Interface) (*Metadata, error) {

diff --git a/pkg/driver/options.go b/pkg/driver/options.go
@@ -28,6 +28,10 @@ import (
 type Options struct {
 	Mode Mode
 
+	// Kubeconfig is an absolute path to a kubeconfig file.
+	// If empty, the in-cluster config will be loaded.
+	Kubeconfig string
+
 	// #### Server options ####
 
 	//Endpoint is the endpoint for the CSI driver server
@@ -86,6 +90,8 @@ type Options struct {
 }
 
 func (o *Options) AddFlags(f *flag.FlagSet) {
+	f.StringVar(&o.Kubeconfig, "kubeconfig", "", "Absolute path to a kubeconfig file. The default is the emtpy string, which causes the in-cluster config to be used")
+
 	// Server options
 	f.StringVar(&o.Endpoint, "endpoint", DefaultCSIEndpoint, "Endpoint for the CSI driver server")
 	f.StringVar(&o.HttpEndpoint, "http-endpoint", "", "The TCP network address where the HTTP server for metrics will listen (example: `:8080`). The default is empty string, which means the server is disabled.")