Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🐛 Handle nil ControlPlaneRef #4817

Closed
wants to merge 1 commit into from
Closed

🐛 Handle nil ControlPlaneRef #4817

wants to merge 1 commit into from

Conversation

patrickdillon
Copy link

@patrickdillon patrickdillon commented Feb 26, 2024 •
edited
Loading

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

ControlPlane: &unstructured.Unstructured{},

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:

  • squashed commits
  • includes documentation
  • includes emojis
  • adds unit tests
  • adds or updates e2e tests

Release note:

NONE

@patrickdillon
Handle nil controlPlaneRef
121f223 
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 k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority labels Feb 26, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @patrickdillon!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-aws 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-aws has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 26, 2024
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign richardcase for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@patrickdillon patrickdillon mentioned this pull request Feb 26, 2024
Closed
@patrickdillon
Copy link
Author

/cc @prometherion

@k8s-ci-robot
Copy link
Contributor

@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:

/cc @prometherion

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.

@patrickdillon
Copy link
Author

cc @prometherion

prometherion
prometherion reviewed Feb 26, 2024
View reviewed changes
controllers/awsmachine_controller.go
@@ -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 {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't be better returning an error?

A cluster with no Control Plane definition should be incorrect.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A cluster with no Control Plane definition should be incorrect.

Even for a self-managed cluster?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean with the cluster API managed label?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, @patrickdillon, may I ask you to share why you should have a Cluster object with no ControlPlane reference?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To clarify here, a cluster without a control plane reference is valid by contract, the reference is optional and it was made by design

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is handled over at https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/4822/files#diff-8428e7154b9d78ae8ea33a3534b5051bd14a8b282d4d9f27d01889a8d1e3b2c1R139-R142

This was referenced Feb 26, 2024
Closed
Merged
@patrickdillon
Copy link
Author

/close
in favor of #4822

@k8s-ci-robot
Copy link
Contributor

@patrickdillon: Closed this PR.

In response to this:

/close
in favor of #4822

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.

@patrickdillon patrickdillon mentioned this pull request Feb 27, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@prometherion prometherion prometherion left review comments

@vincepri vincepri vincepri left review comments

@nrb nrb nrb left review comments

@faiq faiq Awaiting requested review from faiq

@luthermonson luthermonson Awaiting requested review from luthermonson

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Panic when controlPlaneRef is nil
6 participants
@patrickdillon @k8s-ci-robot @nrb @vincepri @faiq @prometherion