flyte 0.2.0b1__py3-none-any.whl → 2.0.0b46__py3-none-any.whl

flyte/config/__init__.py

@@ -1,168 +1,3 @@
-import os
-import typing
-from dataclasses import dataclass, field
-from typing import TYPE_CHECKING
+from flyte.config._config import Config, auto, get_config_file, set_if_exists
 
-from flyte._logging import logger
-from flyte.config import _internal
-from flyte.config._config import ConfigFile, get_config_file, read_file_if_exists
-
-_all__ = ["ConfigFile", "PlatformConfig", "TaskConfig"]
-
-if TYPE_CHECKING:
-    from flyte.remote._client.auth import AuthType
-
-
-@dataclass(init=True, repr=True, eq=True, frozen=True)
-class PlatformConfig(object):
-    """
-    This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically).
-
-    :param endpoint: DNS for Flyte backend
-    :param insecure: Whether or not to use SSL
-    :param insecure_skip_verify: Whether to skip SSL certificate verification
-    :param console_endpoint: endpoint for console if different from Flyte backend
-    :param command: This command is executed to return a token using an external process
-    :param proxy_command: This command is executed to return a token for proxy authorization using an external process
-    :param client_id: This is the public identifier for the app which handles authorization for a Flyte deployment.
-      More details here: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/.
-    :param client_credentials_secret: Used for service auth, which is automatically called during pyflyte. This will
-      allow the Flyte engine to read the password directly from the environment variable. Note that this is
-      less secure! Please only use this if mounting the secret as a file is impossible
-    :param scopes: List of scopes to request. This is only applicable to the client credentials flow
-    :param auth_mode: The OAuth mode to use. Defaults to pkce flow
-    :param ca_cert_file_path: [optional] str Root Cert to be loaded and used to verify admin
-    :param http_proxy_url: [optional] HTTP Proxy to be used for OAuth requests
-    """
-
-    endpoint: str | None = None
-    insecure: bool = False
-    insecure_skip_verify: bool = False
-    ca_cert_file_path: typing.Optional[str] = None
-    console_endpoint: typing.Optional[str] = None
-    command: typing.Optional[typing.List[str]] = None
-    proxy_command: typing.Optional[typing.List[str]] = None
-    client_id: typing.Optional[str] = None
-    client_credentials_secret: typing.Optional[str] = None
-    scopes: typing.List[str] = field(default_factory=list)
-    auth_mode: "AuthType" = "Pkce"
-    audience: typing.Optional[str] = None
-    rpc_retries: int = 3
-    http_proxy_url: typing.Optional[str] = None
-
-    @classmethod
-    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "PlatformConfig":
-        """
-        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
-        :param config_file:
-        :return:
-        """
-        from .._initialize import set_if_exists
-
-        config_file = get_config_file(config_file)
-        kwargs: typing.Dict[str, typing.Any] = {}
-        kwargs = set_if_exists(kwargs, "insecure", _internal.Platform.INSECURE.read(config_file))
-        kwargs = set_if_exists(
-            kwargs, "insecure_skip_verify", _internal.Platform.INSECURE_SKIP_VERIFY.read(config_file)
-        )
-        kwargs = set_if_exists(kwargs, "ca_cert_file_path", _internal.Platform.CA_CERT_FILE_PATH.read(config_file))
-        kwargs = set_if_exists(kwargs, "command", _internal.Credentials.COMMAND.read(config_file))
-        kwargs = set_if_exists(kwargs, "proxy_command", _internal.Credentials.PROXY_COMMAND.read(config_file))
-        kwargs = set_if_exists(kwargs, "client_id", _internal.Credentials.CLIENT_ID.read(config_file))
-
-        is_client_secret = False
-        client_credentials_secret = read_file_if_exists(
-            _internal.Credentials.CLIENT_CREDENTIALS_SECRET_LOCATION.read(config_file)
-        )
-        if client_credentials_secret:
-            is_client_secret = True
-            if client_credentials_secret.endswith("\n"):
-                logger.info("Newline stripped from client secret")
-                client_credentials_secret = client_credentials_secret.strip()
-        kwargs = set_if_exists(
-            kwargs,
-            "client_credentials_secret",
-            client_credentials_secret,
-        )
-
-        client_credentials_secret_env_var = _internal.Credentials.CLIENT_CREDENTIALS_SECRET_ENV_VAR.read(config_file)
-        if client_credentials_secret_env_var:
-            client_credentials_secret = os.getenv(client_credentials_secret_env_var)
-            if client_credentials_secret:
-                is_client_secret = True
-        kwargs = set_if_exists(kwargs, "client_credentials_secret", client_credentials_secret)
-        kwargs = set_if_exists(kwargs, "scopes", _internal.Credentials.SCOPES.read(config_file))
-        kwargs = set_if_exists(kwargs, "auth_mode", _internal.Credentials.AUTH_MODE.read(config_file))
-        if is_client_secret:
-            kwargs = set_if_exists(kwargs, "auth_mode", "ClientSecret")
-        kwargs = set_if_exists(kwargs, "endpoint", _internal.Platform.URL.read(config_file))
-        kwargs = set_if_exists(kwargs, "console_endpoint", _internal.Platform.CONSOLE_ENDPOINT.read(config_file))
-
-        kwargs = set_if_exists(kwargs, "http_proxy_url", _internal.Platform.HTTP_PROXY_URL.read(config_file))
-        return PlatformConfig(**kwargs)
-
-    @classmethod
-    def for_endpoint(cls, endpoint: str, insecure: bool = False) -> "PlatformConfig":
-        return PlatformConfig(endpoint=endpoint, insecure=insecure)
-
-
-@dataclass(init=True, repr=True, eq=True, frozen=True)
-class TaskConfig(object):
-    org: str | None = None
-    project: str | None = None
-    domain: str | None = None
-
-    @classmethod
-    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "TaskConfig":
-        """
-        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
-        :param config_file:
-        :return:
-        """
-        from flyte._initialize import set_if_exists
-
-        config_file = get_config_file(config_file)
-        kwargs: typing.Dict[str, typing.Any] = {}
-        kwargs = set_if_exists(kwargs, "org", _internal.Task.ORG.read(config_file))
-        kwargs = set_if_exists(kwargs, "project", _internal.Task.PROJECT.read(config_file))
-        kwargs = set_if_exists(kwargs, "domain", _internal.Task.DOMAIN.read(config_file))
-        return TaskConfig(**kwargs)
-
-
-@dataclass(init=True, repr=True, eq=True, frozen=True)
-class Config(object):
-    """
-    This the parent configuration object and holds all the underlying configuration object types. An instance of
-    this object holds all the config necessary to
-
-    1. Interactive session with Flyte backend
-    2. Some parts are required for Serialization, for example Platform Config is not required
-    3. Runtime of a task
-    """
-
-    platform: PlatformConfig = field(default=PlatformConfig())
-    task: TaskConfig = field(default=TaskConfig())
-
-    def with_params(
-        self,
-        platform: PlatformConfig | None = None,
-        task: TaskConfig | None = None,
-    ) -> "Config":
-        return Config(
-            platform=platform or self.platform,
-            task=task or self.task,
-        )
-
-    @classmethod
-    def auto(cls, config_file: typing.Union[str, ConfigFile, None] = None) -> "Config":
-        """
-        Automatically constructs the Config Object. The order of precedence is as follows
-          1. first try to find any env vars that match the config vars specified in the FLYTE_CONFIG format.
-          2. If not found in environment then values ar read from the config file
-          3. If not found in the file, then the default values are used.
-
-        :param config_file: file path to read the config from, if not specified default locations are searched
-        :return: Config
-        """
-        config_file = get_config_file(config_file)
-        return Config(platform=PlatformConfig.auto(config_file), task=TaskConfig.auto(config_file))
+__all__ = ["Config", "auto", "get_config_file", "set_if_exists"]

