design-proposal: Network binding plugin #280

EdDev · 2024-03-28T08:51:23Z

What this PR does / why we need it:

The network-binding-plugin feature design started back in mid 2023 and continued to evolve until implemented.

The design was conducted on a google document [1] out of convenience. (access is limited to the kubevirt-dev google group)

We now migrate it to a markdown version to provide better visibility.

[1] https://docs.google.com/document/d/13fLaqZuM8El_CT5XzxPv-1epKsB1-Spv_jtXveEkkdQ

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:
This is converting a google document to markdown, all design content has been already reviewed thoroughly
and implemented.

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Design: A design document was considered and is present (link) or not required
PR: The PR description is expressive enough and will help future contributors
Code: Write code that humans can understand and Keep it simple
Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
Upgrade: Impact of this change on upgrade flows was considered and addressed if required
Testing: New code requires new unit tests. New features and bug fixes require at least on e2e test
Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
Community: Announcement to kubevirt-dev was considered

Release note:

NONE

EdDev · 2024-03-28T08:51:49Z

/assign @AlonaKaplan

AlonaKaplan · 2024-03-28T12:46:09Z

/approve

kubevirt-bot · 2024-03-28T12:46:13Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AlonaKaplan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [AlonaKaplan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ormergi · 2024-03-28T12:57:22Z

design-proposals/network-binding-plugin/network-binding-plugin.md

+initially protected by a FG.
+Feature lifecycle is expected to pass alpha, beta and eventually to GA.
+
+## Appendix B: Concrete example for bridge-binding


Should start at A?

The network-binding-plugin feature design started back in mid 2023 and continued to evolve until implemented. The design was conducted on a google document [1] out of convenience. (access is limited to the `kubevirt-dev` google group) We now migrate it to a markdown version to provide better visibility. [1] https://docs.google.com/document/d/13fLaqZuM8El_CT5XzxPv-1epKsB1-Spv_jtXveEkkdQ Signed-off-by: Edward Haas <[email protected]>

ormergi · 2024-03-28T16:45:06Z

Thanks!

The ability to register network bindings to Kubevirt VMs was proposed [0] in order to allow Kubevirt VMs to connect to network bindings and gain advanced user defined network capabilities. The configuration is added to the kubevirt CR (kubevirt feature gate* + configuring the binding parameters + adding the appropriate NAD). This commit deploys and registers a primary user-defined-network (UDN) binding to the kubevirt CR, so it could be used by kubevirt users. * enabling the `NetworkBindingPlugins` kubevirt feature-gate on kubevirt CR is not needed as it is already set by default by HCO [1]. [0] kubevirt/community#280 [1] kubevirt#2603 Signed-off-by: Ram Lavi <[email protected]>

The ability to register network bindings to Kubevirt VMs was proposed [0] in order to allow Kubevirt VMs to connect to network bindings and gain advanced user defined network capabilities. The configuration is added to the kubevirt CR (kubevirt feature gate* + configuring the binding parameters). This commit deploys and registers a primary user-defined-network (UDN) binding to the kubevirt CR, so it could be used by kubevirt users. * enabling the `NetworkBindingPlugins` kubevirt feature-gate on kubevirt CR is not needed as it is already set by default by HCO [1]. [0] kubevirt/community#280 [1] kubevirt#2603 Signed-off-by: Ram Lavi <[email protected]>

* api: Introduce PrimaryUserDefinedNetworkBinding FG enabler Introduce a new enabler: PrimaryUserDefinedNetworkBinding. The default value is false. This commit only adds the relevant API and documentation. The logic of this enabler will be added in later commits. Signed-off-by: Ram Lavi <[email protected]> * hco-operator: Add primary UDN Binding image env var Adding a new image that is currently created by kubevirt/kubevirt [0]. [0] kubevirt/kubevirt#10425 Signed-off-by: Ram Lavi <[email protected]> * util/cluster: Set HCO main() to fail if PrimaryUDNImageEnvV env var is not set Signed-off-by: Ram Lavi <[email protected]> * operands/kubevirt: Set Kubevirt CR new primary UDN Binding plugin The ability to register network bindings to Kubevirt VMs was proposed [0] in order to allow Kubevirt VMs to connect to network bindings and gain advanced user defined network capabilities. The configuration is added to the kubevirt CR (kubevirt feature gate* + configuring the binding parameters). This commit deploys and registers a primary user-defined-network (UDN) binding to the kubevirt CR, so it could be used by kubevirt users. * enabling the `NetworkBindingPlugins` kubevirt feature-gate on kubevirt CR is not needed as it is already set by default by HCO [1]. [0] kubevirt/community#280 [1] #2603 Signed-off-by: Ram Lavi <[email protected]> * docs/cluster-configuration: Add primaryUserDefinedNetworkBinding FG Signed-off-by: Ram Lavi <[email protected]> --------- Signed-off-by: Ram Lavi <[email protected]>

kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Mar 28, 2024

kubevirt-bot requested review from cwilkers and jean-edouard March 28, 2024 08:51

kubevirt-bot added the size/XL label Mar 28, 2024

kubevirt-bot assigned AlonaKaplan Mar 28, 2024

EdDev force-pushed the network-binding-plugin branch 2 times, most recently from abaf935 to 708da12 Compare March 28, 2024 10:05

kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 28, 2024

ormergi reviewed Mar 28, 2024

View reviewed changes

EdDev force-pushed the network-binding-plugin branch from 708da12 to 00f9e53 Compare March 28, 2024 13:09

EdDev force-pushed the network-binding-plugin branch from 00f9e53 to 8bc2b5e Compare March 28, 2024 13:38

ormergi approved these changes Mar 28, 2024

View reviewed changes

kubevirt-bot assigned ormergi Mar 28, 2024

kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 28, 2024

kubevirt-bot merged commit 228b516 into kubevirt:main Mar 28, 2024
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

design-proposal: Network binding plugin #280

design-proposal: Network binding plugin #280

EdDev commented Mar 28, 2024

EdDev commented Mar 28, 2024

AlonaKaplan commented Mar 28, 2024

kubevirt-bot commented Mar 28, 2024

ormergi Mar 28, 2024

EdDev Mar 28, 2024

ormergi commented Mar 28, 2024

design-proposal: Network binding plugin #280

design-proposal: Network binding plugin #280

Conversation

EdDev commented Mar 28, 2024

EdDev commented Mar 28, 2024

AlonaKaplan commented Mar 28, 2024

kubevirt-bot commented Mar 28, 2024

ormergi Mar 28, 2024

Choose a reason for hiding this comment

EdDev Mar 28, 2024

Choose a reason for hiding this comment

ormergi commented Mar 28, 2024