Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aws: allow EC2 instance access to metadata tags #681

Merged
merged 2 commits into from
Sep 25, 2024
Merged

aws: allow EC2 instance access to metadata tags #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91ebd96
Add instance_metadata_tags option + test
cej-harris Sep 23, 2024
edb5285
Correct TypeDef
cej-harris Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion runner_manager/models/backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,16 @@
from string import Template
from typing import Dict, List, Literal, Optional, Sequence, TypedDict

from mypy_boto3_ec2.literals import InstanceTypeType, VolumeTypeType
from mypy_boto3_ec2.literals import (
InstanceMetadataTagsStateType,
InstanceTypeType,
VolumeTypeType,
)
from mypy_boto3_ec2.type_defs import (
BlockDeviceMappingTypeDef,
EbsBlockDeviceTypeDef,
IamInstanceProfileTypeDef,
InstanceMetadataOptionsRequestTypeDef,
TagSpecificationTypeDef,
TagTypeDef,
)
Expand Down Expand Up @@ -141,6 +146,7 @@ class AWSConfig(BackendConfig):
"MaxCount": int,
"MinCount": int,
"IamInstanceProfile": IamInstanceProfileTypeDef,
"MetadataOptions": InstanceMetadataOptionsRequestTypeDef,
},
)

Expand All @@ -159,6 +165,7 @@ class AWSInstanceConfig(InstanceConfig):
volume_type: VolumeTypeType = "gp3"
disk_size_gb: int = 20
iam_instance_profile_arn: str = ""
instance_metadata_tags: InstanceMetadataTagsStateType = "disabled"

def configure_instance(self, runner: Runner) -> AwsInstance:
"""Configure instance."""
Expand Down Expand Up @@ -197,6 +204,11 @@ def configure_instance(self, runner: Runner) -> AwsInstance:
iam_instance_profile: IamInstanceProfileTypeDef = IamInstanceProfileTypeDef(
Arn=self.iam_instance_profile_arn
)
instance_metadata_options: InstanceMetadataOptionsRequestTypeDef = (
InstanceMetadataOptionsRequestTypeDef(
InstanceMetadataTags=self.instance_metadata_tags,
)
)
return AwsInstance(
ImageId=self.image,
InstanceType=self.instance_type,
Expand All @@ -208,6 +220,7 @@ def configure_instance(self, runner: Runner) -> AwsInstance:
MinCount=self.min_count,
BlockDeviceMappings=block_device_mappings,
IamInstanceProfile=iam_instance_profile,
MetadataOptions=instance_metadata_options,
)


Expand Down
5 changes: 5 additions & 0 deletions tests/unit/backend/test_aws.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ def test_aws_instance_config(runner: Runner):
tags={"test": "test"},
subnet_id="i-0f9b0a3b7b3b3b3b3",
iam_instance_profile_arn="test",
instance_metadata_tags="enabled",
)
instance: AwsInstance = instance_config.configure_instance(runner)
assert instance["ImageId"] == instance_config.image
Expand All @@ -57,6 +58,10 @@ def test_aws_instance_config(runner: Runner):
instance["IamInstanceProfile"]["Arn"]
== instance_config.iam_instance_profile_arn
)
assert (
instance["MetadataOptions"]["InstanceMetadataTags"]
== instance_config.instance_metadata_tags
)
assert runner.name in instance["UserData"]
tags = instance["TagSpecifications"][0]["Tags"]
assert TagTypeDef(Key="test", Value="test") in tags
Expand Down
Loading