fix: Make sure EbsOptimizedInfo exists when selecting instances by EBS maximum bandwidth

[kanwren]

We observed that g2.xlarge has .EbsInfo.EbsOptimizedSupport == "default", but no .EbsInfo.EbsOptimizedInfo:

$ aws ec2 describe-instance-types --region us-west-2 --instance-types 'g2.xlarge' | jq '.InstanceTypes[0].EbsInfo'
{
  "EbsOptimizedSupport": "default",
  "EncryptionSupport": "supported",
  "NvmeSupport": "required"
}

This can cause a nil pointer dereference when gathering instance info, following the support for EBS maximum bandwidth introduced in #5925

{"level":"INFO","time":"2024-08-05T18:52:30.307Z","logger":"controller","message":"Observed a panic in reconciler: runtime error: invalid memory address or nil pointer dereference","commit":"490ef94","controller":"nodeclaim.disruption","controllerGroup":"karpenter.sh","controllerKind":"NodeClaim","NodeClaim":{"name":"utility-7lkkw"},"namespace":"","name":"utility-7lkkw","reconcileID":"997d55c4-ab30-4309-a0bb-32ad3e4b89b6"}
panic: runtime error: invalid memory address or nil pointer dereference [recovered]
	panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x18 pc=0x1fa3011]

goroutine 1986 [running]:
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Reconcile.func1()
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:111 +0x1e5
panic({0x26f1360?, 0x4b7d1a0?})
	runtime/panic.go:770 +0x132
github.com/aws/karpenter-provider-aws/pkg/providers/instancetype.computeRequirements(0xc00cfef400, {0x0, 0x0, 0x0}, {0xc0000560fb, 0x9}, {0x33cf790, 0xc00e9847f0})
	github.com/aws/karpenter-provider-aws/pkg/providers/instancetype/types.go:169 +0x1711
github.com/aws/karpenter-provider-aws/pkg/providers/instancetype.NewInstanceType({0x33c95d8, 0xc0088ef1a0}, 0xc00cfef400, {0xc0000560fb?, 0xc0088f8df0?}, {0xc00831a2d0, 0x1, 0x1}, 0x0, 0x0, ...)
	github.com/aws/karpenter-provider-aws/pkg/providers/instancetype/types.go:58 +0xb4
github.com/aws/karpenter-provider-aws/pkg/providers/instancetype.(*DefaultProvider).List.func2(0xc00cfef400, 0x411f45?)
	github.com/aws/karpenter-provider-aws/pkg/providers/instancetype/instancetype.go:167 +0x3a8
github.com/samber/lo.Map[...]({0xc001a31a88?, 0x316, 0x2b26360}, 0xc0088f9208?)
	github.com/samber/[email protected]/slice.go:29 +0x66
github.com/aws/karpenter-provider-aws/pkg/providers/instancetype.(*DefaultProvider).List(0xc0006e6540, {0x33c95d8, 0xc0088ef1a0}, 0x0, 0xc005a12908)
	github.com/aws/karpenter-provider-aws/pkg/providers/instancetype/instancetype.go:155 +0xf3e
github.com/aws/karpenter-provider-aws/pkg/cloudprovider.(*CloudProvider).GetInstanceTypes(0xc000a4f3e0, {0x33c95d8, 0xc0088ef1a0}, 0xc008a0a1e0)
	github.com/aws/karpenter-provider-aws/pkg/cloudprovider/cloudprovider.go:172 +0x24a
github.com/aws/karpenter-provider-aws/pkg/cloudprovider.(*CloudProvider).isAMIDrifted(0xc000a4f3e0?, {0x33c95d8?, 0xc0088ef1a0?}, 0xc0088e88c0, 0x0?, 0xc0057589a0, 0xc008a04248)
	github.com/aws/karpenter-provider-aws/pkg/cloudprovider/drift.go:70 +0x4d
github.com/aws/karpenter-provider-aws/pkg/cloudprovider.(*CloudProvider).isNodeClassDrifted(0xc000a4f3e0, {0x33c95d8, 0xc0088ef1a0}, 0xc0088e88c0, 0xc008a0a1e0, 0xc008a04248)
	github.com/aws/karpenter-provider-aws/pkg/cloudprovider/drift.go:50 +0xd7
github.com/aws/karpenter-provider-aws/pkg/cloudprovider.(*CloudProvider).IsDrifted(0xc000a4f3e0, {0x33c95d8, 0xc0088ef1a0}, 0xc0088e88c0)
	github.com/aws/karpenter-provider-aws/pkg/cloudprovider/cloudprovider.go:208 +0x35f
sigs.k8s.io/karpenter/pkg/cloudprovider/metrics.(*decorator).IsDrifted(0xc0004161f0, {0x33c95d8, 0xc0088ef1a0}, 0xc0088e88c0)
	sigs.k8s.io/[email protected]/pkg/cloudprovider/metrics/cloudprovider.go:151 +0x14f
sigs.k8s.io/karpenter/pkg/controllers/nodeclaim/disruption.(*Drift).isDrifted(0xc0004162d0, {0x33c95d8, 0xc0088ef1a0}, 0xc0087cbc20, 0xc0088e88c0)
	sigs.k8s.io/[email protected]/pkg/controllers/nodeclaim/disruption/drift.go:104 +0xd7
sigs.k8s.io/karpenter/pkg/controllers/nodeclaim/disruption.(*Drift).Reconcile(0xc0004162d0, {0x33c95d8, 0xc0088ef1a0}, 0xc0087cbc20, 0xc0088e88c0)
	sigs.k8s.io/[email protected]/pkg/controllers/nodeclaim/disruption/drift.go:67 +0x275
