SUSE Hack Week: suse-rancher-supportconfig

Description

Update: Live at https://github.com/e-minguez/suse-rancher-supportconfig I finally didn't used golang but used gum instead

SUSE's supportconfig support tool collects data from the SUSE Operating system. Rancher's rancher2_logs_collector.sh support tool does the same for RKE2/K3s.

Wouldn't be nice to have a way to run both and collect all data for SUSE based RKE2/K3s clusters? Wouldn't be even better with a fancy TUI tool like bubbletea?

Ideally the output should be an html page where you can see the logs/data directly from the browser.

Goals

Familiarize myself with both supportconfig and rancher2_logs_collector.sh tools
Refresh my golang knowledge
Have something that works at the end of the hackweek ("works" may vary )
Be better in naming things

Resources

All links provided above as well as huh

Looking for hackers with the skills:

supportconfig rancher2_logs_collector cli tui golang

This project is part of:

Hack Week 24

Activity

4 months ago: amanzini liked this project.

4 months ago: paolodepa liked this project.

4 months ago: wombelix liked this project.

4 months ago: horon liked this project.

5 months ago: geoagriogiannis joined this project.

5 months ago: eminguez liked this project.

5 months ago: eminguez added keyword "golang" to this project.

5 months ago: eminguez removed keyword rke2 from this project.

5 months ago: eminguez removed keyword k3s from this project.

5 months ago: eminguez added keyword "supportconfig" to this project.

5 months ago: eminguez added keyword "rancher2_logs_collector" to this project.

5 months ago: eminguez added keyword "rke2" to this project.

5 months ago: eminguez added keyword "k3s" to this project.

5 months ago: eminguez added keyword "cli" to this project.

5 months ago: eminguez added keyword "tui" to this project.

5 months ago: eminguez started this project.

5 months ago: eminguez originated this project.

Comments

Be the first to comment!

Similar Projects

cli

file-organizer: A CLI Tool for Efficient File Management by okhatavkar

Description

Create a Go-based CLI tool that helps organize files in a specified folder by sorting them into subdirectories based on defined criteria, such as file type or creation date. Users will pass a folder path as an argument, and the tool will process and organize the files within it.

Goals

Develop Go skills by building a practical command-line application.
Learn to manage and manipulate files and directories in Go using standard libraries.
Create a tool that simplifies file management, making it easier to organize and maintain directories.

Resources

Go Standard Libraries: Utilize os, filepath, and time for file operations.
CLI Development: Use flag for basic argument parsing or consider cobra for enhanced functionality.
Go Learning Material: Go by Example and The Go Programming Language Documentation.

Features

File Type Sorting: Automatically move files into subdirectories based on their extensions (e.g., documents, images, videos).
Date-Based Organization: Add an option to organize files by creation date into year/month folders.
User-Friendly CLI: Build intuitive commands and clear outputs for ease of use. This version maintains the core idea of organizing files efficiently while focusing on Go development and practical file management.

Jenny Static Site Generator by adam.pickering

Description

For my personal site I have been using hugo. It works, but I am not satisfied: every time I want to make a change (which is infrequently) I have to read through the documentation again to understand how hugo works. I don't find the documentation easy to use, and the structure of the repository that hugo requires is unintuitive/more complex than what I need. So, I have decided to write my own simple static site generator in Go. It is named Jenny, after my wife.

Goals

Pages can be written in markdown (which is automatically converted to HTML), but other file types are also allowed
Easy to understand and use
- Intuitive, simple design
- Clear documentation
- Hot reloading
- Binaries provided for download
Future maintenance is easy
- Automated releases

Resources

https://github.com/adamkpickering/jenny

Implement a CLI tool for Trento - trentoctl by nkopliku

Description

Implement a trentoctl CLI for interacting with a trento installation

Goals

learn rust
implement an initial trentoctl tool to enhance trento automation
have fun

Resources

trento rust. TUIs listed on this other hackweek project Hack on rich terminal user interfaces

A CLI for Harvester by mohamed.belgaied

