|
1 | 1 | # Kubeflow Pipelines v2
|
2 | 2 |
|
3 |
| -There are two modes Kubeflow Pipelines (KFP) v2 can run in: |
| 3 | +## Design |
4 | 4 |
|
5 |
| -* v2 compatible -- supports core v2 features in KFP v1 |
6 |
| -* v2 (v2 engine) -- full feature v2 in KFP v2's new architecture |
7 |
| - |
8 |
| -Code for both modes live inside this folder. |
9 |
| - |
10 |
| -## Kubeflow Pipelines v2 compatible |
11 |
| - |
12 |
| -Status: [Beta](../docs/release/feature-stages.md#beta), to be deprecated in KFP SDK v1.9. |
13 |
| -Documentation: [Introducing Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk/v2/v2-compatibility/) |
14 |
| -[Known Caveats & breaking changes](https://github.com/kubeflow/pipelines/issues/6133) |
15 |
| -Design: [bit.ly/kfp-v2-compatible](https://bit.ly/kfp-v2-compatible) |
16 |
| -Github Project: [KFP v2 compatible mode project](https://github.com/kubeflow/pipelines/projects/13) |
17 |
| - |
18 |
| -Plan: |
19 |
| - |
20 |
| -* [x] 2021 late May - first release |
21 |
| -* [x] 2021 early August (delayed from mid July) - feature complete |
22 |
| -* [x] [End of support in KFP SDK v1.9](https://github.com/kubeflow/pipelines/issues/6829) |
23 |
| - |
24 |
| -## Kubeflow Pipelines v2 engine |
25 |
| - |
26 |
| -Status: not released (WIP) |
27 |
| -Design: [bit.ly/kfp-v2](https://bit.ly/kfp-v2) (You need to join [kubeflow-discuss google group](https://groups.google.com/g/kubeflow-discuss) to get access.) |
28 |
| -Github Project: [KFP v2 project](https://github.com/kubeflow/pipelines/projects/9) |
29 |
| -Tracker Issue: [KFP v2 tracker](https://github.com/kubeflow/pipelines/issues/6110) |
30 |
| - |
31 |
| -Plan: |
32 |
| - |
33 |
| -* [ ] 2021 October - Alpha release |
34 |
| -* [ ] TBD - Beta/Stable release |
| 5 | +[bit.ly/kfp-v2](https://bit.ly/kfp-v2) (You need to join [kubeflow-discuss google group](https://groups.google.com/g/kubeflow-discuss) to get access). |
35 | 6 |
|
36 | 7 | ## Developing
|
37 | 8 |
|
@@ -108,10 +79,10 @@ it should have the following content:
|
108 | 79 | * KFP backend version should be at least 1.7.0-rc.2.
|
109 | 80 |
|
110 | 81 | Requirements on the KFP SDK package:
|
111 |
| - |
112 |
| - * KFP v2 components defined using `@component` decorator installs KFP SDK package at runtime. |
| 82 | +
|
| 83 | + * KFP v2 components defined using `@component` decorator installs KFP SDK package at runtime. |
113 | 84 | To use a compatible KFP SDK, define the following environment variable before running e2e test:
|
114 |
| - |
| 85 | +
|
115 | 86 | ```
|
116 | 87 | export KFP_PACKAGE_PATH="git+https://github.com/kubeflow/pipelines.git@master#subdirectory=sdk/python"
|
117 | 88 | ```
|
@@ -170,23 +141,3 @@ If something is unexpected, examine the unexpected dependencies by yourself and
|
170 | 141 | overrides to [go-licenses.yaml](./go-licenses.yaml).
|
171 | 142 |
|
172 | 143 | For detailed documentation about the tool: <https://github.com/Bobgy/go-licenses/tree/main/v2>.
|
173 |
| - |
174 |
| -### Releasing KFP v2 compatible image |
175 |
| - |
176 |
| -Note, this is currently outdated instructions for v2 compatible mode. We haven't set up releasing workflow for v2 engine. |
177 |
| -
|
178 |
| -1. Build & release gcr.io/ml-pipeline/kfp-launcher:$TAG_NAME (this step needs write permission to gcr.io/ml-pipeline): |
179 |
| -
|
180 |
| - ```bash |
181 |
| - # login locally |
182 |
| - gcloud auth login |
183 |
| - gcloud auth configure-docker |
184 |
| -
|
185 |
| - cd kubeflow/pipelines/backend/src/v2 |
186 |
| - TAG_NAME=1.6.0 |
187 |
| - LAUNCHER_IMAGE="gcr.io/ml-pipeline/kfp-launcher:${TAG_NAME}" make push-launcher |
188 |
| - ``` |
189 |
| -
|
190 |
| -2. Edit [v2_compat.py](https://github.com/kubeflow/pipelines/blob/master/sdk/python/kfp/compiler/v2_compat.py#L26) -- pin _DEFAULT_LAUNCHER_IMAGE to the tag we will release. |
191 |
| -
|
192 |
| -3. Continue with KFP python SDK release instructions. |
0 commit comments