Skip to content

Commit

Permalink
Update docs for release 0.6.0 (kubeflow#433)
Browse files Browse the repository at this point in the history
  • Loading branch information
ckadner authored Jan 26, 2021
1 parent 549049a commit d2f4328
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 26 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2020 kubeflow.org
# Copyright 2020-2021 kubeflow.org
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -16,7 +16,7 @@
# - The help target was derived from https://stackoverflow.com/a/35730328/5601796

VENV ?= .venv
KFP_TEKTON_RELEASE ?= v0.5.0
KFP_TEKTON_RELEASE ?= v0.6.0
export VIRTUAL_ENV := $(abspath ${VENV})
export PATH := ${VIRTUAL_ENV}/bin:${PATH}
DOCKER_REGISTRY ?= aipipeline
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.5.0
0.6.0
30 changes: 18 additions & 12 deletions guides/kfp_tekton_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Table of Contents

- [Installation Targets and Prequisites](#installation-targets-and-prequisites)
- [Installation Targets and Prerequisites](#installation-targets-and-prerequisites)
* [IBM Cloud Kubernetes Service (IKS)](#ibm-cloud-kubernetes-service-iks)
* [OpenShift](#openshift)
* [Other Cloud Providers or On-Prem Kubernetes Deployment](#other-cloud-providers-or-on-prem-kubernetes-deployment)
- [Standalone Kubeflow Pipelines with Tekton Backend Deployment](#standalone-kubeflow-pipelines-with-tekton-backend-deployment)
- [Kubeflow installation including Kubeflow Pipelines with Tekton Backend](#kubeflow-installation-including-kubeflow-pipelines-with-tekton-backend)
- [Troubleshooting](#troubleshooting)

## Installation Targets and Prequisites
## Installation Targets and Prerequisites

A Kubernetes cluster `v1.16` that has least 8 vCPU and 16 GB memory.
A Kubernetes cluster `v1.18` that has least 8 vCPU and 16 GB memory.

### IBM Cloud Kubernetes Service (IKS)

Expand All @@ -26,21 +26,24 @@ A Kubernetes cluster `v1.16` that has least 8 vCPU and 16 GB memory.
2. Install Tekton as part of deployment

### Other Cloud Providers or On-Prem Kubernetes Deployment

Visit [Kubeflow Cloud Installation](https://www.kubeflow.org/docs/started/cloud/) for setting up the preferred environment to deploy Kubeflow.

## Standalone Kubeflow Pipelines with Tekton Backend Deployment

To install the standalone Kubeflow Pipelines with Tekton, run the following steps:
1. Install [Tekton v0.16.3](https://github.com/tektoncd/pipeline/releases/tag/v0.16.3)

2. Install Kubeflow Pipelines with Tekton backend (kfp-tekton) v0.5.0 [custom resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)(CRDs).
1. Install [Tekton v0.20.1](https://github.com/tektoncd/pipeline/releases/tag/v0.20.1)

2. Install Kubeflow Pipelines with Tekton backend (`kfp-tekton`) `v0.6.0` [custom resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)(CRDs).
> Note: You can ignore the error `no matches for kind "Application" in version "app.k8s.io/v1beta1"` since it's a warning saying `application` CRD is not yet ready.
```shell
kubectl apply --selector kubeflow/crd-install=true -f install/v0.5.0/kfp-tekton.yaml
kubectl apply --selector kubeflow/crd-install=true -f install/v0.6.0/kfp-tekton.yaml
```

3. Install Kubeflow Pipelines with Tekton backend (kfp-tekton) v0.5.0 deployment
3. Install Kubeflow Pipelines with Tekton backend (`kfp-tekton`) `v0.6.0` deployment
```shell
kubectl apply -f install/v0.5.0/kfp-tekton.yaml
kubectl apply -f install/v0.6.0/kfp-tekton.yaml
```

4. Then, if you want to expose the Kubeflow Pipelines endpoint outside the cluster, run the following commands:
Expand All @@ -55,16 +58,19 @@ To install the standalone Kubeflow Pipelines with Tekton, run the following step

## Kubeflow installation including Kubeflow Pipelines with Tekton Backend

**Important: Please complete the [prequisites](#installation-targets-and-prequisites) before proceeding with the following instructions.**
**Important: Please complete the [prerequisites](#installation-targets-and-prerequisites) before proceeding with the following instructions.**

1. Follow the [Kubeflow install instructions](https://www.kubeflow.org/docs/ibm/deploy/install-kubeflow/#kubeflow-installation) to install whole Kubeflow stack with the kfp-tekton installation. Kubeflow v1.2.0 uses Tekton v0.14.0 and kfp-tekton v0.4.0.
1. Follow the [Kubeflow install instructions](https://www.kubeflow.org/docs/ibm/deploy/install-kubeflow/#kubeflow-installation)
to install the entire Kubeflow stack with `kfp-tekton`.
Kubeflow `1.2.0` uses Tekton `v0.14.0` and `kfp-tekton` `v0.4.0`. <!-- TODO update-->

1. Visit [KFP Tekton User Guide](/guides/kfp-user-guide) and start learning how to use Kubeflow pipeline.
2. Visit [KFP Tekton User Guide](/guides/kfp-user-guide) and start learning how to use Kubeflow pipeline.

1. Visit [KFP Tekton Admin Guide](/guides/kfp-admin-guide.md) for how to configure kfp-tekton with different settings.
3. Visit [KFP Tekton Admin Guide](/guides/kfp-admin-guide.md) for how to configure kfp-tekton with different settings.


## Troubleshooting

- (For IBM Cloud IKS users) If you accidentally deployed Kubeflow with IBM Cloud File Storage, run the below commands to remove the existing pvc. The below commands are for removing resources in multi-user, so you can ignore any missing pvc or rollout error if you are doing this for single user.
```shell
kubectl delete pvc -n kubeflow katib-mysql metadata-mysql minio-pv-claim minio-pvc mysql-pv-claim
Expand Down
12 changes: 6 additions & 6 deletions sdk/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ can be found in the [SDK README](/sdk/README.md)
## Development Prerequisites

1. [`Python`](https://www.python.org/downloads/): version `3.5.3` or later (new code must maintain compatibility with `3.5`)
2. [`Kubernetes` Cluster](https://kubernetes.io/): version `1.16` ([required by Kubeflow](https://www.kubeflow.org/docs/started/k8s/overview/) and Tekton 0.16)
2. [`Kubernetes` Cluster](https://kubernetes.io/): version `1.18` ([required by Kubeflow](https://www.kubeflow.org/docs/started/k8s/overview/) and Tekton `0.20`)
3. [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/): required to deploy Tekton pipelines to Kubernetes cluster
4. [`Tekton` Deployment](https://github.com/tektoncd/pipeline/releases/tag/v0.15.0/): version `0.16.3` or greater, required for end-to-end testing
4. [`Tekton` Deployment](https://github.com/tektoncd/pipeline/releases/tag/v0.16.3/): version `0.16.3` or greater, required for end-to-end testing
5. [`tkn` CLI](https://github.com/tektoncd/cli#installing-tkn): version `0.11.0` or greater, required for end-to-end testing of Tekton pipelines
6. [`Kubeflow Pipelines` Deployment](https://www.kubeflow.org/docs/pipelines/installation/overview/): required for some end-to-end tests

Expand All @@ -48,10 +48,10 @@ by the `kfp_tekton` compiler. The Tekton CLI is useful to start a pipeline and a

#### Tekton Cluster

Follow the instructions listed [here](https://github.com/tektoncd/pipeline/blob/v0.15.0/docs/install.md#installing-tekton-pipelines-on-kubernetes)
Follow the instructions listed [here](https://github.com/tektoncd/pipeline/blob/v0.20.1/docs/install.md#installing-tekton-pipelines-on-kubernetes)
or simply run:

kubectl apply -f https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.15.0/release.yaml
kubectl apply -f https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.20.1/release.yaml

**Note**, if your container runtime does not support `image-reference:tag@digest` (like cri-o used in OpenShift 4.x),
use `release.notags.yaml` instead.
Expand Down Expand Up @@ -85,7 +85,7 @@ Mac OS users can install the Tekton CLI using the `homebrew` formula:

Follow the installation instructions [here](https://github.com/tektoncd/dashboard/blob/master/docs/install.md), i.e.:

kubectl apply --filename https://github.com/tektoncd/dashboard/releases/download/v0.10.2/tekton-dashboard-release.yaml
kubectl apply --filename https://github.com/tektoncd/dashboard/releases/download/v0.13.0/tekton-dashboard-release.yaml

The Tekton Dashboard can be accessed through its `ClusterIP` service by running `kubectl proxy` or the service can
be patched to expose a public `NodePort` IP:
Expand Down Expand Up @@ -248,7 +248,7 @@ To update the ["Compiler Status Report"](/sdk/python/tests/README.md) use the ou
All source files should have the following license header. Adjust the year accordingly to reflect the year the file was
added and the last year it was modified:

# Copyright 2019-2020 kubeflow.org
# Copyright 2019-2021 kubeflow.org
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions sdk/python/kfp_tekton/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2020 kubeflow.org
# Copyright 2020-2021 kubeflow.org
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

__version__ = '0.5.0'
__version__ = '0.6.0'

from ._client import TektonClient # noqa F401
6 changes: 3 additions & 3 deletions sdk/python/setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2020 kubeflow.org
# Copyright 2020-2021 kubeflow.org
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -20,14 +20,14 @@
#
# To create a distribution for PyPi run:
#
# $ export KFP_TEKTON_VERSION=0.5.0-rc1
# $ export KFP_TEKTON_VERSION=0.6.0-rc1
# $ python3 setup.py sdist
# $ twine check dist/kfp-tekton-${KFP_TEKTON_VERSION/-rc/rc}.tar.gz
# $ twine upload --repository pypi dist/kfp-tekton-${KFP_TEKTON_VERSION/-rc/rc}.tar.gz
#
# ... or:
#
# $ make distribution KFP_TEKTON_VERSION=0.5.0-rc1
# $ make distribution KFP_TEKTON_VERSION=0.6.0-rc1
#
# =============================================================================

Expand Down

0 comments on commit d2f4328

Please sign in to comment.