flyte/config/_config.py

@@ -1,196 +1,248 @@
+from __future__ import annotations
+
+import dataclasses
 import os
 import pathlib
 import typing
-from dataclasses import dataclass
-from functools import lru_cache
-from os import getenv
-from pathlib import Path
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
 
-import yaml
+import rich.repr
 
 from flyte._logging import logger
+from flyte.config import _internal
+from flyte.config._reader import ConfigFile, get_config_file, read_file_if_exists
+
+_all__ = ["ConfigFile", "PlatformConfig", "TaskConfig", "ImageConfig"]
 
-# This is the default config file name for flyte
-FLYTECTL_CONFIG_ENV_VAR = "FLYTECTL_CONFIG"
-UCTL_CONFIG_ENV_VAR = "UCTL_CONFIG"
+if TYPE_CHECKING:
+    from flyte.remote._client.auth import AuthType
 
 
-@dataclass
-class YamlConfigEntry(object):
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class PlatformConfig(object):
     """
-    Creates a record for the config entry.
-    Args:
-        switch: dot-delimited string that should match flytectl args. Leaving it as dot-delimited instead of a list
-          of strings because it's easier to maintain alignment with flytectl.
-        config_value_type: Expected type of the value
+    This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically).
+
+    :param endpoint: DNS for Flyte backend
+    :param insecure: Whether or not to use SSL
+    :param insecure_skip_verify: Whether to skip SSL certificate verification
+    :param console_endpoint: endpoint for console if different from Flyte backend
+    :param command: This command is executed to return a token using an external process
+    :param proxy_command: This command is executed to return a token for proxy authorization using an external process
+    :param client_id: This is the public identifier for the app which handles authorization for a Flyte deployment.
+      More details here: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/.
+    :param client_credentials_secret: Used for service auth, which is automatically called during pyflyte. This will
+      allow the Flyte engine to read the password directly from the environment variable. Note that this is
+      less secure! Please only use this if mounting the secret as a file is impossible
+    :param scopes: List of scopes to request. This is only applicable to the client credentials flow
+    :param auth_mode: The OAuth mode to use. Defaults to pkce flow
+    :param ca_cert_file_path: [optional] str Root Cert to be loaded and used to verify admin
+    :param http_proxy_url: [optional] HTTP Proxy to be used for OAuth requests
     """
 
