Skip to main content

auto

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

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

Parameters

NameTypeDescription
config_filetyping.Union[str, pathlib.Path, ConfigFile, None] = Nonefile path to read the config from, if not specified default locations are searched

Returns

TypeDescription
ConfigConfig