sigs.k8s.io/karpenter/pkg/controllers/nodeclaim/disruption.(*Controller).Reconcile(0xc0002cf140, {0x33c95d8, 0xc0088ef050}, 0xc0088e88c0)
	sigs.k8s.io/[email protected]/pkg/controllers/nodeclaim/disruption/controller.go:95 +0x369
sigs.k8s.io/controller-runtime/pkg/reconcile.(*objectReconcilerAdapter[...]).Reconcile(0x339c740, {0x33c95d8, 0xc0088ef050}, {{{0x0, 0x0?}, {0xc00070e400?, 0x5?}}})
	sigs.k8s.io/[email protected]/pkg/reconcile/reconcile.go:142 +0x194
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Reconcile(0x33cfd88?, {0x33c95d8?, 0xc0088ef050?}, {{{0x0?, 0xb?}, {0xc00070e400?, 0x0?}}})
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:114 +0xb7
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).reconcileHandler(0xc00040cdc0, {0x33c9610, 0xc0004fd040}, {0x28a1fc0, 0xc001a9dbe0})
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:311 +0x3bc
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).processNextWorkItem(0xc00040cdc0, {0x33c9610, 0xc0004fd040})
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:261 +0x1be
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2.2()
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:222 +0x79
created by sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2 in goroutine 354
	sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:218 +0x486

Add an extra check to EBS maximum bandwidth selection to make sure that this key exists.

[netlify]

✅ Deploy Preview for karpenter-docs-prod ready!

Name	Link
🔨 Latest commit	1780bbf
🔍 Latest deploy log	https://app.netlify.com/sites/karpenter-docs-prod/deploys/66b312e7b32c5e0008e34ac6
😎 Deploy Preview	https://deploy-preview-6663--karpenter-docs-prod.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[scottcrawford03]

lgtm

[kanwren]

I would add this or a similar instance type to the generated test data, but it seems there are no instance types in us-east-1 (the region used for generation) that have this issue:

$ aws ec2 describe-instance-types --region us-east-1 | jq 'def count(f): reduce f as $i (0; . + 1); count(.InstanceTypes[] | select(.EbsInfo.EbsOptimizedInfo == null and .EbsInfo.EbsOptimizedSupport == "default"))'
0

[kanwren]

Tentatively added g2.xlarge to the tests, which required switching the region used for gathering test instance types.

[jonathan-innis]

LGTM 🚀

[kanwren]

Removing g2.xlarge from the tests, since it seems to be EOL and has a bunch of weird data. In this case, g2.xlarge has {"MemoryInfo": {"SizeInMiB": 0}}, which caused the memory metrics test to fail, since it expected to get a value > 0; it's expected that we wouldn't get sane data from those. I'll leave the code change simply to prevent nil panics in case of a weird instance type like this, but it makes sense that the tests choke on it.

Full description below if you want to see for yourself :p

Full describe-instance-types output on g2.xlarge

{
  "InstanceTypes": [
    {
      "InstanceType": "g2.xlarge",
      "CurrentGeneration": false,
      "FreeTierEligible": false,
      "SupportedUsageClasses": [],
      "SupportedRootDeviceTypes": [
        "ebs",
        "instance-store"
      ],
      "SupportedVirtualizationTypes": [
        "hvm"
      ],
      "BareMetal": false,
      "Hypervisor": "xen",
      "ProcessorInfo": {
        "SupportedArchitectures": [
          "x86_64"
        ],
        "Manufacturer": "Other"
      },
      "VCpuInfo": {
        "DefaultVCpus": 4
      },
      "MemoryInfo": {
        "SizeInMiB": 0
      },
      "InstanceStorageSupported": true,
      "InstanceStorageInfo": {
        "TotalSizeInGB": 0,
        "Disks": [
          {
            "SizeInGB": 0,
            "Count": 1,
            "Type": "hdd"
          }
        ],
        "NvmeSupport": "unsupported",
        "EncryptionSupport": "unsupported"
      },
      "EbsInfo": {
        "EbsOptimizedSupport": "default",
        "EncryptionSupport": "supported",
        "NvmeSupport": "required"
      },
      "NetworkInfo": {
        "NetworkPerformance": "Unspecified",
        "MaximumNetworkInterfaces": 4,
        "MaximumNetworkCards": 1,
        "DefaultNetworkCardIndex": 0,
        "NetworkCards": [
          {
            "NetworkCardIndex": 0,
            "NetworkPerformance": "Unspecified",
            "MaximumNetworkInterfaces": 4
          }
        ],
        "Ipv4AddressesPerInterface": 15,
        "Ipv6AddressesPerInterface": 0,
        "Ipv6Supported": false,
        "EnaSupport": "unsupported",
        "EfaSupported": false,
        "EncryptionInTransitSupported": false,
        "EnaSrdSupported": false
      },
      "PlacementGroupInfo": {
        "SupportedStrategies": [
          "cluster",
          "partition",
          "spread"
        ]
      },
      "HibernationSupported": false,
      "BurstablePerformanceSupported": false,
      "DedicatedHostsSupported": false,
      "AutoRecoverySupported": false,
      "SupportedBootModes": [
        "legacy-bios"
      ],
      "NitroEnclavesSupport": "unsupported",
      "NitroTpmSupport": "unsupported",
      "PhcSupport": "unsupported"
    }
  ]
}

[jonathan-innis]

LGTM 🚀

[coveralls]

Pull Request Test Coverage Report for Build 10279220049

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 79.274%

---

Totals
Change from base Build 10278905359:	0.0%
Covered Lines:	5982
Relevant Lines:	7546

---

💛 - Coveralls