Skip to content

OCPBUGS-2436: Revert "Revert "[AWS] Add LB Type in the infrastructure cluster object via install-config yaml"" and fix OCPBUGS-2436 #6491

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

Merged
openshift-merge-robot merged 2 commits into from
Oct 19, 2022
Merged

OCPBUGS-2436: Revert "Revert "[AWS] Add LB Type in the infrastructure cluster object via install-config yaml"" and fix OCPBUGS-2436 #6491

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1aded88
Revert "Revert "[AWS] Add LB Type in the infrastructure cluster objec…
Miciah Oct 17, 2022
1a71334
Fix ingress config with empty lbType on AWS
Miciah Oct 16, 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
13 changes: 13 additions & 0 deletions data/data/install.openshift.io_installconfigs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1718,6 +1718,19 @@ spec:
the subnets. Leave the hosted zone unset to have the installer
create the hosted zone on your behalf.
type: string
lbType:
description: 'LBType allows user to set a load balancer type.
When this field is set the default ingresscontroller will get
created using the specified LBType. If this field is not set
then the default ingress controller of LBType Classic will be
created. Valid values are: * "Classic": A Classic Load Balancer
that makes routing decisions at either the transport layer
(TCP/SSL) or the application layer (HTTP/HTTPS). See the following
for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb
* "NLB": A Network Load Balancer that makes routing decisions
at the transport layer (TCP/SSL). See the following for additional
details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb'
type: string

@sadasu sadasu Oct 17, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text here is a little misleading to reviewers and potentially users. It says that Valid values are "Classic" and "NLB". Some suggestions: Can we say "LBType is an optional configuration that allows the user..." ? Can we talk about the unset case before the values that it can be set to?
Then we can talk about the values that are allowed when the value is actually set. Right now, we talk about behavior when set, then unset and values when it is set.
Also, can we use this opportunity to fix the nit about double spaces?

@Miciah Miciah Oct 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a generated file? I don't see how we can fix the double spaces. I can add some text in pkg/types/aws/platform.go to say that this field is optional, in which case the default is "Classic".

@Miciah Miciah Oct 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the godoc and ran go1.19 generate ./... to regenerate data/data/install.openshift.io_installconfigs.yaml.

@Miciah Miciah Oct 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just did another push in which I removed indentation for the list items in the godoc in order to prevent the generated CRD yaml from having those double-spaces.

propagateUserTags:
description: PropagateUserTags is a flag that directs in-cluster
operators to include the specified user tags in the tags of
Expand Down
25 changes: 13 additions & 12 deletions pkg/asset/installconfig/vsphere/mock/authmanager_generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 9 additions & 1 deletion pkg/asset/manifests/infrastructure_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ func TestGenerateInfrastructe(t *testing.T) {
infraBuild.forPlatform(configv1.AWSPlatformType),
infraBuild.withServiceEndpoint("service", "https://endpoint"),
),
}}
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
parents := asset.Parents{}
Expand Down Expand Up @@ -121,6 +122,13 @@ func (b icBuildNamespace) withServiceEndpoint(name, url string) icOption {
}
}

func (b icBuildNamespace) withLBType(lbType configv1.AWSLBType) icOption {
return func(ic *types.InstallConfig) {
b.forAWS()(ic)
ic.Platform.AWS.LBType = lbType
}
}

type infraOption func(*configv1.Infrastructure)

type infraBuildNamespace struct{}
Expand Down
13 changes: 13 additions & 0 deletions pkg/asset/manifests/ingress.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/openshift/installer/pkg/asset"
"github.com/openshift/installer/pkg/asset/installconfig"
"github.com/openshift/installer/pkg/types"
"github.com/openshift/installer/pkg/types/aws"
)

var (
Expand Down Expand Up @@ -115,6 +116,18 @@ func (ing *Ingress) generateClusterConfig(config *types.InstallConfig) ([]byte,
DefaultPlacement: defaultPlacement,
},
}

switch config.Platform.Name() {
case aws.Name:
obj.Spec.LoadBalancer = configv1.LoadBalancer{
Platform: configv1.IngressPlatformSpec{
AWS: &configv1.AWSIngressSpec{
Type: config.AWS.LBType,
},
Type: configv1.AWSPlatformType,
},
}
}
return yaml.Marshal(obj)
}

