kraft to your preferences. In this document, we outline where configuration is stored and what the options mean, including possible values and best practices.When you install kraft, it will create a number of directories and files on your host that are used for configuration purposes and to store cache information.
The default location for user configuration for kraft is stored at: ~/.config/kraftkit/config.yaml.
This file can be edited to your liking or to suite your needs.
Below is an overview of each configuration option, how to set its value, their default value and purpose.
| Option | Environmental Variable | Global CLI flag | Default Value |
|---|---|---|---|
no_prompt | KRAFTKIT_NO_PROMPT | --no-prompt | false |
| Do not prompt for user interaction | |||
no_parallel | KRAFTKIT_NO_PARALLEL | --no-parallel | false |
| Do not run internal tasks in parallel | |||
no_check_updates | KRAFTKIT_NO_CHECK_UPDATES | --no-check-updates | false |
| Do not check for updates | |||
pager | KRAFTKIT_PAGER | --pager | |
| System pager to pipe output to | |||
runtime_dir | KRAFTKIT_RUNTIME_DIR | --runtime-dir | /var/kraftkit |
| Directory for placing runtime files (e.g. pidfiles) | |||
containerd_addr | KRAFTKIT_CONTAINERD_ADDR | --containerd-addr | |
| Address of containerd daemon socket | |||
buildkit_host | KRAFTKIT_BUILDKIT_HOST | --buildkit-host | |
| Address of BuildKit daemon socket | |||
paths.config | KRAFTKIT_PATHS_CONFIG | --paths-config | ~/.config/kraftkit |
| Path to KraftKit config directory | |||
paths.manifests | KRAFTKIT_PATHS_MANIFESTS | --paths-manifests | ~/.local/share/kraftkit/manifests |
| Path to Unikraft manifest cache | |||
paths.sources | KRAFTKIT_PATHS_SOURCES | --paths-sources | ~/.local/share/kraftkit/sources |
| Path to Unikraft component cache | |||
log.level | KRAFTKIT_LOG_LEVEL | --log-level | info |
| Log level verbosity | |||
log.timestamps | KRAFTKIT_LOG_TIMESTAMPS | --log-timestamps | false |
| Enable log timestamps | |||
log.type | KRAFTKIT_LOG_TYPE | --log-type | fancy |
Log type (choice of fancy, basic and json) | |||
unikraft.mirrors | KRAFTKIT_UNIKRAFT_MIRRORS | --unikraft-mirrors | |
| Paths to mirrors of Unikraft component artifacts | |||
unikraft.manifests | KRAFTKIT_UNIKRAFT_MANIFESTS | --unikraft-manifests | https://manifests.kraftkit.sh/index.yaml |
| Paths to package or component manifests | |||
To increase compatibility across systems and to respect to pre-defined user environments, kraft recognizes the following additional environmental variables:
| Variable | Affects |
|---|---|
PAGER | How the output is rendered in some commands. Can be set to cat or less. |
NO_COLOR | Do not use any ANSI or true color output in any log messaging. |
CLICOLOR | Same as NO_COLOR. |
XDG_CONFIG_HOME | Path to the general configuration directory. Affects the default value of paths.config. |
XDG_STATE_HOME | Path to the generate state directory. |
XDG_DATA_HOME | Path to the general data directory. Affects the default value of unikraft.manifests and others. |
The following are a few additional recommendations for global configuration values given certain contexts, environments or scenarios:
fancy to either basic or json to allow for better readability.
KraftKit should recognize pseudo TTY environments and dynamically adjust.basic log type and to set the log level to debug to get a better understanding of what's being run underneath by KraftKit.Feel free to ask questions, report issues, and meet new people.