kathara.conf - Kathara configuration file
This file is a JSON that contains information about the Kathara configuration. It also stores the default settings to be used when starting new devices. This file is placed in the ~/.config folder. If it does not exist when Kathara is launched, it will be created with default settings.
Checks on the correctness of the configuration are performed each time a Kathara command is launched. So each value must always be a valid setting.
image (string)Default to kathara/base.
manager_type (string)Default to docker.
terminal (string)/usr/bin/xterm, TMUX or an user-defined path.
On macOS, options are Terminal (default system terminal), iTerm or TMUX.
Default to /usr/bin/xterm on Linux and Terminal on macOS.
open_terminals (boolean)Default to true.
device_shell (string)Default to /bin/bash.
net_prefix (string)Default to kathara.
device_prefix (string)Default to kathara.
debug_level (string)Default to INFO.
print_startup_log (boolean)open_terminals is false.
Default to true.
enable_ipv6 (boolean)Default to false.
last_checked (double)Default to time of the file creation - one week, so the check will always run after a fresh.
Each Manager specifies additional parameters which are used only when the Manager is currently active.
network_plugin (string)kathara/katharanp is the legacy plugin based on Linux bridges. kathara/katharanp_vde plugin is the default plugin, based on VDE software switches.
Possible values are kathara/katharanp, kathara/katharanp_vde.
Default to kathara/katharanp_vde.
hosthome_mount (boolean)/hosthome dir will be mounted inside the device. The home directory of the current user is made available for reading/writing inside the device under the special directory /hosthome.
Default to false.
shared_mount (boolean)/shared dir will be mounted inside the device. The "shared" folder inside the network scenario folder is made available for reading/writing inside the device under the special directory /shared.
Default to true.
image_update_policy (string)Possible values are Prompt, Always, Never.
Default to Prompt.
shared_cds (integer)Default to 1 (enum value for Not Shared).
remote_url (string)Default to null.
cert_path (string)Default to null.
api_server_url (string)Default to null.
api_token (string)Default to null.
host_shared (boolean) directory and this directory will be mounted in read/write mode on each device under the path /shared`.
This will allow to save files from the device to the Kubernetes worker node locally. Note that the content of those folders (one on each worker node) are not shared between them nor between the worker and the Kathara host.
Default to true.
image_pull_policy (string)Possible values are Always, IfNotPresent, Never. Please refer to the official Kubernetes page for further details on how this mode works.
Default to IfNotPresent.
docker_config_json (string)config.json JSON that is used create a Kubernetes Secret of type kubernetes.io/dockerconfigjson.
From the kathara settings menu, the user provides a filesystem path where the file is located. Kathara automatically opens and parses the file and stores the base64-encoded string into this value.
Please refer to the official Kubernetes page for further details on Kubernetes Secrets.
Default to null.
{
"image": "kathara/base",
"manager_type": "docker",
"terminal": "/usr/bin/xterm",
"open_terminals": true,
"device_shell": "/bin/bash",
"net_prefix": "kathara",
"device_prefix": "kathara",
"debug_level": "INFO",
"print_startup_log": true,
"enable_ipv6": true,
"last_checked": 1600087624.6843708,
"hosthome_mount": false,
"shared_mount": true,
"image_update_policy": "Prompt",
"shared_cds": 1,
"remote_url": null,
"cert_path": null,
"network_plugin": "kathara/katharanp_vde"
}
Example of the default kathara.conf(5) file using Docker Manager.
Report bugs opening an issue on the official GitHub repository where the development and maintenance is primarily done.
Issues which are security relevant should be disclosed privately to the Kathara mailing list. You do not have to be subscribed to the list to send a message there.
When reporting a bug, remember to write used commands, eventually attach your network scenario, and include the output of kathara-check(1) in order to make possible to reproduce the bug.
Kathara was born from Netkit. Its first version was developed by Gaetano Bonofiglio and Veronica Iovinella. Currently it is mantained by Mariano Scazzariello, Tommaso Caiazzi and Lorenzo Ariemma.
People involved also include:
Copyright © 2017-2024 License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
kathara(1), kathara-vstart(1), kathara-lstart(1), Kathara official site