Installation

This guide describes how to install Katib on your Kubernetes cluster.

Prerequisites

These are minimal requirements to install Katib.

• Kubernetes >= 1.27
• kubectl >= 1.27
• Python >= 3.7

Installing Katib

You need to install Katib control plane and Python SDK to create Katib Experiments.

Installing Control Plane

You can skip these steps if you have already installed Kubeflow platform using manifests or package distributions. Kubeflow platform includes Katib.

You can install Katib as a standalone component.

Run the following command to install the stable release of Katib control plane: v0.17.0

kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=v0.17.0"

Run the following command to install the latest changes of Katib control plane:

kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=master"

After installing it, you can verify that all Katib control plane components are running:

$ kubectl get pods -n kubeflow

NAME                                READY   STATUS      RESTARTS   AGE
katib-controller-566595bdd8-8w7sx   1/1     Running     0          82s
katib-db-manager-57cd769cdb-vt7zs   1/1     Running     0          82s
katib-mysql-7894994f88-djp7m        1/1     Running     0          81s
katib-ui-5767cfccdc-v9fcs           1/1     Running     0          80s

Note. Your Kubernetes cluster must have StorageClass for dynamic volume provisioning for Katib DB. For more information, check the Kubernetes documentation on dynamic provisioning. If your cluster doesn’t have dynamic volume provisioning, you must manually deploy PersistentVolume (PV) to bind PVC for the Katib DB component.

Installing Python SDK

Katib implements Python SDK to simplify creation of Katib Experiments for Data Scientists.

Run the following command to install the latest stable release of Katib SDK:

pip install -U kubeflow-katib

Run the following command to install the latest changes of Katib SDK:

pip install git+https://github.com/kubeflow/katib.git@master#subdirectory=sdk/python/v1beta1

Otherwise, you can also install the Katib SDK using the specific GitHub commit, for example:

pip install git+https://github.com/kubeflow/katib.git@ea46a7f2b73b2d316b6b7619f99eb440ede1909b#subdirectory=sdk/python/v1beta1

Next steps

• Run your first Katib Experiment by following the Getting Started guide.

• Learn about various options to install Katib control plane components.