Skip to main content

with_servecontext

Create a serve context with custom configuration.

This function allows you to customize how an app is served, including overriding environment variables, cluster pool, logging, and other deployment settings.

def with_servecontext(
mode: ServeMode | None = None,
*,
version: Optional[str] = None,
copy_style: CopyFiles = "loaded_modules",
dry_run: bool = False,
project: str | None = None,
domain: str | None = None,
env_vars: dict[str, str] | None = None,
parameter_values: dict[str, dict[str, str | flyte.io.File | flyte.io.Dir]] | None = None,
cluster_pool: str | None = None,
log_level: int | None = None,
log_format: LogFormat = "console",
interactive_mode: bool | None = None,
copy_bundle_to: pathlib.Path | None = None,
# Local-serving parameters
deactivate_timeout: float | None = None,
activate_timeout: float | None = None,
health_check_timeout: float | None = None,
health_check_interval: float | None = None,
health_check_path: str | None = None,
raw_data_path: str | None = None,
) -> _Serve: ...

Create a serve context with custom configuration. This function allows you to customize how an app is served, including overriding environment variables, cluster pool, logging, and other deployment settings.

Parameters​

NameTypeDescription
mode`ServeModeNone` = null
versionOptional[str] = nullOptional version override for the app deployment
copy_styleCopyFiles = "loaded_modules"Code bundle copy style. Options: "loaded_modules", "all", "none"
dry_runbool = falseIf True, don't actually deploy
project`strNone` = null
domain`strNone` = null
env_vars`dict[str, str]None` = null
parameter_values`dict[str, dict[str, strflyte.io.File
cluster_pool`strNone` = null
log_level`intNone` = null
log_formatLogFormat = "console"Optional log format ("console" or "json")
interactive_mode`boolNone` = null
copy_bundle_to`pathlib.PathNone` = null
deactivate_timeout`floatNone` = null
activate_timeout`floatNone` = null
health_check_timeout`floatNone` = null
health_check_interval`floatNone` = null
health_check_path`strNone` = null
raw_data_path`strNone` = null

Returns​

TypeDescription
_ServeServe context manager with configured settings