-    switch: str
-    config_value_type: typing.Type = str
+    endpoint: str | None = None
+    insecure: bool = False
+    insecure_skip_verify: bool = False
+    ca_cert_file_path: typing.Optional[str] = None
+    console_endpoint: typing.Optional[str] = None
+    command: typing.Optional[typing.List[str]] = None
+    proxy_command: typing.Optional[typing.List[str]] = None
+    client_id: typing.Optional[str] = None
+    client_credentials_secret: typing.Optional[str] = None
+    scopes: typing.List[str] = field(default_factory=list)
+    auth_mode: "AuthType" = "Pkce"
+    audience: typing.Optional[str] = None
+    rpc_retries: int = 3
+    http_proxy_url: typing.Optional[str] = None
+
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "PlatformConfig":
+        """
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
+        :return:
+        """
+
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "insecure", _internal.Platform.INSECURE.read(config_file))
+        kwargs = set_if_exists(
+            kwargs, "insecure_skip_verify", _internal.Platform.INSECURE_SKIP_VERIFY.read(config_file)
+        )
+        kwargs = set_if_exists(kwargs, "ca_cert_file_path", _internal.Platform.CA_CERT_FILE_PATH.read(config_file))
+        kwargs = set_if_exists(kwargs, "command", _internal.Credentials.COMMAND.read(config_file))
+        kwargs = set_if_exists(kwargs, "proxy_command", _internal.Credentials.PROXY_COMMAND.read(config_file))
+        kwargs = set_if_exists(kwargs, "client_id", _internal.Credentials.CLIENT_ID.read(config_file))
+
+        is_client_secret = False
+        client_credentials_secret = read_file_if_exists(
+            _internal.Credentials.CLIENT_CREDENTIALS_SECRET_LOCATION.read(config_file)
+        )
+        if client_credentials_secret:
+            is_client_secret = True
+            if client_credentials_secret.endswith("\n"):
+                logger.info("Newline stripped from client secret")
+                client_credentials_secret = client_credentials_secret.strip()
+        kwargs = set_if_exists(
+            kwargs,
+            "client_credentials_secret",
+            client_credentials_secret,
+        )
+
+        client_credentials_secret_env_var = _internal.Credentials.CLIENT_CREDENTIALS_SECRET_ENV_VAR.read(config_file)
+        if client_credentials_secret_env_var:
+            client_credentials_secret = os.getenv(client_credentials_secret_env_var)
+            if client_credentials_secret:
+                is_client_secret = True
+        kwargs = set_if_exists(kwargs, "client_credentials_secret", client_credentials_secret)
+        kwargs = set_if_exists(kwargs, "scopes", _internal.Credentials.SCOPES.read(config_file))
+        kwargs = set_if_exists(kwargs, "auth_mode", _internal.Credentials.AUTH_MODE.read(config_file))
+        if is_client_secret:
+            kwargs = set_if_exists(kwargs, "auth_mode", "ClientSecret")
+        kwargs = set_if_exists(kwargs, "endpoint", _internal.Platform.URL.read(config_file))
+        kwargs = set_if_exists(kwargs, "console_endpoint", _internal.Platform.CONSOLE_ENDPOINT.read(config_file))
+
+        kwargs = set_if_exists(kwargs, "http_proxy_url", _internal.Platform.HTTP_PROXY_URL.read(config_file))
+        return PlatformConfig(**kwargs)
+
+    def replace(self, **kwargs: typing.Any) -> "PlatformConfig":
+        """
+        Returns a new PlatformConfig instance with the values from the kwargs overriding the current instance.
+        """
+        return dataclasses.replace(self, **kwargs)
+
+    @classmethod
+    def for_endpoint(cls, endpoint: str, insecure: bool = False) -> "PlatformConfig":
+        return PlatformConfig(endpoint=endpoint, insecure=insecure)
 