[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.

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

Dartboard TUI by IValentin

Description

Our scalability and performance testing swiss-army knife tool Dartboard is a major WIP so why not add more scope creep? Dartboard is a cli tool which enables users to:

Define a "Dart" config file as YAML which defines the various components to be created/setup when Dartboard runs its commands
Spin up infrastructure utilizing opentofu/terraform providers
Setup K3s or RKE2 clusters on the newly created infrastructure
Deploy Rancher (with or without downstream cluster), rancher-monitoring (Grafana + Prometheus)
Create resources in-bulk within the newly created Rancher cluster (ConfigMaps, Secrets, Users, Roles, etc.)
Run various performance and scalability tests via k6
Export/Import various tracked metrics (WIP)

Given all these features (and the features to come), it can be difficult to onboard and transfer knowledge of the tool. With a TUI, Dartboard's usage complexity can be greatly reduced!

Goals

Create a TUI for Dartboard's "subcommands"
Gain more familiarity with Dartboard and create a more user-friendly interface to enable others to use it
Stretch Create a TUI workflow for generating a Dart file

Resources

https://github.com/charmbracelet/bubbletea

tui

Dartboard TUI by IValentin

Description

Our scalability and performance testing swiss-army knife tool Dartboard is a major WIP so why not add more scope creep? Dartboard is a cli tool which enables users to:

Define a "Dart" config file as YAML which defines the various components to be created/setup when Dartboard runs its commands
Spin up infrastructure utilizing opentofu/terraform providers
Setup K3s or RKE2 clusters on the newly created infrastructure
Deploy Rancher (with or without downstream cluster), rancher-monitoring (Grafana + Prometheus)
Create resources in-bulk within the newly created Rancher cluster (ConfigMaps, Secrets, Users, Roles, etc.)
Run various performance and scalability tests via k6
Export/Import various tracked metrics (WIP)

Given all these features (and the features to come), it can be difficult to onboard and transfer knowledge of the tool. With a TUI, Dartboard's usage complexity can be greatly reduced!

Goals

Create a TUI for Dartboard's "subcommands"
Gain more familiarity with Dartboard and create a more user-friendly interface to enable others to use it
Stretch Create a TUI workflow for generating a Dart file

Resources

https://github.com/charmbracelet/bubbletea

Try to render Agama in a TUI browser by ancorgs

Description

Agama is a new Linux installer that will be very likely used for SLES 16. It offers a modern and convenient web interface that can be executed both locally and remotely.

But of course some users will miss the old TUI (ncurses) interface of the YaST installer.

So I want to experiment whether would it be possible to render a simplified version of the web interface for TUI browsers. That's only doable and maintainable if we keep the current technology stack we use for rendering the full-blown page, simply replacing complicated UI elements with others that are easy to render. That means the browser would need to support Javascript.

Chawan seems to be almost there regarding support for Javascript, XHR and related technologies. But according to this conversation, the next missing piece would be to support recursive import of module script tags.

Unfortunately, Chawan is written in Nim and I'm pretty sure a week is not enough time for me to learn Nim, implement the feature at Chawan and then fix whatever is the next obstacle on the Agama side.

But if someone could take care of the Nim part, I would do the same with the Agama one. So this is basically a call for help to get this project even started.

Implement a CLI tool for Trento - trentoctl by nkopliku

Description

Implement a trentoctl CLI for interacting with a trento installation

Goals

learn rust
implement an initial trentoctl tool to enhance trento automation
have fun

Resources

trento rust. TUIs listed on this other hackweek project Hack on rich terminal user interfaces

golang

Hack on rich terminal user interfaces by amanzini

Description

TUIs (Textual User Interface) are a big classic of our daily workflow. Many linux users 'live' in the terminal and modern implementations have a lot to offer : unicode fonts, 24 bit colors etc.

Goals

Explore the current available solution on modern languages and implement a PoC , for example a small maze generator, porting of a classic game or just display the HackWeek cute logo.
Practice some Go / Rust coding and programming patterns
Fiddle around, hack, learn, have fun
keep a development diary, practice on project documentation

Follow this link for source code repository

includes development diary

Some ideas for inspiration:

Related projects:

https://hackweek.opensuse.org/24/projects/suse-rancher-supportconfig from @eminguez

Resources

file-organizer: A CLI Tool for Efficient File Management by okhatavkar

Description

Goals

Develop Go skills by building a practical command-line application.
Learn to manage and manipulate files and directories in Go using standard libraries.
Create a tool that simplifies file management, making it easier to organize and maintain directories.

Resources

Go Standard Libraries: Utilize os, filepath, and time for file operations.
CLI Development: Use flag for basic argument parsing or consider cobra for enhanced functionality.
Go Learning Material: Go by Example and The Go Programming Language Documentation.

Features

File Type Sorting: Automatically move files into subdirectories based on their extensions (e.g., documents, images, videos).
Date-Based Organization: Add an option to organize files by creation date into year/month folders.
User-Friendly CLI: Build intuitive commands and clear outputs for ease of use. This version maintains the core idea of organizing files efficiently while focusing on Go development and practical file management.

A CLI for Harvester by mohamed.belgaied

Project Description

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

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

toptop - a top clone written in Go by dshah

Description

toptop is a clone of Linux's top CLI tool, but written in Go.

Goals

Learn more about Go (mainly bubbletea) and Linux

Resources

GitHub

Learn enough Golang and hack on CoreDNS by jkuzilek

Description

I'm implementing a split-horizon DNS for my home Kubernetes cluster to be able to access my internal (and external) services over the local network through public domains. I managed to make a PoC with the k8s_gateway plugin for CoreDNS. However, I soon found out it responds with IPs for all Gateways assigned to HTTPRoutes, publishing public IPs as well as the internal Loadbalancer ones.

To remedy this issue, a simple filtering mechanism has to be implemented.

Goals

Learn an acceptable amount of Golang
Implement GatewayClass (and IngressClass) filtering for k8s_gateway
Deploy on homelab cluster
Profit?

Resources

EDIT: Feature mostly complete. An unfinished PR lies here. Successfully tested working on homelab cluster.