Global Configuration
What is the global ZenML config
This is an older version of the ZenML documentation. To read and view the latest version please visit this up-to-date URL.
The Global Config
ZenML has two main locations where it stores information on the local machine. These are the Global Config and the Repository (see here for more information on the repository).
Most of the information stored by ZenML on a machine, such as the global settings, the configured Profiles, and even the configured Stacks and Stack Components, is kept in a folder commonly referred to as the ZenML Global Config Directory or the ZenML Config Path. The location of this folder depends on the operating system type and the current system user, but is usually located in the following locations:
Linux:
~/.config/zenml
Mac:
~/Library/Application Support/ZenML
Windows:
C:\Users\%USERNAME%\AppData\Local\ZenML
The default location may be overridden by setting the ZENML_CONFIG_PATH
environment variable to a custom value. The current location of the Global Config Directory used on a system can be retrieved by running the following command:
Manually altering or deleting the files and folders stored under the ZenML Global Config Directory is not recommended, as this can break the internal consistency of the ZenML configuration. As an alternative, ZenML provides CLI commands that can be used to manage the information stored there:
zenml analytics
- manage the analytics settingszenml profile
- manage configuration Profileszenml stack
- manage Stackszenml <stack-component>
- manage Stack Componentszenml clean
- to be used only in case of emergency, to bring the ZenML configuration back to its default factory state
The first time that ZenML is run on a machine, it creates the Global Config Directory and initializes the default configuration in it, along with a default Profile and Stack:
The following is an example of the layout of the Global Config Directory immediately after initialization:
As shown above, the Global Config Directory stores the following information:
The
global.yaml
file stores the global configuration settings: the unique ZenML user ID, the active Profile, the analytics related options and a list of all configured Profiles, along with their configuration attributes, such as the active Stack set for each Profile. This is an example of theglobal.yaml
file contents immediately after initialization:The
local_stores
directory is where some "local" flavors of Stack Components, such as thelocal
Artifact Store, thesqlite
Metadata Store or thelocal
Secrets Manager persist data locally. Every local Stack Component will have its own subdirectory here named after the Stack Component's unique UUID. One notable example is thelocal
Artifact Store flavor that, when part of the active Stack, stores all the artifacts generated by Pipeline runs in the designated local directory.The
profiles
directory is used as a default root path location where ZenML stores information about the Stacks, Stack Components, custom Stack Component flavors etc. that are configured under each Profile. Every Profile will have its own subdirectory here, unless the Profile is explicitly created with a custom configuration path. (See thezenml profile
command and the section on ZenML Profiles for more information about Profiles.)
In addition to the above, you may also find the following files and folders under the Global Config Directory, depending on what you do with ZenML:
zenml_examples
- used as a local cache by thezenml example
command, where the pulled ZenML examples are stored.kubeflow
- this is where the Kubeflow orchestrators that are part of a Stack store some of their configuration and logs.
Accessing the global configuration in Python
You can access the global ZenML configuration from within Python using the zenml.config.global_config.GlobalConfiguration
class:
This can be used to manage your profiles and other global settings from within Python. For instance, we can use it to create and activate a new profile:
To explore all possible operations that can be performed via the GlobalConfiguration
, please consult the API docs sections on GlobalConfiguration.
Last updated