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

docs(kfp): 1.7 upgrade notices and breaking changes #2895

Merged
merged 4 commits into from
Aug 27, 2021
Merged
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
7 changes: 4 additions & 3 deletions content/en/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
/docs/pipelines/sdk/reusable-components/ /docs/examples/shared-resources/
/docs/pipelines/sdk/build-component/ /docs/components/pipelines/sdk/build-pipeline/
/docs/components/pipelines/sdk/build-component/ /docs/components/pipelines/sdk/build-pipeline/
/docs/components/pipelines/upgrade/ /docs/components/pipelines/installation/upgrade/

# Moved the guide to monitoring GKE deployments.
/docs/other-guides/monitoring/ /docs/distributions/gke/monitoring/
Expand Down Expand Up @@ -143,7 +144,7 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/started/workstation/minikf-aws /docs/distributions/minikf/minikf-aws
/docs/started/workstation/minikf-gcp /docs/distributions/minikf/minikf-gcp

# Distinguish components from external add-ons
# Distinguish components from external add-ons
/docs/components/fairing /docs/external-add-ons/fairing
/docs/components/istio /docs/external-add-ons/istio
/docs/components/feature-store /docs/external-add-ons/feature-store
Expand All @@ -154,7 +155,7 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/started/getting-started /docs/started/installing-kubeflow

