Skip to main content

run_pod

Run a Pod from a yaml config file and/or environment variables.

Module​

Functions​

run​

def run(path_to_config_yaml: str | PathLike[str] | None = None) ‑> None:

Runs a pod from a config file and/or environment variables.

When no config file is available, BITFOUNT_USERNAME is required and BITFOUNT_CLUSTER_ID is required only when API keys are not configured. The pod name defaults to the installation UUID unless BITFOUNT_POD_NAME (or BITFOUNT_NAME) is set.

Assumes a Prefect server is already reachable (e.g. a sidecar started alongside this container, with PREFECT_API_URL and related settings already exported into this process's environment) — this function does not manage a Prefect server's lifecycle, only the deployments served against it.

Arguments

  • path_to_config_yaml: Optional path to the config YAML file.