-    def get_env_name(self) -> str:
-        var_name = self.switch.upper().replace(".", "_")
-        return f"FLYTE_{var_name}"
 
-    def read_from_env(self, transform: typing.Optional[typing.Callable] = None) -> typing.Optional[typing.Any]:
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class TaskConfig(object):
+    org: str | None = None
+    project: str | None = None
+    domain: str | None = None
+
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "TaskConfig":
         """
-        Reads the config entry from environment variable, the structure of the env var is current
-        ``FLYTE_{SECTION}_{OPTION}`` all upper cased. We will change this in the future.
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
         :return:
         """
-        env = self.get_env_name()
-        v = os.environ.get(env, None)
-        if v is None:
-            return None
-        return transform(v) if transform else v
-
-    def read_from_file(
-        self, cfg: "ConfigFile", transform: typing.Optional[typing.Callable] = None
-    ) -> typing.Optional[typing.Any]:
-        if not cfg:
-            return None
-        try:
-            v = cfg.get(self)
-            if isinstance(v, bool) or bool(v is not None and v):
-                return transform(v) if transform else v
-        except Exception:
-            ...
-
-        return None
-
-
-@dataclass
-class ConfigEntry(object):
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "org", _internal.Task.ORG.read(config_file))
+        kwargs = set_if_exists(kwargs, "project", _internal.Task.PROJECT.read(config_file))
+        kwargs = set_if_exists(kwargs, "domain", _internal.Task.DOMAIN.read(config_file))
+        return TaskConfig(**kwargs)
+
+
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class ImageConfig(object):
     """
-    A top level Config entry holder, that holds multiple different representations of the config.
-    Legacy means the INI style config files. YAML support is for the flytectl config file, which is there by default
-    when flytectl starts a sandbox
+    Configuration for Docker image settings.
     """
 
-    yaml_entry: YamlConfigEntry
-    transform: typing.Optional[typing.Callable[[str], typing.Any]] = None
+    builder: str | None = None
+    image_refs: typing.Dict[str, str] = field(default_factory=dict)
 
-    def read(self, cfg: typing.Optional["ConfigFile"] = None) -> typing.Optional[typing.Any]:
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "ImageConfig":
         """
-        Reads the config Entry from the various sources in the following order,
-        #. First try to read from the relevant environment variable,
-        #. If missing, then try to read from the legacy config file, if one was parsed.
-        #. If missing, then try to read from the yaml file.
-
-        The constructor for ConfigFile currently does not allow specification of both the ini and yaml style formats.
-
-        :param cfg:
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
         :return:
         """
