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

docs: Add use-case examples for instanceTypes #263

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add use-case examples for instanceTypes #263

wants to merge 1 commit into from

Conversation

fabiand
Copy link
Member

@fabiand fabiand commented Oct 29, 2024 •
edited
Loading

What this PR does / why we need it:

Adding examples for what usecase an instanceType is useful.

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 #

Special notes for your reviewer:

Release note:

NONE

@kubevirt-bot
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 lyarwood 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

@kubevirt-bot kubevirt-bot requested a review from 0xFelix October 29, 2024 08:29
@kubevirt-bot kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Oct 29, 2024
@kubevirt-bot kubevirt-bot requested a review from jcanocan October 29, 2024 08:29
@kubevirt-bot kubevirt-bot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. size/XS release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Oct 29, 2024
@jcanocan
Copy link
Contributor

Nice initiative! Thanks
/lgtm

@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Oct 29, 2024
lyarwood
lyarwood reviewed Oct 29, 2024
View reviewed changes
Copy link
Member

@lyarwood lyarwood left a comment

Choose a reason for hiding this comment

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

Great idea, I'm not sure that Examples is needed and what about using a label instead to make it somewhat queryable?

instancetypes/cx/1/cx1.yaml
@@ -16,6 +16,7 @@ metadata:
In addition, in this series, the NUMA topology of the used
cores is provided to the VM.
instancetype.kubevirt.io/displayName: "Compute Exclusive"
instancetype.kubevirt.io/useCaseExamples: "Databases"
Copy link
Member

Choose a reason for hiding this comment

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

The Examples seems redundant tbh, what about instancetype.kubevirt.io/useCase ?

Copy link
Member

Choose a reason for hiding this comment

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

What about plural instancetype.kubevirt.io/useCases?

@kubevirt-bot
Copy link
Contributor

Pull requests that are marked with lgtm should receive a review
from an approver within 1 week.

After that period the bot marks them with the label needs-approver-review.

/label needs-approver-review

@kubevirt-bot kubevirt-bot added the needs-approver-review Indicates that a PR requires a review from an approver. label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lyarwood lyarwood lyarwood left review comments

@0xFelix 0xFelix Awaiting requested review from 0xFelix

@jcanocan jcanocan Awaiting requested review from jcanocan

Assignees

@jcanocan jcanocan

Labels
dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm Indicates that a PR is ready to be merged. needs-approver-review Indicates that a PR requires a review from an approver. release-note-none Denotes a PR that doesn't merit a release note. size/XS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@fabiand @kubevirt-bot @jcanocan @lyarwood @0xFelix