Greatly clarify misleading metadata logging

Signed-off-by: Connor Catlett <[email protected]>
kubernetes-sigs · May 24, 2024 · 6c2272e · 6c2272e
1 parent bce9949
commit 6c2272e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 19 deletions.
diff --git a/cmd/main.go b/cmd/main.go
@@ -147,24 +147,24 @@ func main() {
 	var md metadata.MetadataService
 	var metadataErr error
 
-	if region == "" {
-		klog.V(5).InfoS("[Debug] Retrieving region from metadata service")
-		md, metadataErr = metadata.NewMetadataService(cfg, region)
-		if metadataErr != nil {
-			klog.ErrorS(metadataErr, "Could not determine region from any metadata service. The region can be manually supplied via the AWS_REGION environment variable.")
-			panic(metadataErr)
+	if region != "" {
+		klog.InfoS("Region provided via AWS_REGION environment variable", "region", region)
+		if options.Mode != mode.ControllerMode {
+			klog.InfoS("Node service requires metadata even if AWS_REGION provided, initializing metadata")
+			md, metadataErr = metadata.NewMetadataService(cfg, region)
 		}
+	} else {
+		klog.InfoS("No region provided via AWS_REGION environment variable, initializing metadata")
+		md, metadataErr = metadata.NewMetadataService(cfg, region)
 		region = md.GetRegion()
 	}
 
-	if md == nil {
-		if options.Mode == driver.NodeMode || options.Mode == driver.AllMode {
-			md, metadataErr = metadata.NewMetadataService(cfg, region)
-			if metadataErr != nil {
-				klog.ErrorS(metadataErr, "failed to initialize metadata service")
-				klog.FlushAndExit(klog.ExitFlushTimeout, 1)
-			}
+	if metadataErr != nil {
+		klog.ErrorS(metadataErr, "Failed to initialize metadata when it is required")
+		if options.Mode == driver.ControllerMode {
+			klog.InfoS("The region can be manually supplied via the AWS_REGION environment variable")
 		}
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
 	cloud, err := cloud.NewCloud(region, options.AwsSdkDebugLog, options.UserAgentExtra, options.Batching)

diff --git a/pkg/cloud/metadata/metadata.go b/pkg/cloud/metadata/metadata.go
@@ -45,18 +45,19 @@ var _ MetadataService = &Metadata{}
 func NewMetadataService(cfg MetadataServiceConfig, region string) (MetadataService, error) {
 	metadata, err := retrieveEC2Metadata(cfg.EC2MetadataClient, region)
 	if err == nil {
-		klog.InfoS("ec2 metadata is available")
+		klog.InfoS("Retrieved metadata from IMDS")
 		return metadata, nil
 	}
+	klog.ErrorS(err, "Retrieving IMDS metadata failed, falling back to Kubernetes metadata")
 
-	klog.InfoS("failed to retrieve instance data from ec2 metadata; retrieving instance data from kubernetes api", "err", err)
 	metadata, err = retrieveK8sMetadata(cfg.K8sAPIClient)
 	if err == nil {
-		klog.InfoS("kubernetes api is available")
+		klog.InfoS("Retrieved metadata from Kubernetes")
 		return metadata, nil
 	}
+	klog.ErrorS(err, "Retrieving Kubernetes metadata failed")
 
-	return nil, fmt.Errorf("error getting instance data from ec2 metadata or kubernetes api")
+	return nil, fmt.Errorf("IMDS metadata and Kubernetes metadata are both unavailable")
 }
 
 func retrieveEC2Metadata(ec2MetadataClient EC2MetadataClient, region string) (*Metadata, error) {
@@ -67,7 +68,7 @@ func retrieveEC2Metadata(ec2MetadataClient EC2MetadataClient, region string) (*M
 
 	svc, err := ec2MetadataClient()
 	if err != nil {
-		klog.ErrorS(err, "Failed to initialize EC2 Metadata client")
+		klog.ErrorS(err, "failed to initialize EC2 Metadata client")
 		return nil, err
 	}
 	return EC2MetadataInstanceInfo(svc, region)
@@ -76,7 +77,7 @@ func retrieveEC2Metadata(ec2MetadataClient EC2MetadataClient, region string) (*M
 func retrieveK8sMetadata(k8sAPIClient KubernetesAPIClient) (*Metadata, error) {
 	clientset, err := k8sAPIClient()
 	if err != nil {
-		klog.InfoS("error creating kubernetes api client", "err", err)
+		klog.ErrorS(err, "error creating kubernetes api client")
 		return nil, err
 	}