Forklift - Text based GUI utility for dealing with containers
Project Description
This is a simple and handy text based GUI utility for dealing with boring
and repetitive tasks while managing containers.
If you usually manage them in your daily activities you'll surely deal
a lot with the CLI and execute repetitive commands for:
building images, creating containers, running, killing and stopping
them all the time.
It doesn't really matter if you are a Developer, a DevOps or a SRE;
most of your time might be spent on the CLI for deleting/respawning/starting
new instances for your favorite product.
You can surely do it from a GUI or editor (vscode, eclipse, ...)
but it might be messy if you're managing them remotely through SSH and
all you have at your disposal is just your trusty text-only shell connection.
That's the reason for this simple, quick, text-only curses based utility,
no matter if containers are running on a remote machine, locally or if you
prefer a specific Window Manager.
I expressly don't want to rely on X11/Wayland, infinite dependencies
(or keep them to the bare minimum) and it has to be text-only and usable from
a remote shell.
This utility relies on: python (+yaml) and curses bindings (just plain curses,
no extra widgets required).
It is not a fully fledged solution but rather a small and quick tool for
running boring tasks, you'll still use docker/podman of your choice but you
don't want to be annoyed by usual and repetitive commands
(docker ps -a; docker kill ; docker start).
That's what this utility is about.
Goal for this Hackweek
Building a working tool for dealing with boring and repetitive tasks:
- Totally independent from: docker, podman, LXD (planned)
- Not related to kubernetes, orchestrators or pods, just "simple" containers. Targeted to personal workstations and workflows, no matter if local or on a remote ssh shell
- Stop/Start/Kill container
- Build containers from Images
- Build images from Containerfile/Docker file
- Delete images and container quickly without ps+rm+rmi commands
- A simple and quick curses based cli gui to be used with fewer keys
- Running locally or through a SSH remote connection should be the same
Resources
git repository: https://github.com/andreabenini/podmaster/tree/main/forklift/
This is a brand new idea with no prior source code or fork from an existing tool.
I want to develop the idea and have a prototype at the end of the Hack Week
keywords
text gui, command line, utility, curses, shell, container, python, podman, docker, ssh, remote
This project is part of:
Hack Week 23
Activity
Comments
-
about 2 years ago by andreabenini | Reply
I'll use comment section to post general updates and features.
- General purpose widgets are in place, maybe they need some refinement but are stable enough for the project, I'm now using: messagebox, inputbox, menu, confirm box
- Container image management is now working and I'm able to build new images while parking the program's curses interface
- Container listing and general action items (start/attach, kill, rename, delete) are now working
- Container listing is suitable for personal desktop usage, not really usable on a fully fledged server with hundreds or thousand containers. No container search feature (yet, but planned)
- Storing configurations in yaml file (easy to read and you can also add comments in it)
- docker and podman are fully supported (and tested), never tried LXD or other container managers. I'm now planning to support docker and podman because they basically have the same interface and commands, if necessity arises I'll add something else too.
- I'll publish curses widgets today, barebone (but working) main utility tomorrow after the tests. I'm now using the python testunit module to suit them all. I'm still without external dependencies, libraries or whatsoever and I'm still working to keep them away; the project has to be simple and without deps (or a required virtual environment) to keep it to the bare minimum.
-
about 2 years ago by andreabenini | Reply
Project info, sample configs and contrib materials are already in the github repo. Rushing on test units for the utility, v0.1 (stable) will be released today ahead in schedule
-
about 2 years ago by andreabenini | Reply
Project published, download everything from https://github.com/andreabenini/podmaster/tree/main/forklift/ Still testing and adding basic functionalities but it's now live and working
-
about 2 years ago by andreabenini | Reply
The utility is straight simple but some documentation is still necessary, just some markdown and a couple of screenshots.
-
about 2 years ago by andreabenini | Reply
Project is working, I've deployed locally for further improvements and in my VM where the real work is. I'm using it locally for further development, test-units checks, local stuff. Remotely on my production machine and it's now working. Constant updates are frequent when new features or comments arise but you can consider it usable. Publishing the package on Pypi is an installation feature coming real soon, feel free to use it right now.
-
almost 2 years ago by andreabenini | Reply
v0.2.4 released.
See CHANGELOG file, updated documentation and a small video in the git repository. Mostly bug fixing and few small new features. Feature freeze at the moment because I'm now focusing on the Pypi catalog for a really smart installation. If someone does not want to get the repo cloned from github, the next version will address pypi specifically. I'm still planning to add LXD, probably just for the sake of doing it because I have never had a single request for it. For personal usage (not orchestration) adding lxd might give me almost a 100% coverage (ubuntu users mostly). Feel free to submit patches and comments on github. -
almost 2 years ago by socon | Reply
Looks like a great project and is aligned with the vision to manage containers for Dolomite, but I wonder why Python. We are trying to reduce the dependency on Python for ALP.
-
about 1 year ago by andreabenini | Reply
I'm a bad person and discovered your comment right now, I apologize about it. Python was picked up to create a small and quick project barely in just that week, that's the main reason for it. I was able to create a working project quickly and maybe it was one of the reasons why I won. I have developed it a little bit more as you can see, this project has now NO python lib deps at all. no libraries like curses or other external libs, I've even rewrote a couple of things to avoid adding pyyaml (which is not included by default). Required libs are always default included ones so virtualenv is not required, basically: subprocess, json, argparse, math and few more..
I can quite easily rewrite it with Go if you're still interested, one self included binary for every architecture is probably better and surely faster too
-
Similar Projects
Technical talks at universities by agamez
Description
This project aims to empower the next generation of tech professionals by offering hands-on workshops on containerization and Kubernetes, with a strong focus on open-source technologies. By providing practical experience with these cutting-edge tools and fostering a deep understanding of open-source principles, we aim to bridge the gap between academia and industry.
For now, the scope is limited to Spanish universities, since we already have the contacts and have started some conversations.
Goals
- Technical Skill Development: equip students with the fundamental knowledge and skills to build, deploy, and manage containerized applications using open-source tools like Kubernetes.
- Open-Source Mindset: foster a passion for open-source software, encouraging students to contribute to open-source projects and collaborate with the global developer community.
- Career Readiness: prepare students for industry-relevant roles by exposing them to real-world use cases, best practices, and open-source in companies.
Resources
- Instructors: experienced open-source professionals with deep knowledge of containerization and Kubernetes.
- SUSE Expertise: leverage SUSE's expertise in open-source technologies to provide insights into industry trends and best practices.
Rewrite Distrobox in go (POC) by fabriziosestito
Description
Rewriting Distrobox in Go.
Main benefits:
- Easier to maintain and to test
- Adapter pattern for different container backends (LXC, systemd-nspawn, etc.)
Goals
- Build a minimal starting point with core commands
- Keep the CLI interface compatible: existing users shouldn't notice any difference
- Use a clean Go architecture with adapters for different container backends
- Keep dependencies minimal and binary size small
- Benchmark against the original shell script
Resources
- Upstream project: https://github.com/89luca89/distrobox/
- Distrobox site: https://distrobox.it/
- ArchWiki: https://wiki.archlinux.org/title/Distrobox
Bring to Cockpit + System Roles capabilities from YAST by miguelpc
Bring to Cockpit + System Roles features from YAST
Cockpit and System Roles have been added to SLES 16 There are several capabilities in YAST that are not yet present in Cockpit and System Roles We will follow the principle of "automate first, UI later" being System Roles the automation component and Cockpit the UI one.
Goals
The idea is to implement service configuration in System Roles and then add an UI to manage these in Cockpit. For some capabilities it will be required to have an specific Cockpit Module as they will interact with a reasource already configured.
Resources
A plan on capabilities missing and suggested implementation is available here: https://docs.google.com/spreadsheets/d/1ZhX-Ip9MKJNeKSYV3bSZG4Qc5giuY7XSV0U61Ecu9lo/edit
Linux System Roles: https://linux-system-roles.github.io/
First meeting Hackweek catchup
- Monday, December 1 · 11:00 – 12:00
- Time zone: Europe/Madrid
- Google Meet link: https://meet.google.com/rrc-kqch-hca
Update M2Crypto by mcepl
There are couple of projects I work on, which need my attention and putting them to shape:
Goal for this Hackweek
- Put M2Crypto into better shape (most issues closed, all pull requests processed)
- More fun to learn jujutsu
- Play more with Gemini, how much it help (or not).
- Perhaps, also (just slightly related), help to fix vis to work with LuaJIT, particularly to make vis-lspc working.
Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil
Join the Gitter channel! https://gitter.im/uyuni-project/hackweek
Uyuni is a configuration and infrastructure management tool that saves you time and headaches when you have to manage and update tens, hundreds or even thousands of machines. It also manages configuration, can run audits, build image containers, monitor and much more!
Currently there are a few distributions that are completely untested on Uyuni or SUSE Manager (AFAIK) or just not tested since a long time, and could be interesting knowing how hard would be working with them and, if possible, fix whatever is broken.
For newcomers, the easiest distributions are those based on DEB or RPM packages. Distributions with other package formats are doable, but will require adapting the Python and Java code to be able to sync and analyze such packages (and if salt does not support those packages, it will need changes as well). So if you want a distribution with other packages, make sure you are comfortable handling such changes.
No developer experience? No worries! We had non-developers contributors in the past, and we are ready to help as long as you are willing to learn. If you don't want to code at all, you can also help us preparing the documentation after someone else has the initial code ready, or you could also help with testing :-)
The idea is testing Salt and Salt-ssh clients, but NOT traditional clients, which are deprecated.
To consider that a distribution has basic support, we should cover at least (points 3-6 are to be tested for both salt minions and salt ssh minions):
- Reposync (this will require using spacewalk-common-channels and adding channels to the .ini file)
- Onboarding (salt minion from UI, salt minion from bootstrap scritp, and salt-ssh minion) (this will probably require adding OS to the bootstrap repository creator)
- Package management (install, remove, update...)
- Patching
- Applying any basic salt state (including a formula)
- Salt remote commands
- Bonus point: Java part for product identification, and monitoring enablement
- Bonus point: sumaform enablement (https://github.com/uyuni-project/sumaform)
- Bonus point: Documentation (https://github.com/uyuni-project/uyuni-docs)
- Bonus point: testsuite enablement (https://github.com/uyuni-project/uyuni/tree/master/testsuite)
If something is breaking: we can try to fix it, but the main idea is research how supported it is right now. Beyond that it's up to each project member how much to hack :-)
- If you don't have knowledge about some of the steps: ask the team
- If you still don't know what to do: switch to another distribution and keep testing.
This card is for EVERYONE, not just developers. Seriously! We had people from other teams helping that were not developers, and added support for Debian and new SUSE Linux Enterprise and openSUSE Leap versions :-)
Pending
Debian 13
The new version of the beloved Debian GNU/Linux OS
Seems to be a Debian 12 derivative, so adding it could be quite easy.
[ ]Reposync (this will require using spacewalk-common-channels and adding channels to the .ini file)W]Onboarding (salt minion from UI, salt minion from bootstrap script, and salt-ssh minion) (this will probably require adding OS to the bootstrap repository creator)[ ]Package management (install, remove, update...)[ ]Patching (if patch information is available, could require writing some code to parse it, but IIRC we have support for Ubuntu already). Probably not for Debian as IIRC we don't support patches yet.[ ]Applying any basic salt state (including a formula)[ ]Salt remote commands[ ]Bonus point: Java part for product identification, and monitoring enablement[ ]Bonus point: sumaform enablement (https://github.com/uyuni-project/sumaform)[ ]Bonus point: Documentation (https://github.com/uyuni-project/uyuni-docs)
Improve/rework household chore tracker `chorazon` by gniebler
Description
I wrote a household chore tracker named chorazon, which is meant to be deployed as a web application in the household's local network.
It features the ability to set up different (so far only weekly) schedules per task and per person, where tasks may span several days.
There are "tokens", which can be collected by users. Tasks can (and usually will) have rewards configured where they yield a certain amount of tokens. The idea is that they can later be redeemed for (surprise) gifts, but this is not implemented yet. (So right now one needs to edit the DB manually to subtract tokens when they're redeemed.)
Days are not rolled over automatically, to allow for task completion control.
We used it in my household for several months, with mixed success. There are many limitations in the system that would warrant a revisit.
It's written using the Pyramid Python framework with URL traversal, ZODB as the data store and Web Components for the frontend.
Goals
- Add admin screens for users, tasks and schedules
- Add models, pages etc. to allow redeeming tokens for gifts/surprises
- …?
Resources
tbd (Gitlab repo)
Enhance git-sha-verify: A tool to checkout validated git hashes by gpathak
Description
git-sha-verify is a simple shell utility to verify and checkout trusted git commits signed using GPG key. This tool helps ensure that only authorized or validated commit hashes are checked out from a git repository, supporting better code integrity and security within the workflow.
Supports:
- Verifying commit authenticity signed using gpg key
- Checking out trusted commits
Ideal for teams and projects where the integrity of git history is crucial.
Goals
A minimal python code of the shell script exists as a pull request.
The goal of this hackweek is to:
- Add more unit tests
- Make the python code modular
- Add code coverage if possible
Resources
- Link to GitHub Repository: https://github.com/openSUSE/git-sha-verify