Update EC2 tags/metadata to use AWS Go SDK v2

agent/ec2_meta_data.go

@@ -1,43 +1,50 @@
 package agent
 
 import (
-	"github.com/aws/aws-sdk-go/aws/ec2metadata"
-	"github.com/buildkite/agent/v3/internal/awslib"
+	"context"
+	"fmt"
+	"io"
+
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
 )
 
 type EC2MetaData struct {
 }
 
 // Takes a map of tags and meta-data paths to get, returns a map of tags and fetched values.
-func (e EC2MetaData) GetPaths(paths map[string]string) (map[string]string, error) {
+func (e EC2MetaData) GetPaths(ctx context.Context, paths map[string]string) (map[string]string, error) {
 	metaData := make(map[string]string)
 
-	c, err := newAWSClient()
+	c, err := newAWSClient(ctx)
 	if err != nil {
 		return metaData, err
 	}
 
 	for key, path := range paths {
-		value, err := c.GetMetadata(path)
+		mdOut, err := c.GetMetadata(ctx, &imds.GetMetadataInput{Path: path})
+		if err != nil {
+			return nil, fmt.Errorf("fetching metadata: %w", err)
+		}
+		value, err := io.ReadAll(mdOut.Content)
 		if err != nil {
-			return nil, err
-		} else {
-			metaData[key] = value
+			return nil, fmt.Errorf("reading metadata response: %w", err)
 		}
+		metaData[key] = string(value)
 	}
 
 	return metaData, nil
 }
 
-func (e EC2MetaData) Get() (map[string]string, error) {
+func (e EC2MetaData) Get(ctx context.Context) (map[string]string, error) {
 	metaData := make(map[string]string)
 
-	c, err := newAWSClient()
+	c, err := newAWSClient(ctx)
 	if err != nil {
 		return metaData, err
 	}
 
-	document, err := c.GetInstanceIdentityDocument()
+	document, err := c.GetInstanceIdentityDocument(ctx, nil)
 	if err != nil {
 		return metaData, err
 	}
@@ -50,19 +57,25 @@ func (e EC2MetaData) Get() (map[string]string, error) {
 	metaData["aws:instance-type"] = document.InstanceType
 	metaData["aws:region"] = document.Region
 
-	instanceLifeCycle, err := c.GetMetadata("instance-life-cycle")
-	if err == nil {
-		metaData["aws:instance-life-cycle"] = instanceLifeCycle
+	mdOut, err := c.GetMetadata(ctx, &imds.GetMetadataInput{Path: "instance-life-cycle"})
+	if err != nil {
+		return metaData, nil
+	}
+	instanceLifeCycle, err := io.ReadAll(mdOut.Content)
+	if err != nil {
+		return metaData, nil
 	}
 
+	metaData["aws:instance-life-cycle"] = string(instanceLifeCycle)
 	return metaData, nil
 }
 
-func newAWSClient() (*ec2metadata.EC2Metadata, error) {
-	sess, err := awslib.Session()
+func newAWSClient(ctx context.Context) (*imds.Client, error) {
+	cfg, err := config.LoadDefaultConfig(ctx)
 	if err != nil {
-		return &ec2metadata.EC2Metadata{}, err
+		return nil, fmt.Errorf("loading default AWS config: %w", err)
 	}
 
-	return ec2metadata.New(sess), nil
+	client := imds.NewFromConfig(cfg)
+	return client, nil
 }

agent/ec2_tags.go

@@ -1,51 +1,59 @@
 package agent
 
 import (
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/aws/ec2metadata"
-	"github.com/aws/aws-sdk-go/service/ec2"
-	"github.com/buildkite/agent/v3/internal/awslib"
+	"context"
+	"fmt"
+	"io"
+
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
+	"github.com/aws/aws-sdk-go-v2/service/ec2"
+	"github.com/aws/aws-sdk-go-v2/service/ec2/types"
 )
 
-type EC2Tags struct {
-}
+type EC2Tags struct{}
 
-func (e EC2Tags) Get() (map[string]string, error) {
-	sess, err := awslib.Session()
+func (e EC2Tags) Get(ctx context.Context) (map[string]string, error) {
+	cfg, err := config.LoadDefaultConfig(ctx)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("loading default AWS config: %w", err)
 	}
 
-	tags := make(map[string]string)
-	ec2metadataClient := ec2metadata.New(sess)
+	client := imds.NewFromConfig(cfg)
 
 	// Grab the current instances id
-	instanceId, err := ec2metadataClient.GetMetadata("instance-id")
+	mdOut, err := client.GetMetadata(ctx, &imds.GetMetadataInput{
+		Path: "instance-id",
+	})
+	if err != nil {
+		return nil, fmt.Errorf("fetching metadata from IMDS: %v", err)
+	}
+
+	instanceID, err := io.ReadAll(mdOut.Content)
 	if err != nil {
-		return tags, err
+		return nil, fmt.Errorf("reading instance ID from metadata: %w", err)
 	}
 
-	svc := ec2.New(sess)
+	svc := ec2.New(ec2.Options{})
 
 	// Describe the tags of the current instance
-	resp, err := svc.DescribeTags(&ec2.DescribeTagsInput{
-		Filters: []*ec2.Filter{
+	resp, err := svc.DescribeTags(ctx, &ec2.DescribeTagsInput{
+		Filters: []types.Filter{
 			{
-				Name: aws.String("resource-id"),
-				Values: []*string{
-					aws.String(instanceId),
-				},
+				Name:   aws.String("resource-id"),
+				Values: []string{string(instanceID)},
 			},
 		},
 	})
 	if err != nil {
-		return tags, err
+		return nil, err
 	}
 
 	// Collect the tags
+	tags := make(map[string]string)
 	for _, tag := range resp.Tags {
 		tags[*tag.Key] = *tag.Value
 	}
-
 	return tags, nil
 }

agent/tags.go

@@ -40,13 +40,13 @@ func FetchTags(ctx context.Context, l logger.Logger, conf FetchTagsConfig) []str
 			return K8sTagsFromEnv(os.Environ())
 		},
 		ec2MetaDataDefault: func() (map[string]string, error) {
-			return EC2MetaData{}.Get()
+			return EC2MetaData{}.Get(ctx)
 		},
 		ec2MetaDataPaths: func(paths map[string]string) (map[string]string, error) {
-			return EC2MetaData{}.GetPaths(paths)
+			return EC2MetaData{}.GetPaths(ctx, paths)
 		},
 		ec2Tags: func() (map[string]string, error) {
-			return EC2Tags{}.Get()
+			return EC2Tags{}.Get(ctx)
 		},
 		ecsMetaDataDefault: func() (map[string]string, error) {
 			return ECSMetadata{}.Get(ctx)

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/aws/aws-sdk-go-v2 v1.39.2
 	github.com/aws/aws-sdk-go-v2/config v1.31.12
 	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.18.9
+	github.com/aws/aws-sdk-go-v2/service/ec2 v1.245.2
 	github.com/aws/aws-sdk-go-v2/service/kms v1.45.6
 	github.com/brunoscheufler/aws-ecs-metadata-go v0.0.0-20220812150832-b6b31c6eeeaf
 	github.com/buildkite/bintest/v3 v3.3.0

go.sum

@@ -94,6 +94,8 @@ github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.9 h1:6RBnKZLkJM4hQ+kN6E7
 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.9/go.mod h1:V9rQKRmK7AWuEsOMnHzKj8WyrIir1yUJbZxDuZLFvXI=
 github.com/aws/aws-sdk-go-v2/internal/ini v1.8.3 h1:bIqFDwgGXXN1Kpp99pDOdKMTTb5d2KyU5X/BZxjOkRo=
 github.com/aws/aws-sdk-go-v2/internal/ini v1.8.3/go.mod h1:H5O/EsxDWyU+LP/V8i5sm8cxoZgc2fdNR9bxlOFrQTo=
+github.com/aws/aws-sdk-go-v2/service/ec2 v1.245.2 h1:P94OfRObDwjklbvdJTGuRZXeGYF7Bv5NNUo+I628kKQ=
+github.com/aws/aws-sdk-go-v2/service/ec2 v1.245.2/go.mod h1:D8Wb993SJuFQ10Lp95Vod8VTpYjJz4v0LeW4rEI471c=
 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.1 h1:oegbebPEMA/1Jny7kvwejowCaHz1FWZAQ94WXFNCyTM=
 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.1/go.mod h1:kemo5Myr9ac0U9JfSjMo9yHLtw+pECEHsFtJ9tqCEI8=
 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.9 h1:5r34CgVOD4WZudeEKZ9/iKpiT6cM1JyEROpXjOcdWv8=