chore(nodeadm): rename feature flag (#2381)

Change to this name since it's less confusing, and the docs sufficiently
describe the possible downsides of this flag.

Author: fletcherw

nodeadm/api/v1alpha1/nodeconfig_types.go

@@ -129,16 +129,16 @@ const (
 )
 
 // Feature specifies which feature gate should be toggled
-// +kubebuilder:validation:Enum={InstanceIdNodeName,AggressiveImagePull}
+// +kubebuilder:validation:Enum={InstanceIdNodeName,FastImagePull}
 type Feature string
 
 const (
 	// InstanceIdNodeName will use EC2 instance ID as node name
 	InstanceIdNodeName Feature = "InstanceIdNodeName"
 
-	// AggressiveImagePull enables a parallel image pull for container
-	// images. This will use more instance CPU and Memory during image pull, but
+	// FastImagePull enables a parallel image pull for container images. This
+	// will use more instance CPU, Memory, and EBS I/O during image pull, but
 	// may result in faster image pull times. This flag will be ignored on
 	// instances with memory and vCPU below a certain threshold.
-	AggressiveImagePull Feature = "AggressiveImagePull"
+	FastImagePull Feature = "FastImagePull"
 )

nodeadm/doc/api.md

@@ -62,7 +62,7 @@ _Appears in:_
 - [NodeConfigSpec](#nodeconfigspec)
 
 .Validation:
-- Enum: [InstanceIdNodeName AggressiveImagePull]
+- Enum: [InstanceIdNodeName FastImagePull]
 
 #### InstanceOptions
 

nodeadm/doc/examples.md

@@ -92,9 +92,9 @@ spec:
 ```
 
 ---
-## Enabling aggressive image pull (experimental)
+## Enabling fast image pull (experimental)
 
-When the `AggressiveImagePull` feature gate is enabled, `nodeadm` will configure the container runtime to pull and unpack container images in parallel.
+When the `FastImagePull` feature gate is enabled, `nodeadm` will configure the container runtime to pull and unpack container images in parallel.
 
 This has the benefit of potentially decreasing image pull time, at the cost of increased CPU, memory and EBS usage during image pull.
 
@@ -111,7 +111,7 @@ apiVersion: node.eks.aws/v1alpha1
 kind: NodeConfig
 spec:
   featureGates:
-    AggressiveImagePull: true
+    FastImagePull: true
 ```
 
 ---

nodeadm/internal/api/featuregates.go

@@ -15,11 +15,11 @@ var featureVerifiers = map[Feature]func(Feature, map[Feature]bool) bool{
 	// By default, this feature is disabled, and the private DNS Name will be used.
 	InstanceIdNodeName: DefaultFalse,
 
-	// AggressiveImagePull enables a parallel image pull for container
-	// images. This will use more instance CPU and Memory during image pull, but
+	// FastImagePull enables a parallel image pull for container images. This
+	// will use more instance CPU, Memory, and EBS I/O during image pull, but
 	// may result in faster image pull times. This flag will be ignored on
 	// instances with memory and vCPU below a certain threshold.
-	AggressiveImagePull: DefaultFalse,
+	FastImagePull: DefaultFalse,
 }
 
 func IsFeatureEnabled(feature Feature, featureGates map[Feature]bool) bool {

nodeadm/internal/api/types.go

@@ -123,5 +123,5 @@ const (
 	// InstanceIdNodeName will use EC2 instance ID as node name
 	InstanceIdNodeName Feature = "InstanceIdNodeName"
 
-	AggressiveImagePull Feature = "AggressiveImagePull"
+	FastImagePull Feature = "FastImagePull"
 )

nodeadm/internal/containerd/config.go

@@ -165,7 +165,7 @@ func writeSnapshotterConfig(cfg *api.NodeConfig, resources system.Resources) err
 }
 
 func UseSOCISnapshotter(cfg *api.NodeConfig, resources system.Resources) bool {
-	if !api.IsFeatureEnabled(api.AggressiveImagePull, cfg.Spec.FeatureGates) {
+	if !api.IsFeatureEnabled(api.FastImagePull, cfg.Spec.FeatureGates) {
 		return false
 	}
 

nodeadm/internal/containerd/containerd_config_test.go

@@ -9,11 +9,11 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestContainerdConfigWithUserConfigAndAggressiveImagePullFeature(t *testing.T) {
+func TestContainerdConfigWithUserConfigAndFastImagePullFeature(t *testing.T) {
 	cfg := &api.NodeConfig{
 		Spec: api.NodeConfigSpec{
 			FeatureGates: map[api.Feature]bool{
-				api.AggressiveImagePull: true,
+				api.FastImagePull: true,
 			},
 			Containerd: api.ContainerdOptions{
 				Config: api.ContainerdConfig(`
@@ -76,7 +76,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},
@@ -89,7 +89,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},
@@ -102,7 +102,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},
@@ -121,7 +121,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},
@@ -134,7 +134,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},
@@ -147,7 +147,7 @@ func TestContainerdConfig(t *testing.T) {
 			cfg: &api.NodeConfig{
 				Spec: api.NodeConfigSpec{
 					FeatureGates: map[api.Feature]bool{
-						api.AggressiveImagePull: true,
+						api.FastImagePull: true,
 					},
 				},
 			},