kubectl-like get command for mgrctl

[cbosdo]

Project Title:

kubectl-like get command for mgrctl

Description:

Uyuni is an open source systems management solution that can be used to manage various Linux distributions using a powerful web UI and API.

mgrctl is a tool meant to offer API access to the Uyuni server. At the moment it provides a limited set of features and only covers raw API calls.

The goal of this task is to implement a get command that works like the one from kubectl. So users could query the API using a command like: mgrctl get <object_type> [options].

• The first object types to implement could be system, group as those are central concepts of Uyuni.
• The options would provide search by name, filtering using some of the object properties and output format options.

For instance mgrctl get system -f cpu=x86_64 -o yaml would return a YAML file with the systems that have an x86_64 CPU.

Note, this idea already exists as an uyuni-tools issue: uyuni-project/uyuni-tools#238

Deliverable:

• The code as a PR in uyuni-tools repository.
• Documentation for the new command at least in the mgrctl get --help.

Mentor:

• @cbosdo

Skills:

• Good Golang knowledge.

Skill Level: Medium

Project Size: Medium Sized Project (125 hours)

Beware this could easily turn into a rabbit hole: properly define the limits of the project with the mentor. Better have only a few objects covered correctly than a lot with many missing pieces.

Get started:

• Join GitHub Discussions and chatrooms: uyuni-project/devel uyuni-project/users
• Get familiar with uyuni
• Get familiar with the mgrctl code. Starting with the api command code could be a good idea.
• Check the Uyuni API docs
• Set up a development Uyuni server VM, e.g. with sumaform. This page can help you getting started. The crucial part is the network setup as it would lead to various strange problems later. Make sure to read https://github.com/uyuni-project/uyuni/wiki/Libvirt-DNS-and-DHCP-without-Avahi to help with this.

[cbosdo]

@ddemaio can you add the Uyuni label on this card please?

[AkashKumar7902]

Hey,
I am interested in working on this idea. I have prior experience with golang working in Linux Foundation Mentorship Program and through my internship at a gsoc project. I would look on the getting started section and familiarize myself with the project.

[cbosdo]

Hey, I am interested in working on this idea. I have prior experience with golang working in Linux Foundation Mentorship Program and through my internship at a gsoc project. I would look on the getting started section and familiarize myself with the project.

Nice! Welcome aboard! Feel free to join the devel channel on gitter to ask questions if needed.

[cbosdo]

BTW Start with installing Uyuni in a VM. This page can help you getting started. The crucial part is the network setup as it would lead to various strange problems later. Make sure to read https://github.com/uyuni-project/uyuni/wiki/Libvirt-DNS-and-DHCP-without-Avahi to help with this.