krknctl
Binary distribution (Recommended):
The krknctl binary is available for download from GitHub releases for supported operating systems and architectures. Extract the tarball and add the binary to your $PATH
.
Build from sources :
Linux:
Dictionaries:
To generate the random words we use the american dictionary, it is often available but if that’s not the case:
- Fedora/RHEL:
sudo dnf install words
- Ubuntu/Debian:
sudo apt-get install wamerican
Building from sources:
Linux:
To build the only system package required is libbtrfs:
- Fedora/RHEL:
sudo dnf install btrfs-progs-devel
- Ubuntu/Debian:
sudo apt-get install libbtrfs-dev
MacOS:
- gpgme:
brew install gpgme
Build command:
go build -tags containers_image_openpgp -ldflags="-w -s" -o bin/ ./...
Configure Autocompletion:
The first step to have the best experience with the tool is to install the autocompletion in the shell so that the tool
will be able to suggest to the user the available command and the description simply hitting tab
twice.
Bash (linux):
source <(./krknctl completion bash)
Tip
To install autocompletion permanently add this command to.bashrc
(setting the krknctl binary path correctly)zsh (MacOS):
autoload -Uz compinit
compinit
source <(./krknctl completion zsh)
Tip
To install autocompletion permanently add this command to.zshrc
(setting the krknctl binary path correctly)Container Runtime:
The tool supports both Podman and Docker to run the krkn-hub scenario containers. The tool interacts with the container
runtime through Unix socket. If both container runtimes are installed in the system the tool will default on Podman
.
Podman:
Steps required to enable the Podman support
Linux:
- enable and activate the podman API daemon
sudo systemctl enable --now podman
- activate the user socket
systemctl enable --user --now podman.socket
MacOS:
If both Podman and Docker are installed be sure that the docker compatibility is disabled
Docker:
Linux:
Check that the user has been added to the docker
group and can correctly connect to the Docker unix socket
running the comman podman ps
if an error is returned run the command sudo usermod -aG docker $USER