Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Juju install commands to operators README #1411

Merged
merged 1 commit into from
Dec 15, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,37 @@ integrate, remove).

[manifests]: https://github.com/kubeflow/katib/tree/master/manifests

## Install
## Install the Katib operators on your K8s cluster

### Install applications
### 1. Install the Juju OLM

snap install juju --classic

Alternatively, you can `brew install juju` on macOS or download the [Juju installer for Windows](https://launchpad.net/juju/2.8/2.8.5/+download/juju-setup-2.8.5-signed.exe).

### 2. Point Juju to your Kubernetes cluster

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

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

For more, see [Juju docs](https://juju.is/docs/clouds).

### 3. Create a Juju controller and boostrap to your cluster

juju bootstrap myk8scloud my-controller

further reading on this step can be found in the [juju docs](https://juju.is/docs/creating-a-controller).

### 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:

Expand All @@ -24,7 +52,7 @@ You can also install each application individually, like this:

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
**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:
Expand Down