🐛 Handle nil ControlPlaneRef #4817
Conversation
Cluster.Spec.ControlPlaneRef is an optional field. getControlPlaneRef panics if it is nil. Handle this by supplying an empty struct, when ControlPlaneRef is nil.
k8s-ci-robot
added
release-note-none
|
Welcome @patrickdillon! |
k8s-ci-robot
added
needs-ok-to-test
|
Hi @patrickdillon. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/cc @prometherion |
|
@patrickdillon: GitHub didn't allow me to request PR reviews from the following users: prometherion. Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs. In response to this:
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. |
| @@ -1231,6 +1231,10 @@ func (r *AWSMachineReconciler) ensureInstanceMetadataOptions(ec2svc services.EC2 | |||
| func (r *AWSMachineReconciler) getControlPlane(ctx context.Context, log *logger.Logger, cluster *clusterv1.Cluster) (*unstructured.Unstructured, error) { | |||
| var ns string | |||
|
|
|||
| if cluster.Spec.ControlPlaneRef == nil { | |||
There was a problem hiding this comment.
Wouldn't be better returning an error?
A cluster with no Control Plane definition should be incorrect.
There was a problem hiding this comment.
A cluster with no Control Plane definition should be incorrect.
Even for a self-managed cluster?
There was a problem hiding this comment.
Do you mean with the cluster API managed label?
There was a problem hiding this comment.
Yes, I think it makes more sense to have an error return although im not sure how someone would get into this situation in the first place
There was a problem hiding this comment.
Same here, @patrickdillon, may I ask you to share why you should have a Cluster object with no ControlPlane reference?
There was a problem hiding this comment.
To clarify here, a cluster without a control plane reference is valid by contract, the reference is optional and it was made by design
There was a problem hiding this comment.
|
/close |
|
@patrickdillon: Closed this PR. In response to this:
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. |
What type of PR is this?
/kind bug
What this PR does / why we need it:
Cluster.Spec.ControlPlaneRef is an optional field. getControlPlaneRef panics if it is nil. Handle this by supplying an empty struct, which appears to be expected based on the unit test:
cluster-api-provider-aws/controllers/awsmachine_controller_test.go
Line 421 in bc1d3b1
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #4818
Special notes for your reviewer:
Checklist:
Release note: