feat: Placement Group Support #5307
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,6 +45,7 @@ import ( | |
| "github.com/aws/karpenter-provider-aws/pkg/apis/v1beta1" | ||
| "github.com/aws/karpenter-provider-aws/pkg/providers/amifamily" | ||
| "github.com/aws/karpenter-provider-aws/pkg/providers/instanceprofile" | ||
| "github.com/aws/karpenter-provider-aws/pkg/providers/placementgroup" | ||
| "github.com/aws/karpenter-provider-aws/pkg/providers/securitygroup" | ||
| "github.com/aws/karpenter-provider-aws/pkg/providers/subnet" | ||
| ) | ||
|
|
@@ -56,17 +57,19 @@ type Controller struct { | |
| securityGroupProvider *securitygroup.Provider | ||
| amiProvider *amifamily.Provider | ||
| instanceProfileProvider *instanceprofile.Provider | ||
| placementGroupProvider *placementgroup.Provider | ||
| } | ||
|
|
||
| func NewController(kubeClient client.Client, recorder events.Recorder, subnetProvider *subnet.Provider, securityGroupProvider *securitygroup.Provider, | ||
| amiProvider *amifamily.Provider, instanceProfileProvider *instanceprofile.Provider, placementGroupProvider *placementgroup.Provider) *Controller { | ||
| return &Controller{ | ||
| kubeClient: kubeClient, | ||
| recorder: recorder, | ||
| subnetProvider: subnetProvider, | ||
| securityGroupProvider: securityGroupProvider, | ||
| amiProvider: amiProvider, | ||
| instanceProfileProvider: instanceProfileProvider, | ||
| placementGroupProvider: placementGroupProvider, | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -79,6 +82,7 @@ func (c *Controller) Reconcile(ctx context.Context, nodeClass *v1beta1.EC2NodeCl | |
| c.resolveSecurityGroups(ctx, nodeClass), | ||
| c.resolveAMIs(ctx, nodeClass), | ||
| c.resolveInstanceProfile(ctx, nodeClass), | ||
| c.resolvePlacementGroups(ctx, nodeClass), | ||
| ) | ||
| if !equality.Semantic.DeepEqual(stored, nodeClass) { | ||
| statusCopy := nodeClass.DeepCopy() | ||
|
|
@@ -194,6 +198,17 @@ func (c *Controller) resolveAMIs(ctx context.Context, nodeClass *v1beta1.EC2Node | |
| return nil | ||
| } | ||
|
|
||
| func (c *Controller) resolvePlacementGroups(ctx context.Context, nodeClass *v1beta1.EC2NodeClass) error { | ||
| result, err := c.placementGroupProvider.Get(ctx, nodeClass) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if result != nil { | ||
| nodeClass.Status.PlacementGroups = append(nodeClass.Status.PlacementGroups, *result.GroupArn) | ||
|
There was a problem hiding this comment. This comment is relevant here, but its instructions for proceeding are unclear https://github.com/aws/karpenter-provider-aws/pull/4553/files#r1405582171 |
||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (c *Controller) resolveInstanceProfile(ctx context.Context, nodeClass *v1beta1.EC2NodeClass) error { | ||
| if nodeClass.Spec.Role != "" { | ||
| name, err := c.instanceProfileProvider.Create(ctx, nodeClass) | ||
|
|
@@ -215,9 +230,9 @@ type NodeClassController struct { | |
| } | ||
|
|
||
| func NewNodeClassController(kubeClient client.Client, recorder events.Recorder, subnetProvider *subnet.Provider, securityGroupProvider *securitygroup.Provider, | ||
| amiProvider *amifamily.Provider, instanceProfileProvider *instanceprofile.Provider, placementProvider *placementgroup.Provider) corecontroller.Controller { | ||
| return corecontroller.Typed[*v1beta1.EC2NodeClass](kubeClient, &NodeClassController{ | ||
| Controller: NewController(kubeClient, recorder, subnetProvider, securityGroupProvider, amiProvider, instanceProfileProvider, placementProvider), | ||
| }) | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package placementgroup | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync" | ||
|
|
||
| "github.com/aws/aws-sdk-go/service/ec2" | ||
| "github.com/aws/aws-sdk-go/service/ec2/ec2iface" | ||
| "github.com/mitchellh/hashstructure/v2" | ||
| "github.com/patrickmn/go-cache" | ||
|
|
||
| "github.com/aws/karpenter-provider-aws/pkg/apis/v1beta1" | ||
|
|
||
| "knative.dev/pkg/logging" | ||
|
|
||
| "sigs.k8s.io/karpenter/pkg/utils/pretty" | ||
| ) | ||
|
|
||
| type Provider struct { | ||
| sync.RWMutex | ||
| ec2api ec2iface.EC2API | ||
| cache *cache.Cache | ||
| cm *pretty.ChangeMonitor | ||
| } | ||
|
|
||
| func NewProvider(ec2api ec2iface.EC2API, cache *cache.Cache) *Provider { | ||
| return &Provider{ | ||
| ec2api: ec2api, | ||
| cm: pretty.NewChangeMonitor(), | ||
| // TODO: Remove cache for v1beta1, utilize resolved subnet from the AWSNodeTemplate.status | ||
| // Subnets are sorted on AvailableIpAddressCount, descending order | ||
| cache: cache, | ||
| } | ||
| } | ||
|
|
||
| func (p *Provider) Get(ctx context.Context, nodeClass *v1beta1.EC2NodeClass) (*ec2.PlacementGroup, error) { | ||
| p.Lock() | ||
| defer p.Unlock() | ||
|
|
||
| // Get selectors from the nodeClass, exit if no selectors defined | ||
| selectors := nodeClass.Spec.PlacementGroupSelectorTerms | ||
| if selectors == nil { | ||
| return nil, nil | ||
| } | ||
|
|
||
| // Look for a cached result | ||
| hash, err := hashstructure.Hash(selectors, hashstructure.FormatV2, &hashstructure.HashOptions{SlicesAsSets: true}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if cached, ok := p.cache.Get(fmt.Sprint(hash)); ok { | ||
| return cached.(*ec2.PlacementGroup), nil | ||
| } | ||
|
|
||
| var match *ec2.PlacementGroup | ||
| // Look up all ec2 placement groups | ||
| output, err := p.ec2api.DescribePlacementGroupsWithContext(ctx, &ec2.DescribePlacementGroupsInput{}) | ||
| if err != nil { | ||
| logging.FromContext(ctx).Errorf("discovering placement groups, %w", err) | ||
| return nil, err | ||
| } | ||
| for i := range output.PlacementGroups { | ||
| // filter results to only include those that match at least 1 selector | ||
| for x := range selectors { | ||
| if *output.PlacementGroups[i].GroupName == selectors[x].Name { | ||
| match = output.PlacementGroups[i] | ||
| p.cache.SetDefault(fmt.Sprint(hash), match) | ||
| break | ||
| } | ||
| } | ||
| } | ||
| return match, nil | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a question here of how we should pass requirements down when using something like
clusterplacement groups OR when using something likespreadwithrack.When using the
spreadwithrack, the EC2 documentation mentions that you can't launch more than 7 instances in a single AZ (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#:~:text=A%20rack%20spread%20placement%20group%20supports%20a%20maximum%20of%20seven%20running%20instances%20per%20Availability%20Zone), which means that we are restricted with our node limits when using this type of placement group. One option here is that we could constrain our requirements when using this type of placement group so that when we run out of instances to launch in a single AZ, we just get rid of that AZ from our requirements and start launching in other AZs. Another option here is that we allow to select on multiple placement groups and if we run out of space with one of thespreadplacement groups we just move to the other one.This handle differently, though, when we are dealing with
clusterorpartitionplacement groups where there is no limit on the number of instances that can be launched and it makes less sense to allow for multiple placement groups to be selected on.Based on all of these considerations, I think we should think about writing up a small design that considers the use-cases around placement groups, how they meld with requirements and what the API surface should look like.