# ===============
# IMPORTANT NOTE:
# IMPORTANT NOTE:
# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom
# ===============
/docs/guides/* /docs/:splat
Expand All @@ -168,4 +169,4 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/components/fairing/* /docs/external-add-ons/fairing/:splat
/docs/components/istio/* /docs/external-add-ons/istio/:splat
/docs/components/feature-store/* /docs/external-add-ons/feature-store/:splat
/docs/components/serving/* /docs/external-add-ons/serving/:splat
/docs/components/serving/* /docs/external-add-ons/serving/:splat
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,10 @@ improvements can make it the default executor that most people should use in the
future.

Therefore, the team makes a commitment to actively collect feedback and fix bugs
for the emissary executor, so that we can stablize it faster. So far, Kubeflow
for the emissary executor, so that we can stablize it faster.
Submit your feedback in [the Emissary Executor feedback github issue](https://github.com/kubeflow/pipelines/issues/6249).

So far, Kubeflow
Pipelines test infrastructure has been running stably with the emissary executor.

* Container Runtime: any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ for migration instructions.

## Upgrading Kubeflow Pipelines

1. For release notices and breaking changes, refer to [Upgrading Kubeflow Pipelines](/docs/components/pipelines/upgrade).

1. Check the [Kubeflow Pipelines GitHub repository](https://github.com/kubeflow/pipelines/releases) for available releases.

1. To upgrade to Kubeflow Pipelines 0.4.0 and higher, use the following commands:
Expand Down
27 changes: 27 additions & 0 deletions content/en/docs/components/pipelines/installation/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
+++
title = "Upgrade Notes"
description = "Notices and breaking changes when you upgrade Kubeflow Pipelines Backend"
weight = 35
+++

This page introduces notices and breaking changes you need to know when upgrading Kubeflow Pipelines Backend.

For upgrade instructions, refer to distribution specific documentations:

* [Upgrading Kubeflow Pipelines on Google Cloud](/docs/distributions/gke/pipelines/upgrade/)

## Upgrading to [v1.7]

[v1.7]: https://github.com/kubeflow/pipelines/releases/tag/1.7.0

* **Breaking Change**: Metadata UI and visualizations are not compatible with TensorFlow Extended (TFX) <= v1.0.0. Upgrade to v1.2.0 or above, refer to [Kubeflow Pipelines Backend and TensorFlow Extended (TFX) compatibility matrix](/docs/components/pipelines/installation/compatibility-matrix/).

* **Notice**: Emissary executor (Alpha), a new argo workflow executor is available as an option. Due to [Kubernetes deprecating Docker as a container runtime after v1.20](https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/), emissary may become the default workflow executor for Kubeflow Pipelines in the near future.

For example, the current default docker executor does not work on Google Kubernetes Engine (GKE) 1.19+ out of the box. To use docker executor, your cluster node image must be configured to use docker (deprecated) as container runtime.

Alternatively, using emissary executor (Alpha) removes the restriction on container runtime, but note some of your pipelines may require manual migrations. The Kubeflow Pipelines team welcomes your feedback in [the Emissary Executor feedback github issue](https://github.com/kubeflow/pipelines/issues/6249).

For detailed configuration and migration instructions for both options, refer to [Argo Workflow Executors](https://www.kubeflow.org/docs/components/pipelines/installation/choose-executor/).

* **Notice**: [Kubeflow Pipelines SDK v2 compatibility mode](/docs/components/pipelines/sdk/v2/v2-compatibility/) (Beta) was recently released. The new mode adds support for tracking pipeline runs and artifacts using ML Metadata. In v1.7 backend, complete UI support and caching capabilities for v2 compatibility mode are newly added, [your feedback is welcomed](https://github.com/kubeflow/pipelines/issues/6451).
20 changes: 3 additions & 17 deletions content/en/docs/components/pipelines/sdk/v2/v2-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ mode](http://bit.ly/kfp-v2-compatible), or join the Kubeflow Pipelines community

## Before you begin

1. Install [Kubeflow Pipelines Standalone](/docs/components/pipelines/installation/standalone-deployment) 1.7.0-rc.3 or higher. Note, support for other distributions is under development, see [Current Caveats section](#current-caveats).
1. Install [Kubeflow Pipelines Standalone](/docs/components/pipelines/installation/standalone-deployment) 1.7.0 or higher. Note, support for other distributions is under development, see [Current Caveats section](#current-caveats).

1. Run the following command to install Kubeflow Pipelines SDK v1.6.6 or higher. If you run this command in a Jupyter notebook, restart the kernel after installing the SDK.
1. Run the following command to install Kubeflow Pipelines SDK v1.7.2 or higher. If you run this command in a Jupyter notebook, restart the kernel after installing the SDK.

```bash
pip install kfp --upgrade
Expand Down Expand Up @@ -149,24 +149,10 @@ client.create_run_from_pipeline_func(

## Current Caveats

Kubeflow Pipelines v2 compatible mode is currently in Beta stage. It is under active development and some features may not be complete. Here are some of the current caveats:

* Pipelines do not run on [the full Kubeflow] distributions with Multi-User Kubeflow Pipelines. [#5680]
* Pipelines using [v1 mlpipeline-ui-metadata visualization](/docs/components/pipelines/sdk/output-viewer/) do not compile. [#5666]
* UI integration is work-in-progress, more improvements are planned in [v2 compatible mode github project].
* Caching is work-in-progress. [#5667]
* When consuming an input artifact by URI, its file content is still downloaded to the container regardless. [#5671]
* Pipeline components fail on non-root container images with permission problems. [#5673]
Kubeflow Pipelines v2 compatible mode is currently in Beta stage. It is under active development and some features may not be complete. To find out its current caveats, refer to [v2 compatible mode -- known caveats & breaking changes #6133](https://github.com/kubeflow/pipelines/issues/6133).

[build-pipeline]: /docs/components/pipelines/sdk/v2/build-pipeline/
[build-component]: /docs/components/pipelines/sdk/v2/component-development/
[python-component]: /docs/components/pipelines/sdk/v2/python-function-components/
[kfp-client]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.client.html#kfp.Client
[connect-api]: /docs/components/pipelines/sdk/connect-api/
[the full Kubeflow]: /docs/components/pipelines/installation/overview/#full-kubeflow
[v2 compatible mode github project]: https://github.com/kubeflow/pipelines/projects/13
[#5680]: https://github.com/kubeflow/pipelines/issues/5680
[#5666]: https://github.com/kubeflow/pipelines/issues/5666
[#5671]: https://github.com/kubeflow/pipelines/issues/5671
[#5673]: https://github.com/kubeflow/pipelines/issues/5673
[#5667]: https://github.com/kubeflow/pipelines/issues/5667
8 changes: 0 additions & 8 deletions content/en/docs/components/pipelines/upgrade.md

This file was deleted.