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

internal/provisioner: Use local variable to replace the long access chain of fields #4586

Merged
merged 2 commits into from
Jun 22, 2022
Merged

internal/provisioner: Use local variable to replace the long access chain of fields #4586

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
e4f648a
little refactor for provisioner/service
izturn Jun 18, 2022
b2ada19
add changelog and make lint happy
izturn Jun 21, 2022
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
3 changes: 3 additions & 0 deletions changelogs/unreleased/4586-izturn-minor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Use local variable to replace the long access chain of fields

The access chain of fields is too long, so use local variable to replace them.
77 changes: 45 additions & 32 deletions internal/provisioner/objects/service/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,14 @@ func DesiredEnvoyService(contour *model.Contour) *corev1.Service {
},
}

providerParams := &contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters

// Add AWS LB annotations based on the network publishing strategy and provider type.
if contour.Spec.NetworkPublishing.Envoy.Type == model.LoadBalancerServicePublishingType &&
contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AWSLoadBalancerProvider {
providerParams.Type == model.AWSLoadBalancerProvider {

// Add the TCP backend protocol annotation for AWS classic load balancers.
if isELB(&contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters) {
if isELB(providerParams) {
svc.Annotations[awsLbBackendProtoAnnotation] = "tcp"
svc.Annotations[awsLBProxyProtocolAnnotation] = "*"
} else {
Expand All @@ -246,29 +249,29 @@ func DesiredEnvoyService(contour *model.Contour) *corev1.Service {

// Add the AllocationIDs annotation if specified by AWS provider parameters.
if allocationIDsNeeded(&contour.Spec) {
svc.Annotations[awsLBAllocationIDsAnnotation] = strings.Join(contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.AWS.AllocationIDs, ",")
svc.Annotations[awsLBAllocationIDsAnnotation] = strings.Join(providerParams.AWS.AllocationIDs, ",")
}

// Add the ResourceGroup annotation if specified by Azure provider parameters.
if resourceGroupNeeded(&contour.Spec) {
svc.Annotations[azureLBResourceGroupAnnotation] = *contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.ResourceGroup
svc.Annotations[azureLBResourceGroupAnnotation] = *providerParams.Azure.ResourceGroup
}

// Add the Subnet annotation if specified by provider parameters.
if subnetNeeded(&contour.Spec) {
if contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AzureLoadBalancerProvider {
svc.Annotations[azureLBSubnetAnnotation] = *contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.Subnet
} else if contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.GCPLoadBalancerProvider {
svc.Annotations[gcpLBSubnetAnnotation] = *contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP.Subnet
if providerParams.Type == model.AzureLoadBalancerProvider {
svc.Annotations[azureLBSubnetAnnotation] = *providerParams.Azure.Subnet
} else if providerParams.Type == model.GCPLoadBalancerProvider {
svc.Annotations[gcpLBSubnetAnnotation] = *providerParams.GCP.Subnet
}
}

// Add LoadBalancerIP parameter if specified by provider parameters.
if loadBalancerAddressNeeded(&contour.Spec) {
if contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AzureLoadBalancerProvider {
svc.Spec.LoadBalancerIP = *contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.Address
} else if contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.GCPLoadBalancerProvider {
svc.Spec.LoadBalancerIP = *contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP.Address
if providerParams.Type == model.AzureLoadBalancerProvider {
svc.Spec.LoadBalancerIP = *providerParams.Azure.Address
} else if providerParams.Type == model.GCPLoadBalancerProvider {
svc.Spec.LoadBalancerIP = *providerParams.GCP.Address
}
}

Expand All @@ -282,7 +285,7 @@ func DesiredEnvoyService(contour *model.Contour) *corev1.Service {
svc.Spec.Type = corev1.ServiceTypeLoadBalancer
isInternal := contour.Spec.NetworkPublishing.Envoy.LoadBalancer.Scope == model.InternalLoadBalancer
if isInternal {
provider := contour.Spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type
provider := providerParams.Type
internalAnnotations := InternalLBAnnotations[provider]
for name, value := range internalAnnotations {
svc.Annotations[name] = value
Expand Down Expand Up @@ -372,8 +375,10 @@ func updateEnvoyServiceIfNeeded(ctx context.Context, cli client.Client, contour
switch contour.Spec.NetworkPublishing.Envoy.Type {
case model.NodePortServicePublishingType:
updated, needed = equality.NodePortServiceChanged(current, desired)

case model.ClusterIPServicePublishingType:
updated, needed = equality.ClusterIPServiceChanged(current, desired)

// Add additional network publishing types as they are introduced.
default:
// LoadBalancerService is the default network publishing type.
Expand All @@ -396,46 +401,54 @@ func isELB(params *model.ProviderLoadBalancerParameters) bool {
// allocationIDsNeeded returns true if "service.beta.kubernetes.io/aws-load-balancer-eip-allocations"
// annotation is needed based on the provided spec.
func allocationIDsNeeded(spec *model.ContourSpec) bool {
providerParams := &spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters

return spec.NetworkPublishing.Envoy.Type == model.LoadBalancerServicePublishingType &&
spec.NetworkPublishing.Envoy.LoadBalancer.Scope == "External" &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AWSLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.AWS != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.AWS.Type == model.AWSNetworkLoadBalancer &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.AWS.AllocationIDs != nil
providerParams.Type == model.AWSLoadBalancerProvider &&
providerParams.AWS != nil &&
providerParams.AWS.Type == model.AWSNetworkLoadBalancer &&
providerParams.AWS.AllocationIDs != nil
}

// resourceGroupNeeded returns true if "service.beta.kubernetes.io/azure-load-balancer-resource-group"
// annotation is needed based on the provided spec.
func resourceGroupNeeded(spec *model.ContourSpec) bool {
providerParams := &spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters

return spec.NetworkPublishing.Envoy.Type == model.LoadBalancerServicePublishingType &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AzureLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure != nil &&
providerParams.Type == model.AzureLoadBalancerProvider &&
providerParams.Azure != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.Scope == "External" &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.ResourceGroup != nil
providerParams.Azure.ResourceGroup != nil
}

// subnetNeeded returns true if "service.beta.kubernetes.io/azure-load-balancer-internal-subnet" or
// "networking.gke.io/internal-load-balancer-subnet" annotation is needed based
// on the provided spec.
func subnetNeeded(spec *model.ContourSpec) bool {
providerParams := &spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters

return spec.NetworkPublishing.Envoy.Type == model.LoadBalancerServicePublishingType &&
spec.NetworkPublishing.Envoy.LoadBalancer.Scope == "Internal" &&
((spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AzureLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.Subnet != nil) ||
(spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.GCPLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP.Subnet != nil))
((providerParams.Type == model.AzureLoadBalancerProvider &&
providerParams.Azure != nil &&
providerParams.Azure.Subnet != nil) ||
(providerParams.Type == model.GCPLoadBalancerProvider &&
providerParams.GCP != nil &&
providerParams.GCP.Subnet != nil))
}

// loadBalancerAddressNeeded returns true if LoadBalancerIP parameter of service
// is needed based on provided spec.
func loadBalancerAddressNeeded(spec *model.ContourSpec) bool {
providerParams := &spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters

return spec.NetworkPublishing.Envoy.Type == model.LoadBalancerServicePublishingType &&
((spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.AzureLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Azure.Address != nil) ||
(spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.Type == model.GCPLoadBalancerProvider &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP != nil &&
spec.NetworkPublishing.Envoy.LoadBalancer.ProviderParameters.GCP.Address != nil))
((providerParams.Type == model.AzureLoadBalancerProvider &&
providerParams.Azure != nil &&
providerParams.Azure.Address != nil) ||
(providerParams.Type == model.GCPLoadBalancerProvider &&
providerParams.GCP != nil &&
providerParams.GCP.Address != nil))
}
3 changes: 0 additions & 3 deletions test/e2e/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,6 @@ func (d *Deployment) WaitForContourDeploymentUpdated() error {
if err := d.client.List(context.TODO(), pods, labelSelectAppContour); err != nil {
return false, err
}
if pods == nil {
izturn marked this conversation as resolved.
Show resolved Hide resolved
return false, errors.New("failed to fetch Contour Deployment pods")
}

updatedPods := 0
for _, pod := range pods.Items {
Expand Down