-        from_env = self.yaml_entry.read_from_env(self.transform)
-        if from_env is not None:
-            return from_env
-        if cfg and cfg.yaml_config and self.yaml_entry:
-            return self.yaml_entry.read_from_file(cfg, self.transform)
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "builder", _internal.Image.BUILDER.read(config_file))
+        kwargs = set_if_exists(kwargs, "image_refs", _internal.Image.IMAGE_REFS.read(config_file))
+        return ImageConfig(**kwargs)
+
 
-        return None
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class Config(object):
+    """
+    This the parent configuration object and holds all the underlying configuration object types. An instance of
+    this object holds all the config necessary to
 
+    1. Interactive session with Flyte backend
+    2. Some parts are required for Serialization, for example Platform Config is not required
+    3. Runtime of a task
+    """
 
-class ConfigFile(object):
-    def __init__(self, location: str):
+    platform: PlatformConfig = field(default=PlatformConfig())
+    task: TaskConfig = field(default=TaskConfig())
+    image: ImageConfig = field(default=ImageConfig())
+    source: pathlib.Path | None = None
+
+    def with_params(
+        self,
+        platform: PlatformConfig | None = None,
+        task: TaskConfig | None = None,
+        image: ImageConfig | None = None,
+    ) -> "Config":
+        return Config(
+            platform=platform or self.platform,
+            task=task or self.task,
+            image=image or self.image,
+        )
+
+    @classmethod
+    def auto(cls, config_file: typing.Union[str, pathlib.Path, ConfigFile, None] = None) -> "Config":
         """
-        Load the config from this location
+        Automatically constructs the Config Object. The order of precedence is as follows
+          1. first try to find any env vars that match the config vars specified in the FLYTE_CONFIG format.
+          2. If not found in environment then values ar read from the config file
+          3. If not found in the file, then the default values are used.
+
+        :param config_file: file path to read the config from, if not specified default locations are searched
+        :return: Config
         """
-        self._location = location
-        self._yaml_config = self._read_yaml_config(location)
-
-    @staticmethod
-    def _read_yaml_config(location: str) -> typing.Optional[typing.Dict[str, typing.Any]]:
-        with open(location, "r") as fh:
-            try:
-                yaml_contents = yaml.safe_load(fh)
-                return yaml_contents
-            except yaml.YAMLError as exc:
-                logger.warning(f"Error {exc} reading yaml config file at {location}, ignoring...")
-                return None
-
-    def _get_from_yaml(self, c: YamlConfigEntry) -> typing.Any:
-        keys = c.switch.split(".")  # flytectl switches are dot delimited
-        d = typing.cast(typing.Dict[str, typing.Any], self.yaml_config)
-        try:
-            for k in keys:
-                d = d[k]
-            return d
-        except KeyError:
-            return None
-
-    def get(self, c: YamlConfigEntry) -> typing.Any:
-        return self._get_from_yaml(c)
-
-    @property
-    def yaml_config(self) -> typing.Dict[str, typing.Any] | None:
-        return self._yaml_config
-
-
-def resolve_config_path() -> pathlib.Path | None:
+        config_file = get_config_file(config_file)
+        if config_file is None:
+            logger.debug("No config file found, using default values")
+            return Config()
+        return Config(
+            platform=PlatformConfig.auto(config_file),
+            task=TaskConfig.auto(config_file),
+            image=ImageConfig.auto(config_file),
+            source=config_file.path,
+        )
+
+
+def set_if_exists(d: dict, k: str, val: typing.Any) -> dict:
     """
-    Config is read from the following locations in order of precedence:
-    1. `UCTL_CONFIG` environment variable
-    2. `FLYTECTL_CONFIG` environment variable
-    3. ~/.union/config.yaml if it exists
-    4. ~/.flyte/config.yaml if it exists
-    5. ./config.yaml if it exists
+    Given a dict ``d`` sets the key ``k`` with value of config ``v``, if the config value ``v`` is set
+    and return the updated dictionary.
     """
