Squonk2 Deck

Squeck (Squonk2 Deck) is s Textual-UI (TUI) for the summary visualisation of multiple Squonk2 environments.

Squeck uses the squonk2-python-client to create a Deck displaying summary information for multiple Squonk2 environments and uses Will McGugan's textual framework to provide the user with a simple, text-based user interface modelled on the popular k9s Kubernetes monitor.

It displays a summary of the environments, where: -

• A green tick indicates that the authenticator service has issued a token for the service
• The service version is displayed for those that are running
• A NO RESPONSE banner is displayed for services that are not responding

Installation

Squeck is a Python application, written with Python 3.10 and published to PyPI and is easily installed using pip:

pip install im-squeck

Execution

Before running Squeck you must have access to at least one Squonk2 environment. Squeck obtains details of the environment through a YAML-based environments file. An example file, environments, is located in the root of this project:

When Squeck starts it will look for the environments file in your home directory, in the file ~/.squonk2/environments. If you place your populated environments file there you need do nothing else prior to running Squeck. If you prefer to put your environments file elsewhere, or have multiple files, set the path to your file using the environment variable SQUONK2_ENVIRONMENTS_FILE:

export SQUONK2_ENVIRONMENTS_FILE=~/my-squonk2-environments

With an environments file in place you can run Squeck:

squeck

Logging

You can enable logging from Squeck and the underlying textual framework by setting the environment variable SQUONK2_LOGFILE when running the application:

SQUONK2_LOGFILE=./squeck.log squeck

Debugging

Textual doesn't like anything being written to the console so printing (even to stderr) will topple the display. That's why stderr is diverted when the application is running and nothing is printed. There comes a time, though, when you need to see the error log. For these times you can run Squeck without stderr diverted:

squeck --enable-stderr