Allow skipping state validations for resources that support cyclic references #544
Conversation
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
|
/retest |
ack-prow
bot
added
the
do-not-merge/work-in-progress
TiberiuGC
force-pushed
the
feature/allow-cyclic-references
branch
from
62d1932 to
e66e2f7
Compare
TiberiuGC
changed the title
TiberiuGC
force-pushed
the
feature/allow-cyclic-references
branch
from
e66e2f7 to
390d759
Compare
TiberiuGC
changed the title
TiberiuGC
changed the title
TiberiuGC
force-pushed
the
feature/allow-cyclic-references
branch
from
390d759 to
8213a7d
Compare
|
/retest |
|
flaky eks tests |
ack-prow
bot
removed
the
do-not-merge/work-in-progress
|
@TiberiuGC: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
a-hilaly
approved these changes
Aug 29, 2024
Comment on lines
+357
to
+370
| // SkipResourceStateValidations if true, skips state validations performed during | ||
| // ResolveReferences step, that ensure the referenced resource exists in AWS and is synced. | ||
| // This is needed when multiple resources reference each other in a cyclic manner, | ||
| // as otherwise they will never sync due to circular ResourceReferenceNotSynced errors. | ||
| // | ||
| // see: https://github.com/aws-controllers-k8s/community/issues/2119 | ||
| // | ||
| // N.B. when setting this field to true, the developer is responsible to amend the sdkCreate | ||
| // and/or sdkUpdate functions of the referencing resource, in order to correctly wait on the | ||
| // desired state of the referenced resource, before SDK API calls that require the latter. | ||
| // In the future, we could consider generating this logic, but for now this is a niche use case. | ||
| // | ||
| // see: https://github.com/aws-controllers-k8s/ec2-controller/blob/main/pkg/resource/security_group/sdk.go | ||
| SkipResourceStateValidations bool `json:"skip_resource_state_validations"` |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: a-hilaly, TiberiuGC The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ack-prow bot
pushed a commit
to aws-controllers-k8s/ec2-controller
that referenced
this pull request
Aug 29, 2024
Issue #, if available: aws-controllers-k8s/community#2119 Description of changes: Cyclic references support is done via. the following workflow: 1. skip runtime reference state validations by setting `SecurityGroup.Rules.UserIDGroupPairs.GroupID.skip_resource_state_validations: true` (see aws-controllers-k8s/code-generator#544). This allows runtime to proceed with the `sdkCreate` call. 2. inside `sdkCreate` and `sdkUpdate` add custom logic that checks whether referenced security groups are being created on AWS end (i.e. `groupID != nil`). If the checks succeed, move forward with syncing SG rules. Otherwise, requeue and wait for all referenced SGs to be created. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
nnbu
pushed a commit
to nnbu/ack-ec2-controller
that referenced
this pull request
Sep 18, 2024
Issue #, if available: aws-controllers-k8s/community#2119 Description of changes: Cyclic references support is done via. the following workflow: 1. skip runtime reference state validations by setting `SecurityGroup.Rules.UserIDGroupPairs.GroupID.skip_resource_state_validations: true` (see aws-controllers-k8s/code-generator#544). This allows runtime to proceed with the `sdkCreate` call. 2. inside `sdkCreate` and `sdkUpdate` add custom logic that checks whether referenced security groups are being created on AWS end (i.e. `groupID != nil`). If the checks succeed, move forward with syncing SG rules. Otherwise, requeue and wait for all referenced SGs to be created. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #, if available: aws-controllers-k8s/community#2119
Description of changes:
Introducing a new field
config.Resources.Fields.References.SkipResourceStateValidations, that, if set to true, skips state validations performed duringResolveReferencesstep, that ensure the referenced resource exists in AWS and is synced. This is needed when multiple resources reference each other in a cyclic manner, as otherwise they will never sync due to circularResourceReferenceNotSyncederrors.N.B. when setting this field to true, the developer is responsible to amend the
sdkCreateand/orsdkUpdatefunctions of the referencing resource, in order to correctly wait on the desired state of the referenced resource, before SDK API calls that require the latter. In the future, we could consider generating this logic, but for now this is a niche use case.see (example will be available when this PR is merged): https://github.com/aws-controllers-k8s/ec2-controller/blob/main/pkg/resource/security_group/sdk.go
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.