-    uctl_path_from_env = getenv(UCTL_CONFIG_ENV_VAR, None)
-    if uctl_path_from_env:
-        return pathlib.Path(uctl_path_from_env)
-    logger.debug("No UCTL_CONFIG environment variable found, checking FLYTECTL_CONFIG")
-
-    flytectl_path_from_env = getenv(FLYTECTL_CONFIG_ENV_VAR, None)
-    if flytectl_path_from_env:
-        return pathlib.Path(flytectl_path_from_env)
-    logger.debug("No FLYTECTL_CONFIG environment variable found, checking default locations")
-
-    home_dir_union_config = Path(Path.home(), ".union", "config.yaml")
-    if home_dir_union_config.exists():
-        return home_dir_union_config
-    logger.debug("No ~/.union/config.yaml found, checking current directory")
-
-    home_dir_flytectl_config = Path(Path.home(), ".flyte", "config.yaml")
-    if home_dir_flytectl_config.exists():
-        return home_dir_flytectl_config
-    logger.debug("No ~/.flyte/config.yaml found, checking current directory")
-
-    current_location_config = Path("config.yaml")
-    if current_location_config.exists():
-        return current_location_config
-    logger.debug("No ./config.yaml found, returning None")
-    return None
-
-
-@lru_cache
-def get_config_file(c: typing.Union[str, ConfigFile, None]) -> ConfigFile | None:
-    """
-    Checks if the given argument is a file or a configFile and returns a loaded configFile else returns None
-    """
-    if "PYTEST_VERSION" in os.environ:
-        # Use default local config in the pytest environment
-        return None
-    if isinstance(c, str):
-        logger.debug(f"Using specified config file at {c}")
-        return ConfigFile(c)
-    config_path = resolve_config_path()
-    if config_path:
-        return ConfigFile(str(config_path))
-    return None
-
-
-def read_file_if_exists(filename: typing.Optional[str], encoding=None) -> typing.Optional[str]:
-    """
-    Reads the contents of the file if passed a path. Otherwise, returns None.
+    exists = isinstance(val, bool) or bool(val is not None and val)
+    if exists:
+        d[k] = val
+    return d
 
-    :param filename: The file path to load
-    :param encoding: The encoding to use when reading the file.
-    :return: The contents of the file as a string or None.
-    """
-    if not filename:
-        return None
 
-    file = pathlib.Path(filename)
-    logger.debug(f"Reading file contents from [{file}] with current directory [{os.getcwd()}].")
-    return file.read_text(encoding=encoding)
+def auto(config_file: typing.Union[str, pathlib.Path, ConfigFile, None] = None) -> Config:
+    """
+    Automatically constructs the Config Object. The order of precedence is as follows
+      1. If specified, read the config from the provided file path.
+      2. If not specified, the config file is searched in the default locations.
+            a. ./config.yaml if it exists  (current working directory)
+            b. ./.flyte/config.yaml if it exists (current working directory)
+            c. <git_root>/.flyte/config.yaml if it exists
+            d. `UCTL_CONFIG` environment variable
+            e. `FLYTECTL_CONFIG` environment variable
+            f. ~/.union/config.yaml if it exists
+            g. ~/.flyte/config.yaml if it exists
+    3. If any value is not found in the config file, the default value is used.
+    4. For any value there are environment variables that match the config variable names, those will override
+
+    :param config_file: file path to read the config from, if not specified default locations are searched
+    :return: Config
+    """
+    return Config.auto(config_file)

flyte/config/_internal.py

@@ -1,4 +1,4 @@
-from flyte.config._config import ConfigEntry, YamlConfigEntry
+from flyte.config._reader import ConfigEntry, YamlConfigEntry
 
 
 class Platform(object):
@@ -62,3 +62,12 @@ class Task(object):
     ORG = ConfigEntry(YamlConfigEntry("task.org"))
     PROJECT = ConfigEntry(YamlConfigEntry("task.project"))
     DOMAIN = ConfigEntry(YamlConfigEntry("task.domain"))
+
+
+class Image(object):
+    """
+    Defines the configuration for the image builder.
+    """
+
+    BUILDER = ConfigEntry(YamlConfigEntry("image.builder"))
+    IMAGE_REFS = ConfigEntry(YamlConfigEntry("image.image_refs"))