How about a "multusctl" utility?

[tliron]

What would you like to be added:

It would be great if we had a multusctl utility to simplify and enhance the experience of using and installing Multus.

Of course it's possible to use kubectl for everything, but why not do better?

Why is this needed:

Some examples of what I have in mind:

# Install Multus without having to use "kubectl apply ..."
# The --wait switch can block until everything is running

multusctl install --wait

# Create a NetworkAttachmentDefinition
# Allows using YAML in addition to JSON, and automatically
# stringifies it for inclusion in the custom resource spec

multusctl create myattachment --config=config.yaml

# This will list all NetworkAttachmentDefinition custom resources
# and for each show all pods that have annotated an attachment to them
# Even better: support KubeVirt and show which VirtualMachineInstance
# custom resources attach to them

multusctl list

If the team is interested in this feature, I'm willing to contribute some time towards getting the ball rolling. I have experience in creating "-ctl" tools for other Kubernetes projects.

[dougbtv]

@tliron this is interesting, and looks pretty slick, a nice UX enhancement. Would you like to join our next maintainers meeting to discuss the creation of such a utility?

Agenda doc @ https://docs.google.com/document/d/17-vkuoObBFBb6feXNA7tjTaKr-rs8ea0VTnqvlEdCv8/edit#

[tliron]

@dougbtv I went ahead and created it. :)

Please consider it a prototype -- it actually relies on code I wrote for other projects, and as such could not be included as is in Multus. However, with some work it would be easy enough to make it entirely independent of other projects.

It supports install with --wait, uninstall, create, delete, get, and list. list will show network attachment definitions in a namespace with names of pods that attach to each one. create can accept both JSON and YAML configs. So it's already quite complete as a basic tool.

I can demo it at the maintainers meeting and we can discuss if it can be an addition to Multus.

[electrocucaracha]

Hey @tliron, I just noticed this proposal which it's a great utility but I was wondering if this could be offered as kubectl plugin. Using that approach the commands can be executed as follow:

kubectl multus install --wait

[tliron]

Absolutely. It would be using Krew. I haven't done the wiring for that, but should be trivial.

[tliron]

@electrocucaracha On further look, no need to use Krew. It's enough to name the executable "kubectl-multus" and have it in the execution path, so kubectl will immediately pick it up as a plugin. Integrating with Krew is useful if we want to make it easier for people to install it.

[tliron]

Has there any progress about considering this tool? I'm happy to do the initial work, but I want to be sure that the Multus core team would accept some ownership on its ongoing maintenance.

[tliron]

^^ bump ^^

I am willing to help out and contribute this tool to the project, but I need help guidance core team members.

[dougbtv]

Woot! Any shot you can make the maintainer's meeting next week? Thursday morning. Tomo also has a kubectl add-on that might make a good home (but I need his input too). Thanks Tal!

…

On Mon, Mar 22, 2021, 2:33 PM Tal Liron ***@***.***> wrote: ^^ bump ^^ I am willing to help out and contribute this tool to the project, but I need help guidance core team members. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#488 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABJX7PJQ5OOD7M3DM63WX23TE6EQRANCNFSM4MM7NNXQ> .

[s1061123]

Suppose that we can put multusctl in our org, k8snetworkplumbingwg as new repository because multusctl is more than kubectl plugin. How about to bring this topic in NPWG this week, not maintainers meeting?

…

On Tue, Mar 23, 2021 at 4:31 AM Doug Smith ***@***.***> wrote: Woot! Any shot you can make the maintainer's meeting next week? Thursday morning. Tomo also has a kubectl add-on that might make a good home (but I need his input too). Thanks Tal! On Mon, Mar 22, 2021, 2:33 PM Tal Liron ***@***.***> wrote: > ^^ bump ^^ > > I am willing to help out and contribute this tool to the project, but I > need help guidance core team members. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > < #488 (comment) >, > or unsubscribe > < https://github.com/notifications/unsubscribe-auth/ABJX7PJQ5OOD7M3DM63WX23TE6EQRANCNFSM4MM7NNXQ > > . > — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#488 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABDJ2F5EMGF2X734MYLXTTTE6LJZANCNFSM4MM7NNXQ> .

[tliron]

Just let me know what you decide and send me an invite to the meeting!

[s1061123]

I decide to propose it as a one project under NPWG, https://github.com/k8snetworkplumbingwg as multus-cni itself.
You could launch multusctl as a part of project and you could get feedback from community.

I add your proposal in next meeting agenda, so let's discuss about it in NPWG meeting.
https://docs.google.com/document/d/1oE93V3SgOGWJ4O1zeD1UmpeToa0ZiiO6LqRAmZBPFWM/edit

[github-actions]

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[tliron]

In progress, not stale.

[github-actions]

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[tliron]

Not stale.

[tliron]

The project has been approved. This is its new home: https://github.com/k8snetworkplumbingwg/multusctl