Skip to content

Added EnableIPTargetType feature gate to controller #9

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.

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions controllers/ingress/group_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
"sigs.k8s.io/aws-load-balancer-controller/controllers/ingress/eventhandlers"
"sigs.k8s.io/aws-load-balancer-controller/pkg/annotations"
"sigs.k8s.io/aws-load-balancer-controller/pkg/aws"
"sigs.k8s.io/aws-load-balancer-controller/pkg/config"
cfg "sigs.k8s.io/aws-load-balancer-controller/pkg/config"
"sigs.k8s.io/aws-load-balancer-controller/pkg/deploy"
elbv2deploy "sigs.k8s.io/aws-load-balancer-controller/pkg/deploy/elbv2"
"sigs.k8s.io/aws-load-balancer-controller/pkg/deploy/tracking"
Expand Down Expand Up @@ -44,7 +44,7 @@ const (
func NewGroupReconciler(cloud aws.Cloud, k8sClient client.Client, eventRecorder record.EventRecorder,
finalizerManager k8s.FinalizerManager, networkingSGManager networkingpkg.SecurityGroupManager,
networkingSGReconciler networkingpkg.SecurityGroupReconciler, subnetsResolver networkingpkg.SubnetsResolver,
config config.ControllerConfig, backendSGProvider networkingpkg.BackendSGProvider, logger logr.Logger) *groupReconciler {
config cfg.ControllerConfig, backendSGProvider networkingpkg.BackendSGProvider, logger logr.Logger) *groupReconciler {

annotationParser := annotations.NewSuffixAnnotationParser(annotations.AnnotationPrefixIngress)
authConfigBuilder := ingress.NewDefaultAuthConfigBuilder(annotationParser)
Expand All @@ -57,7 +57,7 @@ func NewGroupReconciler(cloud aws.Cloud, k8sClient client.Client, eventRecorder
annotationParser, subnetsResolver,
authConfigBuilder, enhancedBackendBuilder, trackingProvider, elbv2TaggingManager,
cloud.VpcID(), config.ClusterName, config.DefaultTags, config.ExternalManagedTags,
config.DefaultSSLPolicy, backendSGProvider, config.EnableBackendSecurityGroup, config.DisableRestrictedSGRules, logger)
config.DefaultSSLPolicy, backendSGProvider, config.EnableBackendSecurityGroup, config.DisableRestrictedSGRules, config.FeatureGates.Enabled(cfg.EnableIPTargetType), logger)
stackMarshaller := deploy.NewDefaultStackMarshaller()
stackDeployer := deploy.NewDefaultStackDeployer(cloud, k8sClient, networkingSGManager, networkingSGReconciler,
config, ingressTagPrefix, logger)
Expand Down
6 changes: 3 additions & 3 deletions controllers/service/service_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"sigs.k8s.io/aws-load-balancer-controller/controllers/service/eventhandlers"
"sigs.k8s.io/aws-load-balancer-controller/pkg/annotations"
"sigs.k8s.io/aws-load-balancer-controller/pkg/aws"
"sigs.k8s.io/aws-load-balancer-controller/pkg/config"
cfg "sigs.k8s.io/aws-load-balancer-controller/pkg/config"
"sigs.k8s.io/aws-load-balancer-controller/pkg/deploy"
"sigs.k8s.io/aws-load-balancer-controller/pkg/deploy/elbv2"
"sigs.k8s.io/aws-load-balancer-controller/pkg/deploy/tracking"
Expand All @@ -36,14 +36,14 @@ const (
func NewServiceReconciler(cloud aws.Cloud, k8sClient client.Client, eventRecorder record.EventRecorder,
finalizerManager k8s.FinalizerManager, networkingSGManager networking.SecurityGroupManager,
networkingSGReconciler networking.SecurityGroupReconciler, subnetsResolver networking.SubnetsResolver,
vpcInfoProvider networking.VPCInfoProvider, config config.ControllerConfig, logger logr.Logger) *serviceReconciler {
vpcInfoProvider networking.VPCInfoProvider, config cfg.ControllerConfig, logger logr.Logger) *serviceReconciler {

annotationParser := annotations.NewSuffixAnnotationParser(serviceAnnotationPrefix)
trackingProvider := tracking.NewDefaultProvider(serviceTagPrefix, config.ClusterName)
elbv2TaggingManager := elbv2.NewDefaultTaggingManager(cloud.ELBV2(), cloud.VpcID(), config.FeatureGates, logger)
serviceUtils := service.NewServiceUtils(annotationParser, serviceFinalizer, config.ServiceConfig.LoadBalancerClass, config.FeatureGates)
modelBuilder := service.NewDefaultModelBuilder(annotationParser, subnetsResolver, vpcInfoProvider, cloud.VpcID(), trackingProvider,
elbv2TaggingManager, config.ClusterName, config.DefaultTags, config.ExternalManagedTags, config.DefaultSSLPolicy, serviceUtils)
elbv2TaggingManager, config.ClusterName, config.DefaultTags, config.ExternalManagedTags, config.DefaultSSLPolicy, config.FeatureGates.Enabled(cfg.EnableIPTargetType), serviceUtils)
stackMarshaller := deploy.NewDefaultStackMarshaller()
stackDeployer := deploy.NewDefaultStackDeployer(cloud, k8sClient, networkingSGManager, networkingSGReconciler, config, serviceTagPrefix, logger)
return &serviceReconciler{
Expand Down
1 change: 1 addition & 0 deletions docs/deploy/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,4 @@ They are a set of kye=value pairs that describe AWS load balance controller feat
| WeightedTargetGroups | string | true | Enable or disable weighted target groups |
| ServiceTypeLoadBalancerOnly | string | false | If enabled, controller will be limited to reconciling service of type `LoadBalancer`|
| EnableServiceController | string | true | Toggles support for `Service` type resources. |
| EnableIPTargetType | string | true | Used to toggle support for target-type `ip` across `Ingress` and `Service` type resources. |
2 changes: 2 additions & 0 deletions pkg/config/feature_gates.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const (
ServiceTypeLoadBalancerOnly Feature = "ServiceTypeLoadBalancerOnly"
EndpointsFailOpen Feature = "EndpointsFailOpen"
EnableServiceController Feature = "EnableServiceController"
EnableIPTargetType Feature = "EnableIPTargetType"
)

type FeatureGates interface {
Expand Down Expand Up @@ -47,6 +48,7 @@ func NewFeatureGates() FeatureGates {
ServiceTypeLoadBalancerOnly: false,
EndpointsFailOpen: false,
EnableServiceController: true,
EnableIPTargetType: true,
},
}
}
Expand Down
3 changes: 3 additions & 0 deletions pkg/ingress/model_build_target_group.go
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,9 @@ func (t *defaultModelBuildTask) buildTargetGroupTargetType(_ context.Context, sv
case string(elbv2model.TargetTypeInstance):
return elbv2model.TargetTypeInstance, nil
case string(elbv2model.TargetTypeIP):
if !t.enableIPTargetType {
return "", errors.Errorf("unsupported targetType: %v when EnableIPTargetType is %v", rawTargetType, t.enableIPTargetType)
}
return elbv2model.TargetTypeIP, nil
default:
return "", errors.Errorf("unknown targetType: %v", rawTargetType)
Expand Down
6 changes: 5 additions & 1 deletion pkg/ingress/model_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func NewDefaultModelBuilder(k8sClient client.Client, eventRecorder record.EventR
authConfigBuilder AuthConfigBuilder, enhancedBackendBuilder EnhancedBackendBuilder,
trackingProvider tracking.Provider, elbv2TaggingManager elbv2deploy.TaggingManager,
vpcID string, clusterName string, defaultTags map[string]string, externalManagedTags []string, defaultSSLPolicy string,
backendSGProvider networkingpkg.BackendSGProvider, enableBackendSG bool, disableRestrictedSGRules bool, logger logr.Logger) *defaultModelBuilder {
backendSGProvider networkingpkg.BackendSGProvider, enableBackendSG bool, disableRestrictedSGRules bool, enableIPTargetType bool, logger logr.Logger) *defaultModelBuilder {
certDiscovery := NewACMCertDiscovery(acmClient, logger)
ruleOptimizer := NewDefaultRuleOptimizer(logger)
return &defaultModelBuilder{
Expand All @@ -63,6 +63,7 @@ func NewDefaultModelBuilder(k8sClient client.Client, eventRecorder record.EventR
defaultSSLPolicy: defaultSSLPolicy,
enableBackendSG: enableBackendSG,
disableRestrictedSGRules: disableRestrictedSGRules,
enableIPTargetType: enableIPTargetType,
logger: logger,
}
}
Expand Down Expand Up @@ -92,6 +93,7 @@ type defaultModelBuilder struct {
defaultSSLPolicy string
enableBackendSG bool
disableRestrictedSGRules bool
enableIPTargetType bool

logger logr.Logger
}
Expand All @@ -117,6 +119,7 @@ func (b *defaultModelBuilder) Build(ctx context.Context, ingGroup Group) (core.S
logger: b.logger,
enableBackendSG: b.enableBackendSG,
disableRestrictedSGRules: b.disableRestrictedSGRules,
enableIPTargetType: b.enableIPTargetType,

ingGroup: ingGroup,
stack: stack,
Expand Down Expand Up @@ -172,6 +175,7 @@ type defaultModelBuildTask struct {
backendSGIDToken core.StringToken
enableBackendSG bool
disableRestrictedSGRules bool
enableIPTargetType bool

defaultTags map[string]string
externalManagedTags sets.String
Expand Down
72 changes: 66 additions & 6 deletions pkg/ingress/model_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,13 @@ func Test_defaultModelBuilder_Build(t *testing.T) {
}

tests := []struct {
name string
env env
args args
fields fields
wantStackJSON string
wantErr error
name string
env env
enableIPTargetType *bool
args args
fields fields
wantStackJSON string
wantErr error
}{
{
name: "Ingress - vanilla internal",
Expand Down Expand Up @@ -3611,6 +3612,59 @@ func Test_defaultModelBuilder_Build(t *testing.T) {
},
wantErr: errors.New("ingress: ns-1/ing-1: unsupported IPv6 configuration, lb not dual-stack"),
},
{
name: "target type IP with enableIPTargetType set to false",
env: env{
svcs: []*corev1.Service{svcWithNamedTargetPort},
},
enableIPTargetType: awssdk.Bool(false),
fields: fields{
resolveViaDiscoveryCalls: []resolveViaDiscoveryCall{resolveViaDiscoveryCallForInternalLB},
listLoadBalancersCalls: []listLoadBalancersCall{listLoadBalancerCallForEmptyLB},
enableBackendSG: true,
},
args: args{
ingGroup: Group{
ID: GroupID{Namespace: "ns-1", Name: "ing-1"},
Members: []ClassifiedIngress{
{
Ing: &networking.Ingress{ObjectMeta: metav1.ObjectMeta{
Namespace: "ns-1",
Name: "ing-1",
Annotations: map[string]string{
"alb.ingress.kubernetes.io/target-type": "ip",
},
},
Spec: networking.IngressSpec{
Rules: []networking.IngressRule{
{
IngressRuleValue: networking.IngressRuleValue{
HTTP: &networking.HTTPIngressRuleValue{
Paths: []networking.HTTPIngressPath{
{
Path: "/",
Backend: networking.IngressBackend{
Service: &networking.IngressServiceBackend{
Name: svcWithNamedTargetPort.Name,
Port: networking.ServiceBackendPort{
Name: "https",
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
wantErr: errors.New("ingress: ns-1/ing-1: unsupported targetType: ip when EnableIPTargetType is false"),
},
{
name: "target type IP with named target port",
env: env{
Expand Down Expand Up @@ -3900,6 +3954,12 @@ func Test_defaultModelBuilder_Build(t *testing.T) {
defaultSSLPolicy: "ELBSecurityPolicy-2016-08",
}

if tt.enableIPTargetType == nil {
b.enableIPTargetType = true
} else {
b.enableIPTargetType = *tt.enableIPTargetType
}

gotStack, _, _, err := b.Build(context.Background(), tt.args.ingGroup)
if tt.wantErr != nil {
assert.EqualError(t, err, tt.wantErr.Error())
Expand Down
3 changes: 3 additions & 0 deletions pkg/service/model_build_target_group.go
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,9 @@ func (t *defaultModelBuildTask) buildTargetType(_ context.Context, port corev1.S
var lbTargetType string
lbTargetType = string(t.defaultTargetType)
_ = t.annotationParser.ParseStringAnnotation(annotations.SvcLBSuffixTargetType, &lbTargetType, t.service.Annotations)
if lbTargetType == LoadBalancerTargetTypeIP && !t.enableIPTargetType {
return "", errors.Errorf("unsupported targetType: %v when EnableIPTargetType is %v", lbTargetType, t.enableIPTargetType)
}
if lbType == LoadBalancerTypeNLBIP || lbTargetType == LoadBalancerTargetTypeIP {
return elbv2model.TargetTypeIP, nil
}
Expand Down
38 changes: 33 additions & 5 deletions pkg/service/model_build_target_group_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1159,12 +1159,12 @@ func Test_defaultModelBuilder_buildPreserveClientIPFlag(t *testing.T) {
}

func Test_defaultModelBuilder_buildTargetType(t *testing.T) {

tests := []struct {
testName string
svc *corev1.Service
want elbv2.TargetType
wantErr error
testName string
svc *corev1.Service
want elbv2.TargetType
enableIPTargetType *bool
wantErr error
}{
{
testName: "empty annotation",
Expand Down Expand Up @@ -1247,6 +1247,29 @@ func Test_defaultModelBuilder_buildTargetType(t *testing.T) {
},
want: elbv2.TargetTypeIP,
},
{
testName: "enableIPTargetType is false, target ip",
svc: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
"service.beta.kubernetes.io/aws-load-balancer-type": "external",
"service.beta.kubernetes.io/aws-load-balancer-nlb-target-type": "ip",
},
},
Spec: corev1.ServiceSpec{
Ports: []corev1.ServicePort{
{
Name: "http",
Port: 80,
TargetPort: intstr.FromInt(80),
Protocol: corev1.ProtocolTCP,
},
},
},
},
enableIPTargetType: aws.Bool(false),
wantErr: errors.New("unsupported targetType: ip when EnableIPTargetType is false"),
},
{
testName: "external, ClusterIP with target type instance",
svc: &corev1.Service{
Expand Down Expand Up @@ -1337,6 +1360,11 @@ func Test_defaultModelBuilder_buildTargetType(t *testing.T) {
service: tt.svc,
defaultTargetType: LoadBalancerTargetTypeInstance,
}
if tt.enableIPTargetType == nil {
builder.enableIPTargetType = true
} else {
builder.enableIPTargetType = *tt.enableIPTargetType
}
got, err := builder.buildTargetType(context.Background(), tt.svc.Spec.Ports[0])
if tt.wantErr != nil {
assert.EqualError(t, err, tt.wantErr.Error())
Expand Down
6 changes: 5 additions & 1 deletion pkg/service/model_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ type ModelBuilder interface {
func NewDefaultModelBuilder(annotationParser annotations.Parser, subnetsResolver networking.SubnetsResolver,
vpcInfoProvider networking.VPCInfoProvider, vpcID string, trackingProvider tracking.Provider,
elbv2TaggingManager elbv2deploy.TaggingManager, clusterName string, defaultTags map[string]string,
externalManagedTags []string, defaultSSLPolicy string, serviceUtils ServiceUtils) *defaultModelBuilder {
externalManagedTags []string, defaultSSLPolicy string, enableIPTargetType bool, serviceUtils ServiceUtils) *defaultModelBuilder {
return &defaultModelBuilder{
annotationParser: annotationParser,
subnetsResolver: subnetsResolver,
Expand All @@ -49,6 +49,7 @@ func NewDefaultModelBuilder(annotationParser annotations.Parser, subnetsResolver
defaultTags: defaultTags,
externalManagedTags: sets.NewString(externalManagedTags...),
defaultSSLPolicy: defaultSSLPolicy,
enableIPTargetType: enableIPTargetType,
}
}

Expand All @@ -67,6 +68,7 @@ type defaultModelBuilder struct {
defaultTags map[string]string
externalManagedTags sets.String
defaultSSLPolicy string
enableIPTargetType bool
}

func (b *defaultModelBuilder) Build(ctx context.Context, service *corev1.Service) (core.Stack, *elbv2model.LoadBalancer, error) {
Expand All @@ -80,6 +82,7 @@ func (b *defaultModelBuilder) Build(ctx context.Context, service *corev1.Service
trackingProvider: b.trackingProvider,
elbv2TaggingManager: b.elbv2TaggingManager,
serviceUtils: b.serviceUtils,
enableIPTargetType: b.enableIPTargetType,

service: service,
stack: stack,
Expand Down Expand Up @@ -129,6 +132,7 @@ type defaultModelBuildTask struct {
trackingProvider tracking.Provider
elbv2TaggingManager elbv2deploy.TaggingManager
serviceUtils ServiceUtils
enableIPTargetType bool

service *corev1.Service

Expand Down
39 changes: 38 additions & 1 deletion pkg/service/model_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ func Test_defaultModelBuilderTask_Build(t *testing.T) {
resolveViaNameOrIDSliceCalls []resolveViaNameOrIDSliceCall
listLoadBalancerCalls []listLoadBalancerCall
fetchVPCInfoCalls []fetchVPCInfoCall
enableIPTargetType *bool
svc *corev1.Service
wantError bool
wantValue string
Expand Down Expand Up @@ -1960,6 +1961,36 @@ func Test_defaultModelBuilderTask_Build(t *testing.T) {
}
`,
},
{
testName: "service with enableIPTargetType set to false and type IP",
enableIPTargetType: aws.Bool(false),
svc: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "traffic-local",
Namespace: "default",
Annotations: map[string]string{
"service.beta.kubernetes.io/aws-load-balancer-type": "external",
"service.beta.kubernetes.io/aws-load-balancer-nlb-target-type": "ip",
},
},
Spec: corev1.ServiceSpec{
Type: corev1.ServiceTypeLoadBalancer,
Selector: map[string]string{"app": "hello"},
IPFamilies: []corev1.IPFamily{corev1.IPv6Protocol},
Ports: []corev1.ServicePort{
{
Port: 80,
TargetPort: intstr.FromInt(80),
Protocol: corev1.ProtocolTCP,
NodePort: 32332,
},
},
},
},
resolveViaDiscoveryCalls: []resolveViaDiscoveryCall{resolveViaDiscoveryCallForOneSubnet},
listLoadBalancerCalls: []listLoadBalancerCall{listLoadBalancerCallForEmptyLB},
wantError: true,
},
{
testName: "list load balancers error",
svc: &corev1.Service{
Expand Down Expand Up @@ -2733,8 +2764,14 @@ func Test_defaultModelBuilderTask_Build(t *testing.T) {
vpcInfoProvider.EXPECT().FetchVPCInfo(gomock.Any(), gomock.Any(), gomock.Any()).Return(call.wantVPCInfo, call.err).AnyTimes()
}
serviceUtils := NewServiceUtils(annotationParser, "service.k8s.aws/resources", "service.k8s.aws/nlb", featureGates)
var enableIPTargetType bool
if tt.enableIPTargetType == nil {
enableIPTargetType = true
} else {
enableIPTargetType = *tt.enableIPTargetType
}
builder := NewDefaultModelBuilder(annotationParser, subnetsResolver, vpcInfoProvider, "vpc-xxx", trackingProvider, elbv2TaggingManager,
"my-cluster", nil, nil, "ELBSecurityPolicy-2016-08", serviceUtils)
"my-cluster", nil, nil, "ELBSecurityPolicy-2016-08", enableIPTargetType, serviceUtils)
ctx := context.Background()
stack, _, err := builder.Build(ctx, tt.svc)
if tt.wantError {
Expand Down