Katib Operators

Overview

This bundle encompasses the Kubernetes python operators (a.k.a. charms) for Katib (see CharmHub).

The Katib operators are python scripts that wrap the latest released Katib manifests, providing lifecycle management for each application, handling events (install, upgrade, integrate, remove).

Install the Katib operators on your K8s cluster

1. Install the Juju OLM

snap install juju --classic

Alternatively, you can brew install juju on macOS or download the Juju installer for Windows.

2. Point Juju to your Kubernetes cluster

juju add-k8s myk8scloud --cluster=foo --kubeconfig=path/to/config 

If you are on ASK, EKS, or GKE, append --aks, --eks, or --gke.

For more, see Juju docs.

3. Create a Juju controller and bootstrap to your cluster

juju bootstrap myk8scloud my-controller

further reading on this step can be found in the juju docs.

4. Create a Juju model

A Juju model is a blank canvas where your charm operators will be deployed. While creating a model, you can specify a name, e.g. kf, and your applications will be deployed into a Kubernetes namespace with the name you define at this point.

Create a Juju model with the command:

juju add-model kf

5. Deploy the Katib bundle

To install Katib, run:

juju deploy katib

You can also install each application individually, like this:

juju deploy <application>

where <application> is one of katib-controller, katib-ui, or katib-db-manager.

Note: As a default, when you juju deploy an application or the full Katib bundle, you will deploy the latest pushed commit of Katib, even if unreleased updates are already available in the Kubeflow manifests. If you would like to try the latest available charm run:

juju deploy foo --channel=edge

6. (optional) Relate the Katib bundle with your Kubeflow

If you aim to use Katib within an existing Kubeflow deployment in order to use it within the Kubeflow dashboard, you will have to integrate katib-ui to istio-pilot with the following command:

juju relate istio-pilot katib-ui

Setting Custom Images for Katib Controller

Katib controller comes with a set of preconfigured images that are used in Katib workloads. See charms/katib-controller/src/default-custom-images.json for the list of default images.

These images can be overridden through the charm configuration custom_images, which accepts a JSON dict of {image_name: image} to override, for example:

juju config katib-controller custom_images='{"default_trial_template": "custom:1.0", "early_stopping__medianstop": "cuustom:2.1"}'

Any image that is omitted from custom_images or that has an empty string for an image name will use the upstream default for that image.