# Copyright 2023 The Kubeflow Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Objects for configuring local execution."""
import abc
import dataclasses
import os
import tempfile
from typing import Optional, Union
from kfp import local
class LocalRunnerType(abc.ABC):
"""The ABC for user-facing Runner configurations.
Subclasses should be a dataclass.
They should implement a .validate() method.
"""
@abc.abstractmethod
def validate(self) -> None:
"""Validates that the configuration arguments provided by the user are
valid."""
raise NotImplementedError
[docs]@dataclasses.dataclass
class SubprocessRunner:
"""Runner that indicates that local tasks should be run in a subprocess.
Args:
use_venv: Whether to run the subprocess in a virtual environment. If True, dependencies will be installed in the virtual environment. If False, dependencies will be installed in the current environment. Using a virtual environment is recommended.
"""
use_venv: bool = True
[docs]class DockerRunner:
"""Runner that indicates that local tasks should be run as a Docker
container."""
DOCKER_CONTAINER_RUN_ARGS = {
# for available run parameters:
# https://docker-py.readthedocs.io/en/stable/containers.html
'image',
'command',
'auto_remove',
'blkio_weight_device',
'blkio_weight',
'cap_add',
'cap_drop',
'cgroup_parent',
'cgroupns',
'cpu_count',
'cpu_percent',
'cpu_period',
'cpu_quota',
'cpu_rt_period',
'cpu_rt_runtime',
'cpu_shares',
'cpuset_cpus',
'cpuset_mems',
'detach',
'device_cgroup_rules',
'device_read_bps',
'device_read_iops',
'device_write_bps',
'device_write_iops',
'devices',
'device_requests',
'dns',
'dns_opt',
'dns_search',
'domainname',
'entrypoint',
'environment',
'extra_hosts',
'group_add',
'healthcheck',
'hostname',
'init',
'init_path',
'ipc_mode',
'isolation',
'kernel_memory',
'labels',
'links',
'log_config',
'lxc_conf',
'mac_address',
'mem_limit',
'mem_reservation',
'mem_swappiness',
'memswap_limit',
'mounts',
'name',
'nano_cpus',
'network',
'network_disabled',
'network_mode',
'networking_config',
'oom_kill_disable',
'oom_score_adj',
'pid_mode',
'pids_limit',
'platform',
'ports',
'privileged',
'publish_all_ports',
'read_only',
'remove',
'restart_policy',
'runtime',
'security_opt',
'shm_size',
'stdin_open',
'stdout',
'stderr',
'stop_signal',
'storage_opt',
'stream',
'sysctls',
'tmpfs',
'tty',
'ulimits',
'use_config_proxy',
'user',
'userns_mode',
'uts_mode',
'version',
'volume_driver',
'volumes',
'working_dir',
}
def __init__(self, **container_run_args):
"""Runner constructor, taking any arguments to propagate to
`containers.run` in the `docker` SDK.
Args:
**container_run_args: Keyword arguments that comport with `containers.run` in the `docker` SDK, with some exceptions (see below).
`containers.run` arguments are supported with the following exceptions:
- image
- command
- volumes
Raises:
ImportError: Raised when `docker` is not installed
ValueError: Raised when unsupported `containers.run` arguments are supplied
"""
try:
import docker # noqa
except ImportError as e:
raise ImportError(
f"Package 'docker' must be installed to use {DockerRunner.__name__!r}. Install it using 'pip install docker'."
) from e
unsupported_args = container_run_args.keys(
) - self.DOCKER_CONTAINER_RUN_ARGS
if unsupported_args:
raise ValueError(
f"Unsupported `docker run` arguments, see Package `docker` for details: {', '.join(unsupported_args)}"
)
excess_args: set = set(['image', 'command', 'volumes'
]) & container_run_args.keys()
if excess_args:
raise ValueError(
f"The following docker run arguments should not be specififed: {', '.join(excess_args)}"
)
self.container_run_args = container_run_args
class LocalExecutionConfig:
instance = None
def __new__(
cls,
runner: SubprocessRunner,
pipeline_root: str,
workspace_root: str,
raise_on_error: bool,
) -> 'LocalExecutionConfig':
# singleton pattern
cls.instance = super(LocalExecutionConfig, cls).__new__(cls)
return cls.instance
def __init__(
self,
runner: SubprocessRunner,
pipeline_root: str,
workspace_root: str,
raise_on_error: bool,
) -> None:
permitted_runners = (SubprocessRunner, DockerRunner)
if not isinstance(runner, permitted_runners):
raise ValueError(
f'Got unknown runner {runner} of type {runner.__class__.__name__}. Runner should be one of the following types: {". ".join(prunner.__name__ for prunner in permitted_runners)}.'
)
self.runner = runner
self.pipeline_root = pipeline_root
self.workspace_root = workspace_root
self.raise_on_error = raise_on_error
@classmethod
def validate(cls):
if cls.instance is None:
raise RuntimeError(
f"Local environment not initialized. Please run '{local.__name__}.{init.__name__}()' before executing tasks locally."
)
[docs]def init(
# annotate with subclasses, not parent class, for more helpful ref docs
runner: Union[SubprocessRunner, DockerRunner],
pipeline_root: str = './local_outputs',
workspace_root: Optional[str] = None,
raise_on_error: bool = True,
) -> None:
"""Initializes a local execution session.
Once called, components can be invoked locally outside of a pipeline definition.
Args:
runner: The runner to use. Supported runners: kfp.local.SubprocessRunner and kfp.local.DockerRunner.
pipeline_root: Destination for task outputs.
workspace_root: Directory to use as workspace. If None, a temporary directory will be created.
raise_on_error: If True, raises an exception when a local task execution fails. If False, fails gracefully and does not terminate the current program.
"""
# updates a global config
pipeline_root = os.path.abspath(pipeline_root)
if workspace_root is None:
workspace_root = tempfile.mkdtemp(prefix='kfp-workspace-')
LocalExecutionConfig(
runner=runner,
pipeline_root=pipeline_root,
workspace_root=workspace_root,
raise_on_error=raise_on_error,
)