Install Kubeflow

    This guide describes how to use the kfctl binary todeploy Kubeflow on Azure.

    • Install kubectl
    • Install and configure the
      • Log in with
    • (Optional) Install Docker
      • For Windows and WSL: Guide
      • For other OS:

    You do not need to have an existing Azure Resource Group or Cluster for AKS (Azure Kubernetes Service). You can create a cluster in the deployment process.

    Understanding the deployment process

    The deployment process is controlled by the following commands:

    • build - (Optional) Creates configuration files defining the variousresources in your deployment. You only need to run kfctl build if you wantto edit the resources before running kfctl apply.
    • apply - Creates or updates the resources.
    • delete - Deletes the resources.

    Your Kubeflow application directory ${KF_DIR} contains the following files anddirectories:

    • ${CONFIG_FILE} is a YAML file that defines configurations related to yourKubeflow deployment.

      • This file is a copy of the GitHub-based configuration YAML file thatyou used when deploying Kubeflow. For example, .

    • kustomize is a directory that contains the kustomize packages for Kubeflow applications.

      • The directory is created when you run kfctl build or kfctl apply.
      • You can customize the Kubernetes resources (modify the manifests and run kfctl apply again).

    If you experience any issues running these scripts, see the troubleshooting guidance for more information.

    Create a resource group:

    1. az group create -n <RESOURCE_GROUP_NAME> -l <LOCATION>
    • RESOURCE_GROUP_NAME=KubeTest
    • LOCATION=westus

    Create a specifically defined cluster:

    1. az aks create -g <RESOURCE_GROUP_NAME> -n <NAME> -s <AGENT_SIZE> -c <AGENT_COUNT> -l <LOCATION> --generate-ssh-keys

    Example variables:

    • NAME=KubeTestCluster
    • AGENT_SIZE=Standard_D4_v3
    • AGENT_COUNT=2
    • Use the same resource group and name from the previous step

    NOTE: If you are using a GPU based AKS cluster (For example: AGENT_SIZE=Standard_NC6), you also need to on the cluster nodes before you can use GPUs with Kubeflow.

    Kubeflow installation

    Run the following commands to set up and deploy Kubeflow.

    • Create user credentials. You only need to run this command once.

    • Download the kfctl v1.0 release from the.

    • Unpack the tar ball

    1. tar -xvf kfctl_v1.0_<platform>.tar.gz
    • Run the following commands to set up and deploy Kubeflow. The code below includes an optional command to add the binary kfctl to your path. If you don’t add the binary to your path, you must use the full path to the kfctl binary each time you run it.
    1. # The following command is optional, to make kfctl binary easier to use.
    4. # Set KF_NAME to the name of your Kubeflow deployment. This also becomes the
    5. # For example, your deployment name can be 'my-kubeflow' or 'kf-test'.
    6. export KF_NAME=<your choice of name for the Kubeflow deployment>
    8. # Set the path to the base directory where you want to store one or more 
    9. # Kubeflow deployments. For example, /opt/.
    10. # Then set the Kubeflow application directory for this deployment.
    11. export BASE_DIR=<path to a base directory>
    12. export KF_DIR=${BASE_DIR}/${KF_NAME}
    15. export CONFIG_URI="https://raw.githubusercontent.com/kubeflow/manifests/v1.0-branch/kfdef/kfctl_k8s_istio.v1.0.0.yaml"
    17. # Generate and deploy Kubeflow:
    18. mkdir -p ${KF_DIR}
    19. cd ${KF_DIR}
    20. kfctl apply -V -f ${CONFIG_URI}

    • ${KF_NAME} - The name of your Kubeflow deployment.If you want a custom deployment name, specify that name here.For example, my-kubeflow or kf-test.The value of KF_NAME must consist of lower case alphanumeric characters or‘-’, and must start and end with an alphanumeric character.The value of this variable cannot be greater than 25 characters. It mustcontain just a name, not a directory path.This value also becomes the name of the directory where your Kubeflowconfigurations are stored, that is, the Kubeflow application directory.

    • ${KF_DIR} - The full path to your Kubeflow application directory.

    • Check the resources deployed correctly in namespace kubeflow
    • Open Kubeflow Dashboard

      In case you want to expose the Kubeflow Dashboard over an external IP, you can change the type of the ingress gateway. To do that, you can edit the service:

      1.     kubectl edit -n istio-system svc/istio-ingressgateway

      From that file, replace type: NodePort with and save.

      While the change is being applied, you can watch the service until below command prints a value under the EXTERNAL-IP column:

      The external IP should be accessible by visiting http://. Note that above installation instructions do not create any protection for the external endpoint so it will be accessible to anyone without any authentication. You can read more about authentication from Access Control for Azure Deployment.

      You can find general information about Kubeflow configuration in the guide to .

      Feedback

      Was this page helpful?

      Glad to hear it! Please .

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