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

📖 improve godoc of the ipAddrs field #1828

Closed
wants to merge 1 commit into from
Closed

📖 improve godoc of the ipAddrs field #1828

wants to merge 1 commit into from

Conversation

rvanderp3
Copy link
Contributor

What this PR does / why we need it:
When reading the API specs, it was not obvious to me what the syntax of the field was. This PR updates the description of the ipAddrs field to prevent ambiguity when specifying the IP address.

Which issue(s) this PR fixes
Resolves a minor issue I found in the troubleshooting guide.

Special notes for your reviewer:

Release note:
None

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 17, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @rvanderp3!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-vsphere 🎉. 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-vsphere 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
Copy link
Contributor

Hi @rvanderp3. 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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 17, 2023
@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 srm09 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

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 17, 2023
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 17, 2023
@srm09 srm09 added this to the v1.7.0 milestone Mar 21, 2023
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 19, 2023
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 19, 2023
@randomvariable
Copy link
Member

/ok-to-test

Thanks for this, and apologies for the delay.

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 19, 2023
@randomvariable
Copy link
Member

You may need to rebase this on main to pick up all the CI improvements

@sbueringer
Copy link
Member

/retitle 📖 improve godoc of the ipAddrs field

@k8s-ci-robot k8s-ci-robot changed the title 📖 provide clarification on the syntax of the ipAddrs field 📖 improve godoc of the ipAddrs field Jul 20, 2023
sbueringer
sbueringer reviewed Jul 21, 2023
View reviewed changes
apis/v1beta1/types.go
@@ -280,7 +280,8 @@ type NetworkDeviceSpec struct {
Gateway6 string `json:"gateway6,omitempty"`

// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
// to this device.
// to this device. IP addresses must also specify the segment length in
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// to this device. IP addresses must also specify the segment length in
// to this device. IP addresses must also specify the segment length in

@rvanderp3 this change in all 3 files should make the linter happy

Copy link
Member

Choose a reason for hiding this comment

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

Maybe also rebase onto main

randomvariable
randomvariable requested changes Jul 28, 2023
View reviewed changes
Copy link
Member

@randomvariable randomvariable left a comment

Choose a reason for hiding this comment

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

As per #1828 (comment)

@k8s-ci-robot
Copy link
Contributor

@rvanderp3: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-provider-vsphere-e2e-main 2929ebe link true /test pull-cluster-api-provider-vsphere-e2e-main

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

@randomvariable
Copy link
Member

/assign @killianmuldoon

@sbueringer sbueringer removed this from the v1.7 milestone Aug 3, 2023
@sbueringer sbueringer added this to the v1.8 milestone Aug 4, 2023
@killianmuldoon killianmuldoon mentioned this pull request Aug 4, 2023
Merged
@killianmuldoon
Copy link
Contributor

/close

In favor of #2168 which makes a minor fix for the linter. Thanks for the contribution @rvanderp3

@k8s-ci-robot
Copy link
Contributor

@killianmuldoon: Closed this PR.

In response to this:

/close

In favor of #2168 which makes a minor fix for the linter. Thanks for the contribution @rvanderp3

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.

killianmuldoon
killianmuldoon reviewed Aug 4, 2023
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/close

@rvanderp3 rvanderp3 mentioned this pull request Nov 2, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@killianmuldoon killianmuldoon killianmuldoon left review comments

@sbueringer sbueringer sbueringer left review comments

@randomvariable randomvariable randomvariable requested changes

@MaxRink MaxRink Awaiting requested review from MaxRink

@srm09 srm09 Awaiting requested review from srm09

Assignees

@killianmuldoon killianmuldoon

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.8
Development

Successfully merging this pull request may close these issues.
7 participants
@rvanderp3 @k8s-ci-robot @k8s-triage-robot @randomvariable @sbueringer @killianmuldoon @srm09