Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP - do not merge - support parameter inputs in kfp-kubernetes #71

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions backend/src/v2/driver/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -544,14 +544,34 @@ func extendPodSpecPatch(
// Get secret mount information
for _, secretAsVolume := range kubernetesExecutorConfig.GetSecretAsVolume() {
optional := secretAsVolume.Optional != nil && *secretAsVolume.Optional

// Read the secret name passed in. If it has braces around it, it is dynamic, and we
// need to check the parameter inputs map for the actual runtime value to use.
// If there are no braces, it IS the name of the secret to mount -- just use it.
secretName := secretAsVolume.GetSecretName()
if strings.HasPrefix(secretName, "{{") {
// it looks like this in the protobuf:
// secretName: '{{my_secret}}'
// strip the braces
key := secretName[2 : len(secretName)-2]

// get the value from the parameter inputs map
inputParams, _, err := dag.Execution.GetParameters()
if err != nil {
return err
}
val := inputParams[key]
secretName = val.GetStringValue()
}

secretVolume := k8score.Volume{
Name: secretAsVolume.GetSecretName(),
Name: secretName,
VolumeSource: k8score.VolumeSource{
Secret: &k8score.SecretVolumeSource{SecretName: secretAsVolume.GetSecretName(), Optional: &optional},
Secret: &k8score.SecretVolumeSource{SecretName: secretName, Optional: &optional},
},
}
secretVolumeMount := k8score.VolumeMount{
Name: secretAsVolume.GetSecretName(),
Name: secretName,
MountPath: secretAsVolume.GetMountPath(),
}
podSpec.Volumes = append(podSpec.Volumes, secretVolume)
Expand Down
14 changes: 10 additions & 4 deletions kubernetes_platform/python/kfp/kubernetes/secret.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
from kfp.dsl import PipelineTask
from kfp.kubernetes import common
from kfp.kubernetes import kubernetes_executor_config_pb2 as pb

from typing import Union
from kfp.dsl.pipeline_channel import PipelineParameterChannel

def use_secret_as_env(
task: PipelineTask,
Expand Down Expand Up @@ -59,7 +60,7 @@ def use_secret_as_env(

def use_secret_as_volume(
task: PipelineTask,
secret_name: str,
secret_name: Union[str, PipelineParameterChannel],
mount_path: str,
optional: bool = False,
) -> PipelineTask:
Expand All @@ -75,11 +76,16 @@ def use_secret_as_volume(
Returns:
Task object with updated secret configuration.
"""

msg = common.get_existing_kubernetes_config_as_message(task)

val = secret_name
# if secret_name is a PipelineParameterChannel, then we don't know what secret to mount until RUNTIME
# so, treat is as a map KEY instead of a secret name
if isinstance(secret_name, PipelineParameterChannel):
val = "{{" + secret_name.name + "}}"

secret_as_vol = pb.SecretAsVolume(
secret_name=secret_name,
secret_name=val,
mount_path=mount_path,
optional=optional,
)
Expand Down
18 changes: 18 additions & 0 deletions test-pipeline-1.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from kfp import dsl
from kfp import kubernetes


@dsl.component
def comp():
pass

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with open('/mnt/my_secret') as f:
    print(f.read())


@dsl.pipeline
def my_pipeline(my_secret: str):
task = comp()
task.set_caching_options(False)

kubernetes.use_secret_as_volume(
task,
secret_name=my_secret,
mount_path='/mnt/my_secret',
)
65 changes: 65 additions & 0 deletions test-pipeline-1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# PIPELINE DEFINITION
# Name: my-pipeline
# Inputs:
# my_secret: str
components:
comp-comp:
executorLabel: exec-comp
deploymentSpec:
executors:
exec-comp:
container:
args:
- --executor_input
- '{{$}}'
- --function_to_execute
- comp
command:
- sh
- -c
- "\nif ! [ -x \"$(command -v pip)\" ]; then\n python3 -m ensurepip ||\
\ python3 -m ensurepip --user || apt-get install python3-pip\nfi\n\nPIP_DISABLE_PIP_VERSION_CHECK=1\
\ python3 -m pip install --quiet --no-warn-script-location 'kfp==2.8.0'\
\ '--no-deps' 'typing-extensions>=3.7.4,<5; python_version<\"3.9\"' && \"\
$0\" \"$@\"\n"
- sh
- -ec
- 'program_path=$(mktemp -d)


printf "%s" "$0" > "$program_path/ephemeral_component.py"

_KFP_RUNTIME=true python3 -m kfp.dsl.executor_main --component_module_path "$program_path/ephemeral_component.py" "$@"

'
- "\nimport kfp\nfrom kfp import dsl\nfrom kfp.dsl import *\nfrom typing import\
\ *\n\ndef comp():\n pass\n\n"
image: python:3.8
pipelineInfo:
name: my-pipeline
root:
dag:
tasks:
comp:
cachingOptions:
enableCache: false
componentRef:
name: comp-comp
taskInfo:
name: comp
inputDefinitions:
parameters:
my_secret:
parameterType: STRING
schemaVersion: 2.1.0
sdkVersion: kfp-2.8.0
---
platforms:
kubernetes:
deploymentSpec:
executors:
exec-comp:
secretAsVolume:
- mountPath: /mnt/my_secret
optional: false
secretName: '{{my_secret}}'
18 changes: 18 additions & 0 deletions test-pipeline-2.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from kfp import dsl
from kfp import kubernetes


@dsl.component
def comp():
pass

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace pass with the following

    with open('/mnt/my_secret') as f:
        print(f.read())


@dsl.pipeline
def my_pipeline(my_secret: str = 'some-default-secret'):
task = comp()
task.set_caching_options(False)

kubernetes.use_secret_as_volume(
task,
secret_name=my_secret,
mount_path='/mnt/my_secret',
)
67 changes: 67 additions & 0 deletions test-pipeline-2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# PIPELINE DEFINITION
# Name: my-pipeline
# Inputs:
# my_secret: str [Default: 'some-default-secret']
components:
comp-comp:
executorLabel: exec-comp
deploymentSpec:
executors:
exec-comp:
container:
args:
- --executor_input
- '{{$}}'
- --function_to_execute
- comp
command:
- sh
- -c
- "\nif ! [ -x \"$(command -v pip)\" ]; then\n python3 -m ensurepip ||\
\ python3 -m ensurepip --user || apt-get install python3-pip\nfi\n\nPIP_DISABLE_PIP_VERSION_CHECK=1\
\ python3 -m pip install --quiet --no-warn-script-location 'kfp==2.8.0'\
\ '--no-deps' 'typing-extensions>=3.7.4,<5; python_version<\"3.9\"' && \"\
$0\" \"$@\"\n"
- sh
- -ec
- 'program_path=$(mktemp -d)


printf "%s" "$0" > "$program_path/ephemeral_component.py"

_KFP_RUNTIME=true python3 -m kfp.dsl.executor_main --component_module_path "$program_path/ephemeral_component.py" "$@"

'
- "\nimport kfp\nfrom kfp import dsl\nfrom kfp.dsl import *\nfrom typing import\
\ *\n\ndef comp():\n pass\n\n"
image: python:3.8
pipelineInfo:
name: my-pipeline
root:
dag:
tasks:
comp:
cachingOptions:
enableCache: false
componentRef:
name: comp-comp
taskInfo:
name: comp
inputDefinitions:
parameters:
my_secret:
defaultValue: some-default-secret
isOptional: true
parameterType: STRING
schemaVersion: 2.1.0
sdkVersion: kfp-2.8.0
---
platforms:
kubernetes:
deploymentSpec:
executors:
exec-comp:
secretAsVolume:
- mountPath: /mnt/my_secret
optional: false
secretName: '{{my_secret}}'
17 changes: 17 additions & 0 deletions test-pipeline-3.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from kfp import dsl
from kfp import kubernetes


@dsl.component
def comp():
pass

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace pass with the following

    with open('/mnt/my_secret') as f:
        print(f.read())


@dsl.pipeline
def my_pipeline():
task = comp()

kubernetes.use_secret_as_volume(
task,
secret_name='my-hardcoded-secret',
mount_path='/mnt/my_secret',
)
59 changes: 59 additions & 0 deletions test-pipeline-3.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# PIPELINE DEFINITION
# Name: my-pipeline
components:
comp-comp:
executorLabel: exec-comp
deploymentSpec:
executors:
exec-comp:
container:
args:
- --executor_input
- '{{$}}'
- --function_to_execute
- comp
command:
- sh
- -c
- "\nif ! [ -x \"$(command -v pip)\" ]; then\n python3 -m ensurepip ||\
\ python3 -m ensurepip --user || apt-get install python3-pip\nfi\n\nPIP_DISABLE_PIP_VERSION_CHECK=1\
\ python3 -m pip install --quiet --no-warn-script-location 'kfp==2.8.0'\
\ '--no-deps' 'typing-extensions>=3.7.4,<5; python_version<\"3.9\"' && \"\
$0\" \"$@\"\n"
- sh
- -ec
- 'program_path=$(mktemp -d)


printf "%s" "$0" > "$program_path/ephemeral_component.py"

_KFP_RUNTIME=true python3 -m kfp.dsl.executor_main --component_module_path "$program_path/ephemeral_component.py" "$@"

'
- "\nimport kfp\nfrom kfp import dsl\nfrom kfp.dsl import *\nfrom typing import\
\ *\n\ndef comp():\n pass\n\n"
image: python:3.8
pipelineInfo:
name: my-pipeline
root:
dag:
tasks:
comp:
cachingOptions:
enableCache: true
componentRef:
name: comp-comp
taskInfo:
name: comp
schemaVersion: 2.1.0
sdkVersion: kfp-2.8.0
---
platforms:
kubernetes:
deploymentSpec:
executors:
exec-comp:
secretAsVolume:
- mountPath: /mnt/my_secret
optional: false
secretName: my-hardcoded-secret
19 changes: 19 additions & 0 deletions test-pipeline-4.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from kfp import dsl
from kfp import kubernetes


@dsl.component
def comp():
pass

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace pass with the following

    with open('/mnt/my_secret') as f:
        print(f.read())


@dsl.pipeline
def my_pipeline():
task = comp()

my_secret = 'my-hardcoded-secret2'

kubernetes.use_secret_as_volume(
task,
secret_name=my_secret,
mount_path='/mnt/my_secret',
)
Loading
Loading