Installing Kubeflow

Overview of installation choices for various environments

This document provides information about setting up Kubeflow in variousenvironments.

Before you begin

It’s important that you have some knowledge of the following systems and tools:

If you plan to deploy Kubeflow on an existing Kubernetes cluster, review theseKubernetes system requirements.

Overview of installation options

The following diagram gives an overview of the options for deploying Kubeflow:

The following section describes the options in more detail and links to therelevant instructions.

Installing Kubeflow

There are various ways to install Kubeflow. Choose one of the following optionsto suit your environment (public cloud, existing Kubernetes cluster, ora single-node cluster which you can use on a desktop or server or in the cloud).

Installing Kubeflow on a public cloud

Choose the Kubeflow deployment guide for your chosen cloud:

Installing Kubeflow on an existing Kubernetes cluster

Follow theguide to deploying Kubeflow on Kubernetes.

Installing Kubeflow on desktop, server, or cloud in a single-node Kubernetes cluster

You can use the following options to run Kubeflow on a single-node Kubernetescluster, which you can use on a desktop or server or in the cloud.

Choose the guide for your operating system or environment:

Configuration quick reference

Below is a matrix of the platforms where you can deploy Kubeflow and thecorresponding manifest files that specify the default configuration for eachplatform. The matrix shows the same manifests as the installation guides.The matrix is therefore an alternative way of accessing the information in theinstallation section above.

Deployment platformManifestDeployment guide
Existing Kubernetes cluster using a standard Kubeflow installationkfctl_k8s_istio.v1.0.0.yamlDocs
Existing Kubernetes cluster using Dex for authenticationkfctl_istio_dex.v1.0.0.yamlDocs
Amazon Web Services (AWS) using the standard setupkfctl_aws.v1.0.0.yamlDocs
Amazon Web Services (AWS) with authenticationkfctl_aws_cognito.v1.0.0.yamlDocs
Microsoft Azurekfctl_k8s_istio.v1.0.0.yamlDocs
Google Cloud Platform (GCP) with Cloud Identity-Aware Proxy (Cloud IAP)kfctl_gcp_iap.v1.0.0.yamlDocs
IBM Cloud (IKS)kfctl_k8s_istio.v1.0.0.yamlDocs
OpenShiftkfctl_openshift.yamlDocs

Installing command line tools

The following information is useful if you need or prefer to use command linetools for deploying and managing Kubeflow:

  • Download the kfctl binary from theKubeflow releases page.

  • Follow the kubectl installation and setup instructions from the Kubernetesdocumentation.As described in the Kubernetes documentation, your kubectlversion must be within one minor version of the Kubernetes version that youuse in your Kubeflow cluster.

  • Follow the kustomize installation and setup instructions from the guide tokustomize in Kubeflow.

Understanding the Kubeflow versioning policies

With the launch of Kubeflow v1.0, the Kubeflow community attributesstable status to those applications and other components thatmeet the required level of stability, supportability, and upgradability.

Read about theKubeflow versioning policies,including the stable status of Kubeflow applications and deploymentplatforms.

Troubleshooting

See the Kubeflow troubleshooting guide.

Next steps

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified 25.02.2020: Replace with kfctl_istio_dex and doc improvements for the config (#1707) (c35a1070)