# Copyright 2018-2019 Google LLC
#
# 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.
from . import _container_op
from . import _resource_op
from . import _ops_group
from ._component_bridge import _create_container_op_from_component_and_arguments
from ..components import _components
from ..components._naming import _make_name_unique_by_adding_index
import sys
# This handler is called whenever the @pipeline decorator is applied.
# It can be used by command-line DSL compiler to inject code that runs for every pipeline definition.
_pipeline_decorator_handler = None
[docs]def pipeline(name : str = None, description : str = None):
"""Decorator of pipeline functions.
Example
::
@pipeline(
name='my awesome pipeline',
description='Is it really awesome?'
)
def my_pipeline(a: PipelineParam, b: PipelineParam):
...
"""
def _pipeline(func):
if name:
func._component_human_name = name
if description:
func._component_description = description
if _pipeline_decorator_handler:
return _pipeline_decorator_handler(func) or func
else:
return func
return _pipeline
[docs]class PipelineConf():
"""PipelineConf contains pipeline level settings
"""
def __init__(self):
self.image_pull_secrets = []
self.timeout = 0
self.ttl_seconds_after_finished = -1
self.op_transformers = []
self.default_pod_node_selector = {}
self.image_pull_policy = None
self.parallelism = None
self._data_passing_method = None
[docs] def set_image_pull_secrets(self, image_pull_secrets):
"""Configures the pipeline level imagepullsecret
Args:
image_pull_secrets: a list of Kubernetes V1LocalObjectReference
For detailed description, check Kubernetes V1LocalObjectReference definition
https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1LocalObjectReference.md
"""
self.image_pull_secrets = image_pull_secrets
return self
[docs] def set_timeout(self, seconds: int):
"""Configures the pipeline level timeout
Args:
seconds: number of seconds for timeout
"""
self.timeout = seconds
return self
[docs] def set_parallelism(self, max_num_pods: int):
"""Configures the max number of total parallel pods that can execute at the same time in a workflow.
Args:
max_num_pods: max number of total parallel pods.
"""
self.parallelism = max_num_pods
return self
[docs] def set_ttl_seconds_after_finished(self, seconds: int):
"""Configures the ttl after the pipeline has finished.
Args:
seconds: number of seconds for the workflow to be garbage collected after it is finished.
"""
self.ttl_seconds_after_finished = seconds
return self
[docs] def set_default_pod_node_selector(self, label_name: str, value: str):
"""Add a constraint for nodeSelector for a pipeline. Each constraint is a key-value pair label. For the
container to be eligible to run on a node, the node must have each of the constraints appeared
as labels.
Args:
label_name: The name of the constraint label.
value: The value of the constraint label.
"""
self.default_pod_node_selector[label_name] = value
return self
[docs] def set_image_pull_policy(self, policy: str):
"""Configures the default image pull policy
Args:
policy: the pull policy, has to be one of: Always, Never, IfNotPresent.
For more info: https://github.com/kubernetes-client/python/blob/10a7f95435c0b94a6d949ba98375f8cc85a70e5a/kubernetes/docs/V1Container.md
"""
self.image_pull_policy = policy
return self
@property
def data_passing_method(self):
return self._data_passing_method
@data_passing_method.setter
def data_passing_method(self, value):
"""Sets the object representing the method used for intermediate data passing.
Example:
::
from kfp.dsl import PipelineConf, data_passing_methods
from kubernetes.client.models import V1Volume, V1PersistentVolumeClaim
pipeline_conf = PipelineConf()
pipeline_conf.data_passing_method = data_passing_methods.KubernetesVolume(
volume=V1Volume(
name='data',
persistent_volume_claim=V1PersistentVolumeClaim('data-volume'),
),
path_prefix='artifact_data/',
)
"""
self._data_passing_method = value
[docs]def get_pipeline_conf():
"""Configure the pipeline level setting to the current pipeline
Note: call the function inside the user defined pipeline function.
"""
return Pipeline.get_default_pipeline().conf
#TODO: Pipeline is in fact an opsgroup, refactor the code.
class Pipeline():
"""A pipeline contains a list of operators.
This class is not supposed to be used by pipeline authors since pipeline authors can use
pipeline functions (decorated with @pipeline) to reference their pipelines. This class
is useful for implementing a compiler. For example, the compiler can use the following
to get the pipeline object and its ops:
Example:
::
with Pipeline() as p:
pipeline_func(*args_list)
traverse(p.ops)
"""
# _default_pipeline is set when it (usually a compiler) runs "with Pipeline()"
_default_pipeline = None
@staticmethod
def get_default_pipeline():
"""Get default pipeline. """
return Pipeline._default_pipeline
@staticmethod
def add_pipeline(name, description, func):
"""Add a pipeline function with the specified name and description."""
# Applying the @pipeline decorator to the pipeline function
func = pipeline(name=name, description=description)(func)
def __init__(self, name: str):
"""Create a new instance of Pipeline.
Args:
name: the name of the pipeline. Once deployed, the name will show up in Pipeline System UI.
"""
self.name = name
self.ops = {}
# Add the root group.
self.groups = [_ops_group.OpsGroup('pipeline', name=name)]
self.group_id = 0
self.conf = PipelineConf()
self._metadata = None
def __enter__(self):
if Pipeline._default_pipeline:
raise Exception('Nested pipelines are not allowed.')
Pipeline._default_pipeline = self
self._old_container_task_constructor = _components._container_task_constructor
_components._container_task_constructor = _create_container_op_from_component_and_arguments
def register_op_and_generate_id(op):
return self.add_op(op, op.is_exit_handler)
self._old__register_op_handler = _container_op._register_op_handler
_container_op._register_op_handler = register_op_and_generate_id
return self
def __exit__(self, *args):
Pipeline._default_pipeline = None
_container_op._register_op_handler = self._old__register_op_handler
_components._container_task_constructor = self._old_container_task_constructor
def add_op(self, op: _container_op.BaseOp, define_only: bool):
"""Add a new operator.
Args:
op: An operator of ContainerOp, ResourceOp or their inherited types.
Returns
op_name: a unique op name.
"""
#If there is an existing op with this name then generate a new name.
op_name = _make_name_unique_by_adding_index(op.human_name, list(self.ops.keys()), ' ')
self.ops[op_name] = op
if not define_only:
self.groups[-1].ops.append(op)
return op_name
def push_ops_group(self, group: _ops_group.OpsGroup):
"""Push an OpsGroup into the stack.
Args:
group: An OpsGroup. Typically it is one of ExitHandler, Branch, and Loop.
"""
self.groups[-1].groups.append(group)
self.groups.append(group)
def pop_ops_group(self):
"""Remove the current OpsGroup from the stack."""
del self.groups[-1]
def remove_op_from_groups(self, op):
for group in self.groups:
group.remove_op_recursive(op)
def get_next_group_id(self):
"""Get next id for a new group. """
self.group_id += 1
return self.group_id
def _set_metadata(self, metadata):
"""_set_metadata passes the containerop the metadata information
Args:
metadata (ComponentMeta): component metadata
"""
self._metadata = metadata