canonical / katib-rocks

ROCKs for Kubeflow Katib

katib-rocks

ROCKs for Kubeflow Katib

katib-rocks's Issues

katib-rocks: Update `push` and `pull_request` CI

Context

canonical/bundle-kubeflow#797

What needs to get done

Update on_push.yaml and pull_request.yaml according to example.

Definition of Done

Workflows are updated

`katib-ui-rock` is based on wrong Dockerfile

It turns out we have ROCKed the wrong dockerfile for katib-ui-rock.

The katib-ui component we 've charmed is the until recently (release 0.15) called new-ui component in the upstream. We can see this in the way they produced images. Looking at the0.15 release branch, this is the dockerfile we rocked while the image we use in our charm comes from this one. With release 0.16, they removed the old ui and thus renamed previous new-ui component to ui.

Summarizing, we need to update the ROCK to be based on this dockerfile (ui from release 0.16-rc.1).

Create `rockraft.yaml` file for `suggestion-goptuna:v0.15.0`

What needs to get done

Create a rockraft.yaml file for suggestion-goptuna:v0.15.0 upstream image. This image is currently missing for the CKF 1.7 release.

Why it needs to get done

To then move closer towards

1. Having built all rocks for Katib, for CKF 1.7
2. Integrating the Katib ROCKs, for CKF 1.7

Create `rockraft.yaml` file for `suggestion-darts:v0.15.0`

What needs to get done

Create a rockraft.yaml file for suggestion-darts:v0.15.0 upstream image. This image is currently missing for the CKF 1.7 release.

Why it needs to get done

To then move closer towards

1. Having built all rocks for Katib, for CKF 1.7
2. Integrating the Katib ROCKs, for CKF 1.7

Add workflows to katib-rocks repository

Description

Workflows are needed to ensure proper validation of changes to ROCK images.

Add workflows to https://github.com/canonical/katib-rocks

• on pull request execute ROCKs unit tests
• on pull requests execute ROCKs integration tests ?????
• publish workflow

Verify build and scan workflow works for all ROCKs (disk space issue is resolved)

Update Katib ROCKs to `0.16-rc.1` for CKF release 1.8

This issue tracks the process of updating Katib ROCKs to Katib's 0.16 for CKF release 1.8. For the process, we 're following our internal Kubeflow ROCK Images Best Practices that has a section about Upgrade of ROCK Images.

The changes that this process will introduce should match what the upstream has for version v0.16-rc.1.

cert-generator ROCK needs update

Description

Cert-generator ROCK needs update:
https://github.com/canonical/katib-rocks/tree/main/cert-generator

This ROCK was completed prior to finalizing best practices and some rockcraft features. It should be updated.
In particular:

• Non-root user should be implemented.
• Security team requirements part should be added.

Katib ROCKs

Description

Katib ROCKs are part of main epic for building secure images using ROCKs.
This issue is created to summarize details on ROCK design and track progress on ROCK creation for Katib.

Dockerfiles for Katib images:
https://github.com/kubeflow/katib/tree/master/cmd

Some sample work has been completed:
Python sample ROCK
Go sample ROCK

Remaining ROCKs:
Python based:
katib/cmd/suggestion/hyperband/v1beta1
katib/cmd/suggestion/pbt/v1beta1
katib/cmd/suggestion/skopt/v1beta1
katib/cmd/suggestion/optuna/v1beta1
katib/cmd/suggestion/nas/darts/v1beta1
katib/cmd/suggestion/nas/enas/v1beta1

Go based:
katib/cmd/suggestion/goptuna/v1beta1
katib/cmd/cert-generator/v1beta1 (#19)

When building ROCKs best practices should be followed.

Progress: Katib ROCKs

Completed ROCKs should be checked and corresponding PR should be indicated.

• kubeflowkatib/katib-controller #11
• kubeflowkatib/katib-db-manager #15
• kubeflowkatib/katib-ui #18
• katib/cmd/earlystopping/medianstop/v1beta1 #12
• katib/cmd/metricscollector/v1beta1/tfevent-metricscollector #13
• katib/cmd/metricscollector/v1beta1/file-metricscollector #14
• katib/cmd/suggestion/hyperopt/v1beta1 #16
• katib/cmd/suggestion/hyperband/v1beta1 #22
• katib/cmd/suggestion/pbt/v1beta1 #24
• katib/cmd/suggestion/goptuna/v1beta1 #27
• katib/cmd/suggestion/skopt/v1beta1 #21
• katib/cmd/suggestion/optuna/v1beta1 #20
• katib/cmd/suggestion/chocolate/v1beta1 NOT SUPPORTED in v0.15.0
• katib/cmd/suggestion/nas/darts/v1beta1 #25
• katib/cmd/suggestion/nas/enas/v1beta1 #26
• katib/cmd/cert-generator/v1beta1 #23 (Needs update https://github.com/canonical/katib-rocks/tree/main/cert-generator)

Not supported Katib images

The following images will not be converted to ROCKs, because those are used as simple examples and will not be used by end-users in production:

• kubeflowkatib/darts-cnn-cifar10-cpu
• kubeflowkatib/enas-cnn-cifar10-cpu
• kubeflowkatib/mxnet-mnist
• kubeflowkatib/pytorch-mnist-cpu
• kubeflowkatib/simple-pbt