Katib Installation Options

Katib offers a few installation options to install control plane. This page describes the options and the features available with each option. Check the installation guide to understand the Katib control plane components.

The Default Katib Standalone Installation

Follow the installation guide to install the default version of Katib control plane.

Katib with Controller Leader Election

Run the following command to deploy Katib with Controller Leader Election support:

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

This installation is almost the same as Katib Standalone installation, although you can make katib-controller Highly Available (HA) using leader election. If you plan to use Katib in an environment where high Service Level Agreements (SLAs) and Service Level Objectives (SLOs) are required, such as a production environment, consider choosing this installation.

Katib with PostgreSQL Database

Run the following command to deploy Katib with PostgreSQL database (DB) instead of MySQL:

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

Katib with External DB

Run the following command to deploy Katib with custom DB backend:

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

This installation allows to use custom instance of MySQL DB instead katib-mysql. You have to modify the appropriate environment variables for katib-db-manager in the secrets.env with your MySQL DB values.

Katib with Cert Manager

Run the following command to deploy Katib with Cert Manager requirement:

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

This installation uses Cert Manager instead of Katib certificate generator to provision Katib webhooks certificates. You have to deploy Cert Manager on your Kubernetes cluster before deploying Katib using this installation.

Katib on OpenShift

Run the following command to deploy Katib on OpenShift v4.4+:

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

This installation uses OpenShift service controller instead of Katib certificate generator to provision Katib webhooks certificates.

Next Steps

• How to set up environment variables for various Katib component.