Zarf Config Files
Overview
Users can use a config file to easily control flags for zarf init, zarf package create, and zarf package deploy commands, as well as global flags (excluding --confirm), enabling a more straightforward and declarative workflow.
Zarf supports config files written in common configuration file formats including toml, json, yaml, ini and props, and by default Zarf will look for a file called zarf-config with one of these filenames in the current working directory. To generate a blank config file you can run zarf prepare generate-config with an optional output filename/format. For example, to create an empty config file with the my-cool-env in the yaml format, you can use zarf prepare generate-config my-cool-env.yaml.
To use a custom config filename, set the ZARF_CONFIG environment variable to the config file's path. For example, to use the my-cool-env.yaml config file in the current working directory, you can set the ZARF_CONFIG environment variable to my-cool-env.yaml. The ZARF_CONFIG environment variable can be set either in the shell or in a .env file in the current working directory. Note that the ZARF_CONFIG environment variable takes precedence over the default config file path.
Additionally, you can set any supported config parameter via an environment variable using the ZARF_ prefix. For example, you can set the zarf init --storage-class flag by setting the ZARF_INIT_STORAGE_CLASS environment variable. Note that the ZARF_ environment variable takes precedence over a config file.
While config files set default values, these values can still be overwritten by command line flags. For example, if the config file sets the log level to info and the command line flag is set to debug, the log level will be set to debug. The order of precedence for command line configuration is as follows:
- Command line flags
- Environment variables
- Config file
- Default values
For additional information, see the Config File Example.
Config File Location
Zarf searches for the Zarf Config File from either your current working directory or the ~/.zarf/ directory if you don't specify a config file.
Config File Examples
- yaml
- toml
- ini
- json