SUSE Hack Week: Jenny Static Site Generator

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

Looking for hackers with the skills:

go golang websockets website tool cli commandline cobra markdown

This project is part of:

Hack Week 24

Activity

4 months ago: epaolantonio liked this project.

4 months ago: adam.pickering started this project.

4 months ago: adam.pickering added keyword "go" to this project.

4 months ago: adam.pickering added keyword "golang" to this project.

4 months ago: adam.pickering added keyword "websockets" to this project.

4 months ago: adam.pickering added keyword "website" to this project.

4 months ago: adam.pickering added keyword "tool" to this project.

4 months ago: adam.pickering added keyword "cli" to this project.

4 months ago: adam.pickering added keyword "commandline" to this project.

4 months ago: adam.pickering added keyword "cobra" to this project.

4 months ago: adam.pickering added keyword "markdown" to this project.

4 months ago: adam.pickering originated this project.

Comments

Be the first to comment!

Similar Projects

go

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

Metrics Server viewer for Kubernetes by bkampen

This project is finished please visit the github repo below for the tool.

Description

Build a CLI tools which can visualize Kubernetes metrics from the metrics-server, so you're able to watch these without installing Prometheus and Grafana on a cluster.

Goals

Learn more about metrics-server
Learn more about the inner workings of Kubernetes.
Learn more about Go

Resources

https://github.com/bvankampen/metrics-viewer

Automate PR process by idplscalabrini

Description

This project is to streamline and enhance the pr review process by adding automation for identifying some issues like missing comments, identifying sensitive information in the PRs like credentials. etc. By leveraging GitHub Actions and golang hooks we can focus more on high-level reviews

Goals

Automate lints and code validations on Github actions
Automate code validation on hook
Implement a bot to pre-review the PRs

Resources

Golang hooks and Github actions

ddflare: (Dynamic)DNS management via Cloudflare API in Kubernetes by fgiudici

Description

ddflare is a project started a couple of weeks ago to provide DDNS management using v4 Cloudflare APIs: Cloudflare offers management via APIs and access tokens, so it is possible to register a domain and implement a DynDNS client without any other external service but their API.

Since ddflare allows to set any IP to any domain name, one could manage multiple A and ALIAS domain records. Wouldn't be cool to allow full DNS control from the project and integrate it with your Kubernetes cluster?

Goals

Main goals are:

add containerized image for ddflare
extend ddflare to be able to add and remove DNS records (and not just update existing ones)
add documentation, covering also a sample pod deployment for Kubernetes
write a ddflare Kubernetes operator to enable domain management via Kubernetes resources (using kubebuilder)

Available tasks and improvements tracked on ddflare github.

Resources

https://github.com/fgiudici/ddflare
https://developers.cloudflare.com/api/
https://book.kubebuilder.io

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

golang

OpenQA Golang api client by hilchev

Description

I would like to make a simple cli tool to communicate with the OpenQA API

Goals

OpenQA has a ton of information that is hard to get via the UI. A tool like this would make my life easier :)
Would potentially make it easier in the future to make UI changes without Perl.
Improve my Golang skills

Resources

https://go.dev/doc/
https://openqa.opensuse.org/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

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

suse-rancher-supportconfig by eminguez

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

Harvester Packer Plugin by mrohrich

Description

Hashicorp Packer is an automation tool that allows automatic customized VM image builds - assuming the user has a virtualization tool at their disposal. To make use of Harvester as such a virtualization tool a plugin for Packer needs to be written. With this plugin users could make use of their Harvester cluster to build customized VM images, something they likely want to do if they have a Harvester cluster.

Goals

Write a Packer plugin bridging the gap between Harvester and Packer. Users should be able to create customized VM images using Packer and Harvester with no need to utilize another virtualization platform.

Resources

Hashicorp documentation for building custom plugins for Packer https://developer.hashicorp.com/packer/docs/plugins/creation/custom-builders

Source repository of the Harvester Packer plugin https://github.com/m-ildefons/harvester-packer-plugin

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.

suse-rancher-supportconfig by eminguez

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

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

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

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