Expand Down
34 changes: 29 additions & 5 deletions pkg/asset/manifests/ingress_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ func installConfigFromTopologies(t *testing.T, options []icOption,

func TestGenerateIngerssDefaultPlacement(t *testing.T) {
cases := []struct {
name string
installConfigBuildOptions []icOption
controlPlaneTopology configv1.TopologyMode
infrastructureTopology configv1.TopologyMode
expectedIngressPlacement configv1.DefaultPlacement
name string
installConfigBuildOptions []icOption
controlPlaneTopology configv1.TopologyMode
infrastructureTopology configv1.TopologyMode
expectedIngressPlacement configv1.DefaultPlacement
expectedIngressAWSLBType configv1.AWSLBType
expectedIngressPlatformType configv1.PlatformType
}{
{
// AWS currently uses a load balancer even on single-node, so the
Expand Down Expand Up @@ -91,6 +93,24 @@ func TestGenerateIngerssDefaultPlacement(t *testing.T) {
infrastructureTopology: configv1.HighlyAvailableTopologyMode,
expectedIngressPlacement: configv1.DefaultPlacementWorkers,
},
{
name: "test setting of aws lb type to NLB",
installConfigBuildOptions: []icOption{icBuild.withLBType(configv1.NLB)},
controlPlaneTopology: configv1.HighlyAvailableTopologyMode,
infrastructureTopology: configv1.HighlyAvailableTopologyMode,
expectedIngressPlacement: configv1.DefaultPlacementWorkers,
expectedIngressAWSLBType: configv1.NLB,
expectedIngressPlatformType: configv1.AWSPlatformType,
},
{
name: "test setting of aws lb type to Classic",
installConfigBuildOptions: []icOption{icBuild.withLBType(configv1.Classic)},
controlPlaneTopology: configv1.HighlyAvailableTopologyMode,
infrastructureTopology: configv1.HighlyAvailableTopologyMode,
expectedIngressPlacement: configv1.DefaultPlacementWorkers,
expectedIngressAWSLBType: configv1.Classic,
expectedIngressPlatformType: configv1.AWSPlatformType,
},
{

@sadasu sadasu Oct 17, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had originally requested an update to unit tests to test for all input values here: fbd2ea0#r971050233.

As a result a test was added for when the LBType is set to "Classic". Should there be a test case here for the case when the install-config contains "" as LBType for the scenario when the LBType value is not spcifically set by the customer?

@Miciah Miciah Oct 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be covered in the latest push.

name: "none-platform single node with 0 or 1 day-1 workers",
installConfigBuildOptions: []icOption{icBuild.forNone()},
Expand Down Expand Up @@ -154,6 +174,10 @@ func TestGenerateIngerssDefaultPlacement(t *testing.T) {
return
}
assert.Equal(t, tc.expectedIngressPlacement, actualIngress.Status.DefaultPlacement)
if len(tc.expectedIngressAWSLBType) != 0 && len(tc.expectedIngressPlatformType) != 0 {
assert.Equal(t, tc.expectedIngressAWSLBType, actualIngress.Spec.LoadBalancer.Platform.AWS.Type)
assert.Equal(t, tc.expectedIngressPlatformType, actualIngress.Spec.LoadBalancer.Platform.Type)
}
})
}
}
3 changes: 3 additions & 0 deletions pkg/explain/printer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,9 @@ func Test_PrintFields(t *testing.T) {
hostedZone <string>
HostedZone is the ID of an existing hosted zone into which to add DNS records for the cluster's internal API. An existing hosted zone can only be used when also using existing subnets. The hosted zone must be associated with the VPC containing the subnets. Leave the hosted zone unset to have the installer create the hosted zone on your behalf.

lbType <string>
LBType allows user to set a load balancer type. When this field is set the default ingresscontroller will get created using the specified LBType. If this field is not set then the default ingress controller of LBType Classic will be created. Valid values are: * "Classic": A Classic Load Balancer that makes routing decisions at either the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb * "NLB": A Network Load Balancer that makes routing decisions at the transport layer (TCP/SSL). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb

propagateUserTags <boolean>
PropagateUserTags is a flag that directs in-cluster operators to include the specified user tags in the tags of the AWS resources that the operators create.

Expand Down
19 changes: 18 additions & 1 deletion pkg/types/aws/platform.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package aws

import "github.com/aws/aws-sdk-go/aws/endpoints"
import (
"github.com/aws/aws-sdk-go/aws/endpoints"
configv1 "github.com/openshift/api/config/v1"
)

// Platform stores all the global configuration that all machinesets
// use.
Expand Down Expand Up @@ -59,6 +62,20 @@ type Platform struct {
// AWS resources that the operators create.
// +optional
PropagateUserTag bool `json:"propagateUserTags,omitempty"`

// LBType allows user to set a load balancer type.
// When this field is set the default ingresscontroller will get created using the specified LBType.
// If this field is not set then the default ingress controller of LBType Classic will be created.
// Valid values are:
// * "Classic": A Classic Load Balancer that makes routing decisions at either
// the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See
// the following for additional details:
// https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb
// * "NLB": A Network Load Balancer that makes routing decisions at the
// transport layer (TCP/SSL). See the following for additional details:
// https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb
// +optional
LBType configv1.AWSLBType `json:"lbType,omitempty"`
}

// ServiceEndpoint store the configuration for services to
Expand Down