Pipelines Standalone Deployment

Instructions to deploy Kubeflow Pipelines standalone to a cluster

As an alternative to deploying Kubeflow as awhole with many components including pipelines, you also have a choice to deployonly Kubeflow Pipelines. Follow the instructions below to deployKubeflow Pipelines standalone using the supplied kustomizemanifests.

Knowledge about Kubernetes, kubectl and kustomize will help you understand thisdocument better and be able to customize your deployment based on your needs.

Installation outside GCP is also available

This guide currently describes how to install Kubeflow Pipelines standalone on Google Cloud Platform (GCP). You can also install Kubeflow Pipelines on otherplatforms. This guide needs updating. Seeissue #1253.

Common prerequisites

These are common one time setups you need for all the instructions below:

Download kubectl CLI tool

Follow the kubectl installation guide.

You need kubectl version 1.14 or later, for native support of kustomize.

Configure kubectl to talk to your cluster

See the Google Kubernetes Engine (GKE) guide to configuring cluster access for kubectl.

Deploying Kubeflow Pipelines standalone to an existing cluster

• Deploy the latest version of Kubeflow Pipelines:

export PIPELINE_VERSION=0.2.0
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/base/crds?ref=$PIPELINE_VERSION
kubectl wait --for condition=established --timeout=60s crd/applications.app.k8s.io
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

Note: The above approach is introduced in Kubeflow Pipelines version 0.2.0. For older versions please run the following instead:

export PIPELINE_VERSION=0.2.0
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

• Get the URL for the Kubeflow Pipelines UI :

kubectl describe configmap inverse-proxy-config -n kubeflow | grep googleusercontent.com

Deploying Kubeflow Pipelines standalone from scratch

• Prepare a Kubernetes cluster:

See the GKE guide to creating a cluster for Google Cloud Platform (GCP).

Use the following gcloud command to create a cluster that can run all pipeline samples:

# The following parameters can be customized based on your needs.
CLUSTER_NAME="kubeflow-pipelines-standalone"
ZONE="us-central1-a"
MACHINE_TYPE="n1-standard-2" # A machine with 2 CPUs and 7.50GB memory
SCOPES="storage-rw,cloud-platform" # These scopes are needed for running some pipeline samples.
gcloud container clusters create $CLUSTER_NAME \
    --zone $ZONE \
    --machine-type $MACHINE_TYPE \
    --scopes $SCOPES \
    --num-nodes 2 \
    --max-nodes 5 \
    --min-nodes 2 \
    --enable-autoscaling

WARNING: Using SCOPES="storage-rw,cloud-platform" overgrants all GCP permissions to the cluster, so it’s convenient to use. For a more secure cluster setup, refer to Authenticating Pipelines to GCP.

Reference:

• You can find available zones in https://cloud.google.com/compute/docs/regions-zones/#available.
• Get gcloud CLI tool at https://cloud.google.com/sdk/gcloud/.
• Read gcloud container clusters create command documentation at https://cloud.google.com/sdk/gcloud/reference/container/clusters/create.
  • Configure kubectl to talk to your newly created cluster. Refer to Configuring cluster access for kubectl.

• Deploy the latest version of Kubeflow Pipelines standalone to your cluster:

export PIPELINE_VERSION=0.2.0
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/base/crds?ref=$PIPELINE_VERSION
kubectl wait --for condition=established --timeout=60s crd/applications.app.k8s.io
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

Kubeflow Pipelines applications take a while (~3 minutes) to start.

Note: The above approach is introduced in Kubeflow Pipelines version 0.2.0. For older versions please run the following instead:

export PIPELINE_VERSION=0.2.0
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

• Get public URL of Pipelines UI and use it to access Kubeflow Pipelines:

kubectl describe configmap inverse-proxy-config -n kubeflow | grep googleusercontent.com

Upgrade

• Configure kubectl to talk to your cluster. Refer to Configuring cluster access for kubectl.
• Upgrade to a version of Kubeflow Pipelines standalone you choose:

export PIPELINE_VERSION=<version-you-want-to-upgrade-to>
kubectl apply -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

Check Kubeflow Pipelines github repo for available releases.

Customization

Customization can be done through kustomize overlays.

Note - The instruction below assume you installed kubectl v1.14.0 or later, which has native support of kustomize.To get latest kubectl, visit here

For the following instructions, first clone Kubeflow Pipelines repo,and use it as working directory.

Deploy on GCP with CloudSQL and Google Cloud Storage

This is recommended for production environments. Seehere for more details.

Change deployment namespace

To deploy Kubeflow Pipelines standalone in namespace FOO:

• Edit dev/kustomization.yamlor gcp/kustomization.yamlnamespace section to FOO.
• Then run

kubectl apply -k manifests/kustomize/env/dev
# Or the following if using GCP Cloud SQL + Google Cloud Storage
# kubectl apply -k manifests/kustomize/env/gcp

Disable the public endpoint

By default, the deployment installs an inverting proxy agent that exposes a public URL. If you want to skip installing it,

• Comment out the proxy component in the kustomization.yaml.
• Then run:

kubectl apply -k manifests/kustomize/env/dev
# Or the following if using GCP Cloud SQL + Google Cloud Storage
# kubectl apply -k manifests/kustomize/env/gcp

The UI is still accessible by port-forwarding:

kubectl port-forward -n kubeflow svc/ml-pipeline-ui 8080:80

and open http://localhost:8080/.

Uninstall

You can uninstall Kubeflow Pipelines by:

• Configure kubectl to talk to your cluster. Refer to Configuring cluster access for kubectl.

• Uninstall Pipelines:

export PIPELINE_VERSION=0.2.0
kubectl delete -k github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=$PIPELINE_VERSION

Or if you deployed through kustomize:

kubectl delete -k manifests/kustomize/env/dev
# Or the following if using GCP Cloud SQL + Google Cloud Storage
# kubectl delete -k manifests/kustomize/env/gcp

Best practices maintaining custom manifests

Maintain a repo for your manifests

Save the following to a source controlled repo.

File kustomization.yaml.

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
# Edit the following to change the deployment to your custom namespace.
namespace: kubeflow
# You can add other customizations here using kustomize.
# Edit ref in the following link to deploy a different version of Kubeflow Pipelines.
bases:
- github.com/kubeflow/pipelines//manifests/kustomize/env/dev?ref=0.2.0

How to deploy, upgrade and uninstall using the repo

Deploy: kubectl apply -k $YOUR_REPO

Upgrade:

• (Recommended) Back up your data storages for KFP.
• Edit ref=0.2.0 to a version you want to upgrade to.

Check [Kubeflow Pipelines github repo](https://github.com/kubeflow/pipelines/releases) for available releases.

• Deploy: kubectl apply -k $YOUR_REPO.

Uninstall: kubectl delete -k $YOUR_REPO.

Further reading

• kustomize’s recommended workflow using an off-the-shelf configuration.

Troubleshooting

Permission error installing Kubeflow Pipelines standalone to a cluster

Run:

kubectl create clusterrolebinding your-binding --clusterrole=cluster-admin --user=[your-user-name]