forked from kubeflow/pipelines
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Backend + SDK): Update kfp backend and kubernetes sdk to support…
… ImagePullSecrets (kubeflow#10427) * Update kfp backend and kubernetes sdk to support ImagePullSecrets * update go.mod go.sum and csv files * update image_pull_secret method name * update unit tests * update apiserver.csv file * update set_image_pull_secrets name
- Loading branch information
1 parent
351a150
commit 27d66b1
Showing
10 changed files
with
325 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Copyright 2024 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. | ||
|
|
||
| from typing import List | ||
|
|
||
| from google.protobuf import json_format | ||
| from kfp.dsl import PipelineTask | ||
| from kfp.kubernetes import common | ||
| from kfp.kubernetes import kubernetes_executor_config_pb2 as pb | ||
|
|
||
|
|
||
| def set_image_pull_secrets( | ||
| task: PipelineTask, | ||
| secret_names: List[str], | ||
| ) -> PipelineTask: | ||
| """Set image pull secrets for a Kubernetes task. | ||
| Args: | ||
| task: Pipeline task. | ||
| secret_names: List of image pull secret names. | ||
| Returns: | ||
| Task object with updated image pull secret configuration. | ||
| """ | ||
|
|
||
| msg = common.get_existing_kubernetes_config_as_message(task) | ||
|
|
||
| # Assuming secret_names is a list of strings | ||
| image_pull_secret = [ | ||
| pb.ImagePullSecret(secret_name=secret_name) for secret_name in secret_names | ||
| ] | ||
|
|
||
| msg.image_pull_secret.extend(image_pull_secret) | ||
|
|
||
| task.platform_config['kubernetes'] = json_format.MessageToDict(msg) | ||
|
|
||
| return task |
32 changes: 32 additions & 0 deletions
32
kubernetes_platform/python/test/snapshot/data/image_pull_secrets.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Copyright 2024 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. | ||
|
|
||
| from kfp import dsl | ||
| from kfp import kubernetes | ||
|
|
||
|
|
||
| @dsl.component | ||
| def comp(): | ||
| pass | ||
|
|
||
|
|
||
| @dsl.pipeline | ||
| def my_pipeline(): | ||
| task = comp() | ||
| kubernetes.set_image_pull_secrets(task, ['my-secret']) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| from kfp import compiler | ||
| compiler.Compiler().compile(my_pipeline, __file__.replace('.py', '.yaml')) |
57 changes: 57 additions & 0 deletions
57
kubernetes_platform/python/test/snapshot/data/image_pull_secrets.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # 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.6.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.7 | ||
| 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.6.0 | ||
| --- | ||
| platforms: | ||
| kubernetes: | ||
| deploymentSpec: | ||
| executors: | ||
| exec-comp: | ||
| imagePullSecret: | ||
| - secretName: my-secret |
111 changes: 111 additions & 0 deletions
111
kubernetes_platform/python/test/unit/test_image_pull_secrets.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # Copyright 2024 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. | ||
|
|
||
| from google.protobuf import json_format | ||
| from kfp import dsl | ||
| from kfp import kubernetes | ||
|
|
||
|
|
||
| class TestImagePullSecret: | ||
|
|
||
| def test_add_one(self): | ||
|
|
||
| @dsl.pipeline | ||
| def my_pipeline(): | ||
| task = comp() | ||
| kubernetes.set_image_pull_secrets(task, ['secret-name']) | ||
|
|
||
| assert json_format.MessageToDict(my_pipeline.platform_spec) == { | ||
| 'platforms': { | ||
| 'kubernetes': { | ||
| 'deploymentSpec': { | ||
| 'executors': { | ||
| 'exec-comp': { | ||
| 'imagePullSecret': [{ | ||
| 'secretName': | ||
| 'secret-name' | ||
| }] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| def test_add_two(self): | ||
|
|
||
| @dsl.pipeline | ||
| def my_pipeline(): | ||
| task = comp() | ||
| kubernetes.set_image_pull_secrets(task, ['secret-name1', 'secret-name2']) | ||
|
|
||
| assert json_format.MessageToDict(my_pipeline.platform_spec) == { | ||
| 'platforms': { | ||
| 'kubernetes': { | ||
| 'deploymentSpec': { | ||
| 'executors': { | ||
| 'exec-comp': { | ||
| 'imagePullSecret': [{ | ||
| 'secretName': | ||
| 'secret-name1' | ||
| }, { | ||
| 'secretName': | ||
| 'secret-name2' | ||
| }, | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| def test_respects_other_configuration(self): | ||
|
|
||
| @dsl.pipeline | ||
| def my_pipeline(): | ||
| task = comp() | ||
|
|
||
| # Load the secret as a volume | ||
| kubernetes.use_secret_as_volume( | ||
| task, secret_name='secret-name', mount_path='/mnt/my_vol') | ||
|
|
||
| # Set image pull secrets for a task using secret names | ||
| kubernetes.set_image_pull_secrets(task, ['secret-name']) | ||
|
|
||
| assert json_format.MessageToDict(my_pipeline.platform_spec) == { | ||
| 'platforms': { | ||
| 'kubernetes': { | ||
| 'deploymentSpec': { | ||
| 'executors': { | ||
| 'exec-comp': { | ||
| 'secretAsVolume': [{ | ||
| 'secretName': 'secret-name', | ||
| 'mountPath': '/mnt/my_vol' | ||
| }], | ||
| 'imagePullSecret': [{ | ||
| 'secretName': | ||
| 'secret-name' | ||
| }] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| @dsl.component | ||
| def comp(): | ||
| pass |