You need to sign in or sign up before continuing.
A CLI for Harvester
a project by mohamed.belgaied
Updated 12 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

  • 11 months ago: gpuliti joined this project.
  • 11 months ago: gpuliti liked this project.
  • 11 months ago: eminguez liked this project.
  • 11 months ago: joachimwerner liked this project.
  • about 1 year ago: taotao joined this project.
  • almost 2 years ago: Ishwon liked this project.
  • almost 2 years ago: mpiala liked this project.
  • about 2 years 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.
  • over 3 years ago: rebeccazhuo liked this project.
  • over 3 years ago: dpock liked this project.
  • over 3 years ago: mohamed.belgaied started this project.
  • over 3 years ago: mohamed.belgaied liked this project.
  • over 3 years ago: mohamed.belgaied added keyword "rancher" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "go" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "golang" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "homebrew" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "rpmbuild" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "rpm" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "cli" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "client-go" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "kubevirt" to this project.
  • over 3 years ago: mohamed.belgaied added keyword "kvm" to this project.

    • All Activity

    Comments

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

      Should we revive this project for the next HackWeek ?

      • tonyajoyce
        10 months ago by tonyajoyce | Reply

        eyy definitely! This project sounds so good tho drive mad

    • gpuliti
      11 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.

    • sarausa0106
      2 months ago by sarausa0106 | Reply

      Not including a CLI is acceptable if Harvester is aimed at mainstream users, small edge systems, or hybrid infrastructures where the UI is sufficient. hole io

    Similar Projects

    Mammuthus - The NFS-Ganesha inside Kubernetes controller by vcheng

    Description

    As the user-space NFS provider, the NFS-Ganesha is wieldy use with serval projects. e.g. Longhorn/Rook. We want to create the Kubernetes Controller to make configuring NFS-Ganesha easy. This controller will let users configure NFS-Ganesha through different backends like VFS/CephFS.

    Goals

    1. Create NFS-Ganesha Package on OBS: nfs-ganesha5, nfs-ganesha6
    2. Create NFS-Ganesha Container Image on OBS: Image
    3. Create a Kubernetes controller for NFS-Ganesha and support the VFS configuration on demand. Mammuthus

    Resources

    NFS-Ganesha

    Mammuthus - The NFS-Ganesha inside Kubernetes controller by vcheng

    Description

    As the user-space NFS provider, the NFS-Ganesha is wieldy use with serval projects. e.g. Longhorn/Rook. We want to create the Kubernetes Controller to make configuring NFS-Ganesha easy. This controller will let users configure NFS-Ganesha through different backends like VFS/CephFS.

    Goals

    1. Create NFS-Ganesha Package on OBS: nfs-ganesha5, nfs-ganesha6
    2. Create NFS-Ganesha Container Image on OBS: Image
    3. Create a Kubernetes controller for NFS-Ganesha and support the VFS configuration on demand. Mammuthus

    Resources

    NFS-Ganesha

    terraform-provider-feilong by e_bischoff

    Project Description

    People need to test operating systems and applications on s390 platform.

    Installation from scratch solutions include:

    • just deploy and provision manually add-emoji (with the help of ftpboot script, if you are at SUSE)
    • use s3270 terminal emulation (used by openQA people?)
    • use LXC from IBM to start CP commands and analyze the results
    • use zPXE to do some PXE-alike booting (used by the orthos team?)
    • use tessia to install from scratch using autoyast
    • use libvirt for s390 to do some nested virtualization on some already deployed z/VM system
    • directly install a Linux kernel on a LPAR and use kvm + libvirt from there

    Deployment from image solutions include:

    • use ICIC web interface (openstack in disguise, contributed by IBM)
    • use ICIC from the openstack terraform provider (used by Rancher QA)
    • use zvm_ansible to control SMAPI
    • connect directly to SMAPI low-level socket interface

    IBM Cloud Infrastructure Center (ICIC) harnesses the Feilong API, but you can use Feilong without installing ICIC, provided you set up a "z/VM cloud connector" into one of your VMs following this schema.

    What about writing a terraform Feilong provider, just like we have the terraform libvirt provider? That would allow to transparently call Feilong from your main.tf files to deploy and destroy resources on your system/z.

    Other Feilong-based solutions include:

    • make libvirt Feilong-aware
    • simply call Feilong from shell scripts with curl
    • use zvmconnector client python library from Feilong
    • use zthin part of Feilong to directly command SMAPI.

    Goal for Hackweek 23

    My final goal is to be able to easily deploy and provision VMs automatically on a z/VM system, in a way that people might enjoy even outside of SUSE.

    My technical preference is to write a terraform provider plugin, as it is the approach that involves the least software components for our deployments, while remaining clean, and compatible with our existing development infrastructure.

    Goals for Hackweek 24

    Feilong provider works and is used internally by SUSE Manager team. Let's push it forward!

    Let's add support for fiberchannel disks and multipath.

    Possible goals for Hackweek 25

    Modernization, maturity, and maintenance.