Skip to content

Commit

Permalink
Moving UI Manifests to root manifests directory (#731)
Browse files Browse the repository at this point in the history
Signed-off-by: Griffin-Sullivan <[email protected]>
  • Loading branch information
Griffin-Sullivan authored Jan 28, 2025
1 parent 8498a22 commit 2eb66b4
Show file tree
Hide file tree
Showing 18 changed files with 32 additions and 13 deletions.
17 changes: 10 additions & 7 deletions clients/ui/docs/local-deployment-guide-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,18 @@ kubectl create namespace kubeflow

### 3. Deploy Model Registry UI to cluster

You can now deploy the UI and BFF to your newly created cluster using the kustomize configs in this directory:

You can now deploy the UI and BFF to your newly created cluster using the kustomize configs in the root manifest directory:
```shell
cd clients/ui

kubectl apply -k manifests/overlay/standalone -n kubeflow
cd manifests/kustomize/options/ui/overlays/standalone
```
```shell
kustomize edit set namespace kubeflow
```
```shell
kubectl apply -k .
```

After a few seconds you should see 2 pods running (1 for BFF and 1 for UI):
After a few seconds you should see 1 pod running:

```shell
kubectl get pods -n kubeflow
Expand Down Expand Up @@ -95,5 +98,5 @@ To fix this, you'll need to increase the amount of memory available to the VM. T
Alternatively, if you'd like to run the UI and BFF pods with an Istio configuration for the KF Central Dashboard, you can apply the manifests by running:

```shell
kubectl apply -k overlays/istio -n kubeflow
kubectl apply -k manifests/kustomize/options/ui/overlays/istio -n kubeflow
```
8 changes: 2 additions & 6 deletions clients/ui/scripts/deploy_kind_cluster.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ command -v docker >/dev/null 2>&1 || { echo >&2 "Docker is required but it's not
command -v kubectl >/dev/null 2>&1 || { echo >&2 "kubectl is required but it's not installed. Aborting."; exit 1; }
command -v kind >/dev/null 2>&1 || { echo >&2 "kind is required but it's not installed. Aborting."; exit 1; }

# Check if the script has rights to push an image into the registry
if ! docker push "${IMG_UI_STANDALONE}" >/dev/null 2>&1; then
echo -e "\033[31mError: No rights to push the image to the registry ${IMG_UI_STANDALONE}, you can change the image in the env variable IMG_UI_STANDALONE\033[0m"
exit 1
fi
echo "WARNING: You must have proper push / pull access to ${IMG_UI_STANDALONE}". If this is a new image, make sure you set it to public to avoid issues.

if kubectl get deployment model-registry-deployment -n kubeflow >/dev/null 2>&1; then
echo "Model Registry deployment already exists. Skipping to step 4."
Expand Down Expand Up @@ -45,7 +41,7 @@ make docker-build-standalone
make docker-push-standalone

echo "Editing kustomize image..."
pushd ./manifests/base
pushd ../../manifests/kustomize/options/ui/base
kustomize edit set image model-registry-ui-image=${IMG_UI_STANDALONE}

pushd ../overlays/standalone
Expand Down
20 changes: 20 additions & 0 deletions manifests/kustomize/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,26 @@ curl -sX 'GET' \
-H 'accept: application/json' | jq
```

### UI Installation

There are two main ways to deploy the Model Registry UI:

1. Standalone mode - Use this if you are using Model Registry without the Kubeflow Platform

2. Integrated mode - Use this if you are deploying Model Registry in Kubeflow

For a standalone install run the following command:

```bash
kubectl apply -k options/ui/overlays/standalone -n kubeflow
```

For an integrated install use the istio UI overlay:

```bash
kubectl apply -k options/ui/overlays/istio -n kubeflow
```

## Usage

For a basic usage of the Kubeflow Model Registry, follow the [Kubeflow Model Registry getting started documentation](https://www.kubeflow.org/docs/components/model-registry/getting-started/)
Expand Down

0 comments on commit 2eb66b4

Please sign in to comment.