Deprecate config.BasePackages.Controller in favor of ControllerMap #195
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 of your changes
config.BasePackages.Controller
does not convey which subpackage a controller should be added to. One option would be to rely on a path component of the controller (e.g., if the controller being registered isinternal/controller/eks/clusterauth
, then the subpackage could beeks
as deduced from the path) but the proposedControllerMap
makes this more explicit and makes it easier to override/remap if needed.The proposed ControllerMap is a map from the controller's path to the subpackage name for the controller.
Controller
array is also deprecated in favor ofControllerMap
.Note: The deprecated
BasePackages.Controller
API still exists and behaves exactly as is (if not, it will be treated as a bug), and the newBasePackages.ControllerMap
API is an optional one. In summary, this PR is intended to be backwards-compatible.I have:
make reviewable
to ensure this PR is ready for review.backport release-x.y
labels to auto-backport this PR if necessary.How has this code been tested
Tested via crossplane-contrib/provider-upjet-aws#680.