Skip to content

Commit e2352bc

Browse files
Revert "Added Pipelines v2 installation pages (#3782)"
This reverts commit 5765bfa Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
1 parent 36c2ce1 commit e2352bc

File tree

7 files changed

+97
-63
lines changed

7 files changed

+97
-63
lines changed

content/en/docs/components/pipelines/operator-guides/installation/choose-executor.md renamed to content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Kubeflow Pipelines runs on [Argo Workflows](https://argoproj.github.io/workflows
1515

1616
## Choosing the Workflow Executor
1717

18-
1. [Emissary executor](#emissary-executor) has been Kubeflow Pipelines' default executor since February 2022 when KFP 1.8 went GA.
18+
1. [Emissary executor](#emissary-executor) has been Kubeflow Pipelines' default executor since Feburay 2022 when KFP 1.8 went GA.
1919
We recommend Emissary executor unless you have known compatibility issues with Emissary, in which case please submit your
20-
feedback in [the Emissary Executor feedback GitHub issue](https://github.com/kubeflow/pipelines/issues/6249).
20+
feedback in [the Emissary Executor feedback Github issue](https://github.com/kubeflow/pipelines/issues/6249).
2121

22-
1. [Docker executor](#docker-executor) is available as a legacy choice. In case you do have compatibility issues with Emissary executor,
22+
1. [Docker executor](#docker-executor) is available as a legacy choice. In case you do have compatibilty issues with Emissary executor,
2323
and your cluster is running on an older version of Kubernetes (<1.20), you can configure to use Docker executor.
2424

2525
Note that Argo Workflows support other workflow executors, but the Kubeflow Pipelines
@@ -39,13 +39,13 @@ improvements can make it the default executor that most people should use going
3939
* Cannot escape the privileges of the pod's service account.
4040
* Migration: `command` must be specified in [Kubeflow Pipelines component specification](/docs/components/pipelines/reference/component-spec/).
4141

42-
Note, the same migration requirement is required by [Kubeflow Pipelines v2 compatible mode](/docs/components/pipelines/reference/version-compatibility/), refer to
42+
Note, the same migration requirement is required by [Kubeflow Pipelines v2 compatible mode](/docs/components/pipelines/legacy-v1/sdk/v2-compatibility/), refer to
4343
[known caveats & breaking changes](https://github.com/kubeflow/pipelines/issues/6133).
4444

4545
#### Migrate to Emissary Executor
4646

4747
Prerequisite: emissary executor is only available in Kubeflow Pipelines backend version 1.7+.
48-
To upgrade, refer to [upgrading Kubeflow Pipelines](/docs/components/pipelines/operator-guides/installation/upgrade/).
48+
To upgrade, refer to [upgrading Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/installation/upgrade//).
4949

5050
##### Configure an existing Kubeflow Pipelines cluster to use emissary executor
5151

@@ -97,7 +97,7 @@ To upgrade, refer to [upgrading Kubeflow Pipelines](/docs/components/pipelines/o
9797
9898
For [AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs), check the "Use emissary executor" checkbox during installation.
9999
100-
For [Kubeflow Pipelines Standalone](/docs/components/pipelines/operator-guides/installation/standalone-deployment/), install `env/platform-agnostic-emissary`:
100+
For [Kubeflow Pipelines Standalone](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/), install `env/platform-agnostic-emissary`:
101101
102102
```bash
103103
kubectl apply -k "github.com/kubeflow/pipelines/manifests/kustomize/env/platform-agnostic-emissary?ref=$PIPELINE_VERSION"
@@ -157,7 +157,7 @@ Step by step component migration tutorial:
157157
1. The updated component can run on emissary executor now.
158158
159159
Note: Kubeflow Pipelines SDK compiler always specifies a command for
160-
[python function based components](https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html#kfp.components.PythonComponent).
160+
[python function based components](/docs/components/pipelines/legacy-v1/sdk/python-function-components/).
161161
Therefore, these components will continue to work on emissary executor without
162162
modifications.
163163

content/en/docs/components/pipelines/operator-guides/installation/compatibility-matrix.md renamed to content/en/docs/components/pipelines/legacy-v1/installation/compatibility-matrix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Pipelines written in any version of [TensorFlow Extended (TFX)](https://www.tens
1616
The following table shows UI feature compatibility for TFX and Kubeflow Pipelines Backend versions:
1717

1818
| [TFX] \ [KFP Backend] | [KFP Backend] <= 1.5 | [KFP Backend] >= 1.7 |
19-
|-----------------------|---------------------------------------------------|------------------------------------------------|
20-
| [TFX] <= 0.28.0 | Fully Compatible ✅ | Metadata UI not compatible<sup>[2](#fn2)</sup> |
19+
| --------------------- | ------------------------------------------------- | ---------------------------------------------- |
20+
| [TFX] <= 0.28.0 | Fully Compatible ✅ | Metadata UI not compatible<sup>[2](#fn2)</sup> |
2121
| [TFX] 0.29.0, 0.30.0 | Visualizations not compatible<sup>[1](#fn1)</sup> | Metadata UI not compatible<sup>[2](#fn2)</sup> |
2222
| [TFX] 1.0.0 | Metadata UI not compatible<sup>[2](#fn2)</sup> | Metadata UI not compatible<sup>[2](#fn2)</sup> |
23-
| [TFX] >= 1.2.0 | Metadata UI not compatible<sup>[2](#fn2)</sup> | Fully Compatible ✅ |
23+
| [TFX] >= 1.2.0 | Metadata UI not compatible<sup>[2](#fn2)</sup> | Fully Compatible ✅ |
2424

2525
Detailed explanations:
2626

content/en/docs/components/pipelines/operator-guides/installation/localcluster-deployment.md renamed to content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Such deployment methods can be part of your local environment using the supplied
2121
kustomize manifests for test purposes. This guide is an alternative to
2222

2323
[Deploying Kubeflow Pipelines
24-
(KFP)](/docs/started/installing-kubeflow).
24+
(KFP)](/docs/started/#installing-kubeflow).
2525

2626
## Before you get started
2727

@@ -164,7 +164,7 @@ enhancements:
164164
* Embedded service loadbalancer
165165
* Embedded network policy controller
166166

167-
You can find the official K3s installation script to install it as a service
167+
You can find the the official K3s installation script to install it as a service
168168
on systemd- or openrc-based systems on the official
169169
[K3s website](https://get.k3s.io).
170170

@@ -216,7 +216,7 @@ curl -sfL https://get.k3s.io | sh -
216216
The Windows Subsystem for Linux (WSL) lets developers run a GNU/Linux
217217
environment—including most command-line tools, utilities, and applications—
218218
directly on Windows, unmodified, without the overhead of a traditional virtual
219-
machine or dual-boot setup.
219+
machine or dualboot setup.
220220

221221
The full instructions for installing WSL can be found on the
222222
[official Windows site](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
@@ -227,7 +227,7 @@ WSL.
227227
1. Install [WSL] by following the official [docs](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
228228
229229
2. As per the official instructions, update WSL and download your preferred
230-
distribution:
230+
distibution:
231231
232232
- [SUSE Linux Enterprise Server 15
233233
SP1](https://www.microsoft.com/store/apps/9PN498VPMF3Z)
@@ -249,7 +249,7 @@ Below are the steps to create a cluster on K3s in WSL
249249
sudo ./k3s server
250250
```
251251
252-
This will bootstrap a Kubernetes cluster, but you will cannot yet access from
252+
This will bootstrap a Kubernetes cluster but you will cannot yet access from
253253
your Windows machine to the cluster itself.
254254
255255
**Note:** You can't install K3s using the curl script because there is no
@@ -276,7 +276,7 @@ To set up access to your WSL instance:
276276
1. Copy `/etc/rancher/k3s/k3s.yaml` from WSL to `$HOME/.kube/config`.
277277

278278
2. Edit the copied file by changing the server URL from `https://localhost:6443`
279-
to the IP of your WSL instance (`ip addr show dev eth0`) (For example,
279+
to the IP of the your WSL instance (`ip addr show dev eth0`) (For example,
280280
`https://192.168.170.170:6443`.)
281281

282282
3. Run kubectl in a Windows terminal. If you don't kubectl installed, follow the
@@ -286,7 +286,7 @@ To set up access to your WSL instance:
286286
287287
K3ai is a lightweight "infrastructure in a box" designed specifically to install
288288
and configure AI tools and platforms on portable hardware, such as laptops and
289-
edge devices. This enables users to perform quick experiments with Kubeflow
289+
edge devices. This enables users to perform quick experimentations with Kubeflow
290290
on a local cluster.
291291
292292
K3ai's main goal is to provide a quick way to install Kubernetes (K3s-based) and
@@ -361,7 +361,7 @@ Below are the steps to remove Kubeflow Pipelines on kind, K3s, or K3ai:
361361
kubectl delete -k {YOUR_MANIFEST_FILE}`
362362
```
363363
364-
- To uninstall Kubeflow Pipelines using manifests from Kubeflow Pipelines'
364+
- To uninstall Kubeflow Pipelines using manifests from Kubeflow Pipelines's
365365
GitHub repository, run these commands:
366366

367367
```shell

content/en/docs/components/pipelines/operator-guides/installation/overview.md renamed to content/en/docs/components/pipelines/legacy-v1/installation/overview.md

Lines changed: 51 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ portable installation that only includes Kubeflow Pipelines.
1919
* Kubeflow Pipelines as [part of a full Kubeflow deployment](/docs/components/pipelines/operator-guides/installation/overview/#full-kubeflow-deployment) provides
2020
all Kubeflow components and more integration with each platform.
2121
* **Beta**: [Google Cloud AI Platform Pipelines](#google-cloud-ai-platform-pipelines) makes it easier to install and use Kubeflow Pipelines on Google Cloud by providing a management UI on [Google Cloud Console](https://console.cloud.google.com/ai-platform/pipelines/clusters).
22-
* A [local](/docs/components/pipelines/operator-guides/installation/localcluster-deployment) Kubeflow Pipelines deployment for testing purposes.
22+
* A [local](/docs/components/pipelines/legacy-v1/installation/localcluster-deployment) Kubeflow Pipelines deployment for testing purposes.
2323

2424
## Choosing an installation option
2525

@@ -28,7 +28,7 @@ all Kubeflow components and more integration with each platform.
2828
If yes, choose the [full Kubeflow deployment](/docs/components/pipelines/operator-guides/installation/overview/#full-kubeflow-deployment).
2929
1. Can you use a cloud/on-prem Kubernetes cluster?
3030

31-
If you can't, you should try using Kubeflow Pipelines on a local Kubernetes cluster for learning and testing purposes by following the steps in [Deploying Kubeflow Pipelines on a local cluster](/docs/components/pipelines/operator-guides/installation/localcluster-deployment).
31+
If you can't, you should try using Kubeflow Pipelines on a local Kubernetes cluster for learning and testing purposes by following the steps in [Deploying Kubeflow Pipelines on a local cluster](/docs/components/pipelines/legacy-v1/installation/localcluster-deployment).
3232
1. Do you want to use Kubeflow Pipelines with [multi-user support](https://github.com/kubeflow/pipelines/issues/1223)?
3333

3434
If yes, choose the [full Kubeflow deployment](/docs/components/pipelines/operator-guides/installation/overview/#full-kubeflow-deployment) with version >= v1.1.
@@ -59,32 +59,38 @@ To deploy Kubeflow Pipelines Standalone, you use kustomize manifests only.
5959
This process makes it simpler to customize your deployment and to integrate
6060
Kubeflow Pipelines into an existing Kubernetes cluster.
6161

62-
Installation guide: [Kubeflow Pipelines Standalone deployment
63-
guide](/docs/components/pipelines/operator-guides/installation/standalone-deployment/)
62+
Installation guide
63+
: [Kubeflow Pipelines Standalone deployment
64+
guide](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/)
6465

65-
Interfaces:
66+
Interfaces
67+
:
6668
* Kubeflow Pipelines UI
6769
* Kubeflow Pipelines SDK
6870
* Kubeflow Pipelines API
69-
* Kubeflow Pipelines endpoint is **only autoconfigured** for Google Cloud.
71+
* Kubeflow Pipelines endpoint is **only auto-configured** for Google Cloud.
7072

7173
If you wish to deploy Kubeflow Pipelines on other platforms, you can either access it through
7274
`kubectl port-forward` or configure your own platform specific auth-enabled
7375
endpoint by yourself.
7476

75-
Release Schedule: Kubeflow Pipelines Standalone is available for every Kubeflow Pipelines release.
77+
Release Schedule
78+
: Kubeflow Pipelines Standalone is available for every Kubeflow Pipelines release.
7679
You will have access to the latest features.
7780

78-
Upgrade Support (**Beta**): [Upgrading Kubeflow Pipelines Standalone](/docs/components/pipelines/operator-guides/installation/standalone-deployment/#upgrading-kubeflow-pipelines) introduces how to upgrade
81+
Upgrade Support (**Beta**)
82+
: [Upgrading Kubeflow Pipelines Standalone](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/#upgrading-kubeflow-pipelines) introduces how to upgrade
7983
in place.
8084

81-
Google Cloud Integrations:
82-
* A Kubeflow Pipelines public endpoint with auth support is **autoconfigured** for you.
85+
Google Cloud Integrations
86+
:
87+
* A Kubeflow Pipelines public endpoint with auth support is **auto-configured** for you.
8388
* Open the Kubeflow Pipelines UI via the **Open Pipelines Dashboard** link in [the AI Platform Pipelines dashboard of Cloud Console](https://console.cloud.google.com/ai-platform/pipelines/clusters).
8489
* (Optional) You can choose to persist your data in Google Cloud managed storage (Cloud SQL and Cloud Storage).
85-
* All options to authenticate to Google Cloud are supported.
90+
* [All options to authenticate to Google Cloud](/docs/gke/pipelines/authentication-pipelines/) are supported.
8691

87-
Notes on specific features:
92+
Notes on specific features
93+
:
8894
* After deployment, your Kubernetes cluster contains Kubeflow Pipelines only.
8995
It does not include the other Kubeflow components.
9096
For example, to use a Jupyter Notebook, you must use a local notebook or a
@@ -99,17 +105,20 @@ Notes on specific features:
99105
Use this option to deploy Kubeflow Pipelines to your local machine, on-premises,
100106
or to a cloud, as part of a full Kubeflow installation.
101107

102-
Installation guide: [Kubeflow installation guide](/docs/started/)
108+
Installation guide
109+
: [Kubeflow installation guide](/docs/started/)
103110

104-
Interfaces:
111+
Interfaces
112+
:
105113
* Kubeflow UI
106114
* Kubeflow Pipelines UI within or outside the Kubeflow UI
107115
* Kubeflow Pipelines SDK
108116
* Kubeflow Pipelines API
109117
* Other Kubeflow APIs
110-
* Kubeflow Pipelines endpoint is autoconfigured with auth support for each platform
118+
* Kubeflow Pipelines endpoint is auto-configured with auth support for each platform
111119

112-
Release Schedule: The full Kubeflow is released quarterly. It has significant delay in receiving
120+
Release Schedule
121+
: The full Kubeflow is released quarterly. It has significant delay in receiving
113122
Kubeflow Pipelines updates.
114123

115124
| Kubeflow Version | Kubeflow Pipelines Version |
@@ -124,15 +133,18 @@ Kubeflow Pipelines updates.
124133

125134
Note: Google Cloud, AWS, and IBM Cloud have supported Kubeflow Pipelines 1.0.0 with multi-user separation. Other platforms might not be up-to-date for now, refer to [this GitHub issue](https://github.com/kubeflow/manifests/issues/1364#issuecomment-668415871) for status.
126135

127-
Upgrade Support:
128-
Refer to [the full Kubeflow section of upgrading Kubeflow Pipelines on Google Cloud](/docs/components/pipelines/operator-guides/installation/upgrade) guide.
136+
Upgrade Support
137+
:
138+
Refer to [the full Kubeflow section of upgrading Kubeflow Pipelines on Google Cloud](/docs/gke/pipelines/upgrade/#full-kubeflow) guide.
129139

130-
Google Cloud Integrations:
131-
* A Kubeflow Pipelines public endpoint with auth support is **autoconfigured** for you using [Cloud Identity-Aware Proxy](https://cloud.google.com/iap).
140+
Google Cloud Integrations
141+
:
142+
* A Kubeflow Pipelines public endpoint with auth support is **auto-configured** for you using [Cloud Identity-Aware Proxy](https://cloud.google.com/iap).
132143
* There's no current support for persisting your data in Google Cloud managed storage (Cloud SQL and Cloud Storage). Refer to [this GitHub issue](https://github.com/kubeflow/pipelines/issues/4356) for the latest status.
133-
* You can authenticate to Google Cloud with Workload Identity.
144+
* You can [authenticate to Google Cloud with Workload Identity](/docs/gke/pipelines/authentication-pipelines/#workload-identity).
134145

135-
Notes on specific features:
146+
Notes on specific features
147+
:
136148
* After deployment, your Kubernetes cluster includes all the
137149
[Kubeflow components](/docs/components/).
138150
For example, you can use the Jupyter notebook services
@@ -161,30 +173,38 @@ Use this option to deploy Kubeflow Pipelines to Google Kubernetes Engine (GKE)
161173
from Google Cloud Marketplace. You can deploy Kubeflow Pipelines to an existing or new
162174
GKE cluster and manage your cluster within Google Cloud.
163175

164-
Installation guide: [Google Cloud AI Platform Pipelines documentation](https://cloud.google.com/ai-platform/pipelines/docs)
176+
Installation guide
177+
: [Google Cloud AI Platform Pipelines documentation](https://cloud.google.com/ai-platform/pipelines/docs)
165178

166-
Interfaces:
179+
Interfaces
180+
:
167181
* Google Cloud Console for managing the Kubeflow Pipelines cluster and other Google Cloud
168182
services
169183
* Kubeflow Pipelines UI via the **Open Pipelines Dashboard** link in the
170184
Google Cloud Console
171185
* Kubeflow Pipelines SDK in Cloud Notebooks
172-
* Kubeflow Pipelines endpoint of your instance is autoconfigured for you
186+
* Kubeflow Pipelines endpoint of your instance is auto-configured for you
173187

174-
Release Schedule: AI Platform Pipelines is available for a chosen set of stable Kubeflow
188+
Release Schedule
189+
: AI Platform Pipelines is available for a chosen set of stable Kubeflow
175190
Pipelines releases. You will receive updates slightly slower than Kubeflow
176191
Pipelines Standalone.
177192

178-
Upgrade Support (**Alpha**): An in-place upgrade is not supported.
193+
Upgrade Support (**Alpha**)
194+
: An in-place upgrade is not supported.
179195

180-
Google Cloud Integrations:
196+
To upgrade AI Platform Pipelines by reinstalling it (with existing data), refer to the [Upgrading AI Platform Pipelines](/docs/gke/pipelines/upgrade/#ai-platform-pipelines) guide.
197+
198+
Google Cloud Integrations
199+
:
181200
* You can deploy AI Platform Pipelines on [Cloud Console UI](https://console.cloud.google.com/marketplace/details/google-cloud-ai-platform/kubeflow-pipelines).
182-
* A Kubeflow Pipelines public endpoint with auth support is **autoconfigured** for you.
201+
* A Kubeflow Pipelines public endpoint with auth support is **auto-configured** for you.
183202
* (Optional) You can choose to persist your data in Google Cloud managed storage services (Cloud SQL and Cloud Storage).
184-
* You can authenticate to Google Cloud with the Compute Engine default service account. However, this method may not be suitable if you need workload permission separation.
203+
* You can [authenticate to Google Cloud with the Compute Engine default service account](/docs/gke/pipelines/authentication-pipelines/#compute-engine-default-service-account). However, this method may not be suitable if you need workload permission separation.
185204
* You can deploy AI Platform Pipelines on both public and private GKE clusters as long as the cluster [has sufficient resources for AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs/configure-gke-cluster#ensure).
186205

187-
Notes on specific features:
206+
Notes on specific features
207+
:
188208
* After deployment, your Kubernetes cluster contains Kubeflow Pipelines only.
189209
It does not include the other Kubeflow components.
190210
For example, to use a Jupyter Notebook, you can use [AI Platform

0 commit comments

Comments
 (0)