AWS IAM: ensure cleanup of IAM roles using finalizer #97
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.
Description
Prior to this PR, in some circumstances, AWS IAM roles created by the credentials operator could be left dangling, when the operator was not available while the Pods and ServiceAccounts responsible for their creation were removed or modified.
Finalizers are now used to ensure that this doesn't happen.
Pods have a finalizer added to them in the pod webhook. This finalizer does the minimal amount of work - when a pod is terminating, it modifies a label on the linked ServiceAccount and removes the finalizer, or if the ServiceAccount no longer exists, it simply removes the finalizer. This is done to enable the pod to terminate as soon as possible.
The bulk of the work is done on the ServiceAccount, where IAM roles will be removed if it is labeled as having no related pods (by the pod reconciler's finalizer) or if the ServiceAccount itself is terminating.
References
Related: otterize/intents-operator#309
Testing
Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.
Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.
Also include details of the environment this PR was developed in (language/platform/browser version).
Checklist