Revamp profile installation instructions for MR (kubeflow#854)

* (feat): Revamp profile installation instructions for MR

Signed-off-by: lucferbux <[email protected]>

* (feat):Improve docs and remove standalone mention

Signed-off-by: lucferbux <[email protected]>

* Update manifests/kustomize/README.md

Co-authored-by: Paul Boyd <[email protected]>
Signed-off-by: Lucas Fernandez <[email protected]>

* Change layout of manifest

Signed-off-by: lucferbux <[email protected]>

---------

Signed-off-by: lucferbux <[email protected]>
Signed-off-by: Lucas Fernandez <[email protected]>
Co-authored-by: Paul Boyd <[email protected]>

Author: lucferbux

manifests/kustomize/README.md

@@ -2,61 +2,44 @@
 
 This folder contains [Kubeflow Model Registry](https://www.kubeflow.org/docs/components/model-registry/installation/) Kustomize manifests
 
-## Installation
+## Overview
 
-To install Kubeflow Model Registry, follow [Kubeflow Model Registry deployment documentation](https://www.kubeflow.org/docs/components/model-registry/installation/)
+This is the full installation guide, for a quick install in an existing Kubeflow installation, follow [these instructions](https://www.kubeflow.org/docs/components/model-registry/installation/).
+**Ensure you are running all these commands from the directory containing this README.md file (e.g.: you could check with `pwd`).**
 
-The following instructions will summarize how to deploy Model Registry as separate component in the context of a default Kubeflow >=1.9 installation.
-Ensure you are running these commands from the directory containing this README.md file (e.g.: you could check with `pwd`).
+## Kubeflow Central Dashboard Installation
 
-```bash
-kubectl apply -k overlays/db
-```
+These instructions assume that you've installed Kubeflow from the [manifests](https://github.com/kubeflow/manifests/), if you're using a distribution consult its documentation instead.
 
-As the default Kubeflow installation provides an Istio mesh, apply the necessary manifests:
+Kubeflow Central Dashboard uses [Profiles](https://www.kubeflow.org/docs/components/central-dash/profiles/) to handle user namespaces and permissions. By default, the manifests deploy the Model Registry instance in the `kubeflow` namespace, to install a compatible version of Model Registry for Kubeflow, you should deploy a separate instance of Model Registry in the profile's namespace. For that just run:
 
-```bash
-kubectl apply -k options/istio
+```sh
+PROFILE_NAME=<your-profile>
+for DIR in options/istio overlays/db ; do (cd $DIR; kustomize edit set namespace $PROFILE_NAME; kubectl apply -k .); done
 ```
 
-Check everything is up and running:
-
-```bash
-kubectl wait --for=condition=available -n kubeflow deployment/model-registry-deployment --timeout=2m
-kubectl logs -n kubeflow deployment/model-registry-deployment
-```
+> **⚠️ Warning:** If you're not sure of the profile name, you can find it in the name space drop-down on the Kubeflow Dashboard.
 
-Optionally, you can also port-forward the REST API container port of Model Registry to interact with it from your terminal:
+Check everything is up and running:
 
 ```bash
-kubectl port-forward svc/model-registry-service -n kubeflow 8081:8080
+kubectl wait --for=condition=available-n ${PROFILE_NAME} deployment/model-registry-deployment --timeout=2m
+kubectl logs -n ${PROFILE_NAME} deployment/model-registry-deployment
 ```
 
-And then, from another terminal:
+Now, to install the Model Registry UI as a Kubeflow component, you need first to deploy the Model Registry UI:
 
 ```bash
-curl -sX 'GET' \
-  'http://localhost:8081/api/model_registry/v1alpha3/registered_models?pageSize=100&orderBy=ID&sortOrder=DESC' \
-  -H 'accept: application/json' | jq
+kubectl apply -k options/ui/overlays/istio -n kubeflow
 ```
 
-### 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 (**Note: You will need a custom standalone image**)
-
-2. Integrated mode - Use this if you are deploying Model Registry in Kubeflow 
-
-For a standalone install, we recommend following the [Model Registry UI standalone deployment documentation](../../clients/ui/docs/local-deployment-guide-ui.md).
-
-For an integrated install use the kubeflow UI overlay:
+And then to make it accessible through Kubeflow Central Dashboard, you need to edit the `centraldashboard-config` ConfigMap to add the Model Registry UI link to the Central Dashboard by running the following command:
 
 ```bash
-kubectl apply -k options/ui/overlays/istio -n kubeflow
+kubectl get configmap centraldashboard-config -n kubeflow -o json | jq '.data.links |= (fromjson | .menuLinks += [{"icon": "assignment", "link": "/model-registry/", "text": "Model Registry", "type": "item"}] | tojson)' | kubectl apply -f - -n kubeflow
 ```
 
-To make Model Registry UI accessible from the Kubeflow UI, you need to add the following to your Kubeflow UI configmap:
+Alternatively, you can edit the ConfigMap manually by running:
 
 ```bash
 kubectl edit configmap -n kubeflow centraldashboard-config
@@ -77,17 +60,62 @@ data:
             ...
 ```
 
-Or you can add it in one line with:
+Now you should be able to see the Model Registry UI in the Kubeflow Central Dashboard, and access to the Model Registry deployment in the profile namespace.
+
+### Uninstall
+
+To uninstall the Kubeflow Model Registry run:
 
 ```bash
-kubectl get configmap centraldashboard-config -n kubeflow -o json | jq '.data.links |= (fromjson | .menuLinks += [{"icon": "assignment", "link": "/model-registry/", "text": "Model Registry", "type": "item"}] | tojson)' | kubectl apply -f - -n kubeflow
-````
+# Uninstall Model Registry Instance
+PROFILE_NAME=<your-profile>
+for DIR in options/istio overlays/db ; do (cd $DIR; kustomize edit set namespace $PROFILE_NAME; kubectl delete -k .); done
+
+# Uninstall Model Registry UI
+kubectl delete -k options/ui/overlays/istio -n kubeflow
+```
+
+
+## Model Registry as a separate component Installation
+
+The following instructions will summarize how to deploy Model Registry as separate component in the context of a default Kubeflow >=1.9 installation.
+
+```bash
+kubectl apply -k overlays/db
+```
+
+As the default Kubeflow installation provides an Istio mesh, apply the necessary manifests:
+
+```bash
+kubectl apply -k options/istio
+```
+
+Check everything is up and running:
+
+```bash
+kubectl wait --for=condition=available -n kubeflow deployment/model-registry-deployment --timeout=2m
+kubectl logs -n kubeflow deployment/model-registry-deployment
+```
+
+Optionally, you can also port-forward the REST API container port of Model Registry to interact with it from your terminal:
+
+```bash
+kubectl port-forward svc/model-registry-service -n kubeflow 8081:8080
+```
+
+And then, from another terminal:
+
+```bash
+curl -sX 'GET' \
+  'http://localhost:8081/api/model_registry/v1alpha3/registered_models?pageSize=100&orderBy=ID&sortOrder=DESC' \
+  -H 'accept: application/json' | jq
+```
 
-## Usage
+### 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/)
 
-## Uninstall
+### Uninstall
 
 To uninstall the Kubeflow Model Registry run: