Design Proposal: Provide way to customize generated Multus pod annotation

[chomatdam]

What this PR does / why we need it:
When virt-controller is generating the Multus pod annotation, several properties can be set:

• name
• namespace
• interface
• mac (optional)

This proposal enables the customization of the Multus annotation.

Implementation

• kubevirt/kubevirt/pull/10923

Documentation

• kubevirt/user-guide/pull/749

Which issue(s) this PR fixes:
Fixes #4564

Checklist

• 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 (Provide way to customize generated Multus pod annotation user-guide#749).
• Community: Announcement to kubevirt-dev (Slack Message)

Release note:

Add a way to customize generated Multus pod annotation using mutating webhook

[kubevirt-bot]

[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 vladikr 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:

• OWNERS

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

[kubevirt-bot]

Hi @chomatdam. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

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.

[EdDev]

/cc

[EdDev]

/sig network

[EdDev]

Thank you for this proposal, I like its direction to integrate into the main flow with minimal API change.

My ideal solution would be to have the webhook developed and deployed independently of the core project, but this can be negotiated.

[EdDev]

I think that two interfaces can point to the same network (i.e NAD) and it is a valid configuration.
This will be a 1:N mapping.
Is that desired?

[EdDev]

Could you please add a few words about the different components introduced?
(e.g. webhook mutation admitter)

• The webhook could be introduced from "outside" the core kubevirt, behaving as an add-on.
  It will be less intrusive for most of the users who do not need it and empower the author of it to maintain it himself. If it will prove useful for more community members, we can then integrate it as a hook point into the core kubevirt.

  • Another option is to make it pluggable at build time. There may be other options to explore.

Note: The option of having this as part of the kubevirt/kubevirt code-base (the webhook itself) should come with a Feature Gate.

It would also be nice to describe in more detail and formally how the "merge" algorithm works, between the annotation customized data and the multus network one.

[EdDev]

From a maintenance point of view, this is a burden to track. While today these are reserved, in the future others may be used by the core.
As such, I think it will be better to only warn in the documentation about this but not restrict/validate in-code.

[EdDev]

/cc @AlonaKaplan

[EdDev]

/sig api

[kubevirt-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[kubevirt-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

[kubevirt-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

/close

[kubevirt-bot]

@kubevirt-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

/close

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-sigs/prow repository.