Configuration
Configuring global settings
The global settings for odo can be found in preference.yaml file; which is located by default in the .odo directory of the user's HOME directory.
Example:
- Linux
- Windows
- Mac
/home/userName/.odo/preference.yaml
C:\\Users\userName\.odo\preference.yaml
/Users/userName/.odo/preference.yaml
A different location can be set for the preference.yaml by exporting GLOBALODOCONFIG in the user environment.
View the configuration
To view the current configuration, run the following command:
odo preference view
Example
$ odo preference view
Preference parameters:
PARAMETER VALUE
ConsentTelemetry true
Ephemeral true
ImageRegistry quay.io/user
PushTimeout
RegistryCacheTime
Timeout
UpdateNotification
Devfile registries:
NAME URL SECURE
StagingRegistry https://registry.stage.devfile.io No
Set a configuration
To set a value for a preference key, run the following command:
odo preference set <key> <value>
Example
$ odo preference set updatenotification false
Global preference was successfully updated
Note that the preference key is case-insensitive.
Unset a configuration
To unset a value of a preference key, run the following command:
odo preference unset <key> [--force]
Example
$ odo preference unset updatednotification
? Do you want to unset updatenotification in the preference (y/N) y
Global preference was successfully updated
You can use the --force (or -f) flag to force the unset.
Unsetting a preference key sets it to an empty value in the preference file. odo will use the default value for such configuration.
Preference Key Table
| Preference | Description | Default |
|---|---|---|
| UpdateNotification | Control whether a notification to update odo is shown | True |
| Timeout | Timeout for Kubernetes server connection check | 1 second |
| PushTimeout | Timeout for waiting for a component to start | 240 seconds |
| RegistryCacheTime | Duration for which odo will cache information from the Devfile registry | 4 Minutes |
| Ephemeral | Control whether odo should create a emptyDir volume to store source code | False |
| ConsentTelemetry | Control whether odo can collect telemetry for the user's odo usage | False |
| ImageRegistry | The container image registry where relative image names will be automatically pushed to. See How odo handles image names for more details. |
Managing Devfile registries
odo uses the portable devfile format to describe the components. odo can connect to various devfile registries to download devfiles for different languages and frameworks.
You can connect to publicly available devfile registries, or you can install your own Devfile Registry.
You can use the odo preference <add/remove> registry command to manage the registries used by odo to retrieve devfile information.
Adding a registry
To add a registry, run the following command:
odo preference add registry <name> <url>
Example
$ odo preference add registry StageRegistry https://registry.stage.devfile.io
New registry successfully added
Deleting a registry
To delete a registry, run the following command:
odo preference remove registry <name> [--force]
Example
$ odo preference remove registry StageRegistry
? Are you sure you want to delete registry "StageRegistry" Yes
Successfully deleted registry
You can use the --force (or -f) flag to force the deletion of the registry without confirmation.
To update a registry, you can delete it and add it again with the updated value.
Advanced configuration
This is a configuration that normal odo users don't need to touch.
Options here are mostly used for debugging and testing odo behavior.
Environment variables controlling odo behavior
| Variable | Usage | Since | Example |
|---|---|---|---|
PODMAN_CMD | The command executed to run the local podman binary. podman by default | v2.4.2 | podman |
DOCKER_CMD | The command executed to run the local docker binary. docker by default | v2.4.2 | docker |
PODMAN_CMD_INIT_TIMEOUT | Timeout for initializing the Podman client. 1s by default | v3.11.0 | 5s |
ODO_LOG_LEVEL | Useful for setting a log level to be used by odo commands. Takes precedence over the -v flag. | v1.0.2 | 3 |
ODO_DISABLE_TELEMETRY | Useful for disabling telemetry collection. Deprecated in v3.2.0. Use ODO_TRACKING_CONSENT instead. | v2.1.0 | true |
GLOBALODOCONFIG | Useful for setting a different location of global preference file preference.yaml. | v0.0.19 | ~/.config/odo/preference.yaml |
ODO_DEBUG_TELEMETRY_FILE | Useful for debugging telemetry. When set it will save telemetry data to a file instead of sending it to the server. | v3.0.0-alpha1 | /tmp/telemetry_data.json |
TELEMETRY_CALLER | Caller identifier passed to telemetry. Case-insensitive. Acceptable values: vscode, intellij, jboss. | v3.1.0 | intellij |
ODO_TRACKING_CONSENT | Useful for controlling telemetry. Acceptable values: yes (enables telemetry and skips consent prompt), no (disables telemetry and consent prompt). Takes precedence over the ConsentTelemetry preference. | v3.2.0 | yes |
ODO_PUSH_IMAGES | Whether to push the images once built; this is used only when applying Devfile image components as part of a Dev Session running on Podman; this is useful for integration tests running on Podman. true by default | v3.7.0 | false |
ODO_IMAGE_BUILD_ARGS | Semicolon-separated list of options to pass to Podman or Docker when building images. These are extra options specific to the podman build or docker build commands. | v3.11.0 | --platform=linux/amd64;--no-cache |
ODO_CONTAINER_RUN_ARGS | Semicolon-separated list of options to pass to Podman when running odo against Podman. These are extra options specific to the podman play kube command. | v3.11.0 | --configmap=/path/to/cm-foo.yml;--quiet |
ODO_CONTAINER_BACKEND_GLOBAL_ARGS | Semicolon-separated list of global options to pass to Podman when running odo on Podman. These will be passed as global options to all Podman commands executed by odo. | v3.11.0 | --root=/tmp/podman/root;--log-level=info |
(1) Accepted boolean values are: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False.