A CLI for Harvester
a project by mohamed.belgaied
Updated 8 months ago. 11 hacker ♥️. 10 followers.

[comment]: # Harvester does not officially come with a CLI tool, the user is supposed to interact with Harvester mostly through the UI [comment]: # Though it is theoretically possible to use kubectl to interact with Harvester, the manipulation of Kubevirt YAML objects is absolutely not user friendly. [comment]: # Inspired by tools like multipass from Canonical to easily and rapidly create one of multiple VMs, I began the development of Harvester CLI. Currently, it works but Harvester CLI needs some love to be up-to-date with Harvester v1.0.2 and needs some bug fixes and improvements as well.

Project Description

Harvester CLI is a command line interface tool written in Go, designed to simplify interfacing with a Harvester cluster as a user. It is especially useful for testing purposes as you can easily and rapidly create VMs in Harvester by providing a simple command such as: harvester vm create my-vm --count 5 to create 5 VMs named my-vm-01 to my-vm-05.

asciicast

Harvester CLI is functional but needs a number of improvements: up-to-date functionality with Harvester v1.0.2 (some minor issues right now), modifying the default behaviour to create an opensuse VM instead of an ubuntu VM, solve some bugs, etc.

Github Repo for Harvester CLI: https://github.com/belgaied2/harvester-cli

Done in previous Hackweeks

  • Create a Github actions pipeline to automatically integrate Harvester CLI to Homebrew repositories: DONE
  • Automatically package Harvester CLI for OpenSUSE / Redhat RPMs or DEBs: DONE

Goal for this Hackweek

The goal for this Hackweek is to bring Harvester CLI up-to-speed with latest Harvester versions (v1.3.X and v1.4.X), and improve the code quality as well as implement some simple features and bug fixes.

Some nice additions might be: * Improve handling of namespaced objects * Add features, such as network management or Load Balancer creation ? * Add more unit tests and, why not, e2e tests * Improve CI * Improve the overall code quality * Test the program and create issues for it

Issue list is here: https://github.com/belgaied2/harvester-cli/issues

Resources

The project is written in Go, and using client-go the Kubernetes Go Client libraries to communicate with the Harvester API (which is Kubernetes in fact). Welcome contributions are:

  • Testing it and creating issues
  • Documentation
  • Go code improvement

What you might learn

Harvester CLI might be interesting to you if you want to learn more about:

  • GitHub Actions
  • Harvester as a SUSE Product
  • Go programming language
  • Kubernetes API
  • Kubevirt API objects (Manipulating VMs and VM Configuration in Kubernetes using Kubevirt)

Join this project

Looking for hackers with the skills:

harvester kubernetes kubevirt kvm go golang homebrew rpmbuild rpm cli client-go rancher

This project is part of:

Hack Week 21 Hack Week 22 Hack Week 23 Hack Week 24

Activity

  • 6 months ago: gpuliti joined this project.
  • 6 months ago: gpuliti liked this project.
  • 6 months ago: eminguez liked this project.
  • 7 months ago: joachimwerner liked this project.
  • 8 months ago: taotao joined this project.
  • over 1 year ago: Ishwon liked this project.
  • over 1 year ago: mpiala liked this project.
  • over 1 year ago: mhill liked this project.
  • over 2 years ago: mrussell liked this project.
  • over 2 years ago: rcase liked this project.
  • over 2 years ago: roseswe joined this project.
  • almost 3 years ago: rebeccazhuo liked this project.
  • almost 3 years ago: dpock liked this project.
  • almost 3 years ago: mohamed.belgaied started this project.
  • almost 3 years ago: mohamed.belgaied liked this project.
  • almost 3 years ago: mohamed.belgaied added keyword "rancher" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "go" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "golang" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "homebrew" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "rpmbuild" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "rpm" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "cli" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "client-go" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "kubevirt" to this project.
  • almost 3 years ago: mohamed.belgaied added keyword "kvm" to this project.

    • All Activity

    Comments

    • mohamed.belgaied
      8 months ago by mohamed.belgaied | Reply

      Should we revive this project for the next HackWeek ?

      • tonyajoyce
        6 months ago by tonyajoyce | Reply

        eyy definitely! This project sounds so good tho drive mad

    • gpuliti
      6 months ago by gpuliti | Reply

      Is the project ongoing? I might be interested!

      I've done something similar a couple of years ago, but more wide services capable https://github.com/Wabri/Imp I had something also for redmine that I was working on, but the laptop where I was working on was of the company I left before suse and sadly I totally forgot to push that feature branch.

    Similar Projects

    This project is one of its kind!