Skip to content

Commit 2c02b39

Browse files
authored
updating startup documentation (kubeflow#1461)
* updated docs Signed-off-by: Jill R. Pelavin <jpelavin@redhat.com> * cleaning up docs Signed-off-by: Jill R. Pelavin <jpelavin@redhat.com> * changing name of temp variable for consistency (review feedback) Signed-off-by: Jill R. Pelavin <jpelavin@redhat.com> --------- Signed-off-by: Jill R. Pelavin <jpelavin@redhat.com>
1 parent 1b165c1 commit 2c02b39

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

clients/ui/docs/local-deployment-guide-ui.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,15 @@ You can now deploy the UI and BFF to your newly created cluster using the kustom
4242
First you need to set up your new image
4343

4444
```shell
45+
export IMG_UI_STANDALONE="<img url that was set above>"
4546
cd manifests/kustomize/options/ui/base
46-
kustomize edit set image model-registry-ui=${IMG_UI_STANDALONE}
47+
kustomize edit set image model-registry-ui=$IMG_UI_STANDALONE}
4748
```
4849

4950
Now you can set the namespace to kubeflow and apply the manifests:
5051

5152
```shell
52-
cd manifests/kustomize/options/ui/overlays/standalone
53+
cd ../overlays/standalone
5354
kustomize edit set namespace kubeflow
5455
kubectl apply -k .
5556
```

clients/ui/docs/local-deployment-guide.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,19 @@ Kubernetes control plane is running at https://127.0.0.1:58635
3838
CoreDNS is running at https://127.0.0.1:58635/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
3939
```
4040

41-
#### 2. Create kubeflow namespace
41+
#### 2. Create kubeflow namespace and switch to it
4242

4343
Create a namespace for model registry to run in, by default this is kubeflow, run:
4444

4545
```shell
4646
kubectl create namespace kubeflow
4747
```
48+
then, switch to that kubeflow namespace
49+
50+
51+
```shell
52+
kubectl config set-context --current --namespace=kubeflow
53+
```
4854

4955
#### 3. Deploy Model Registry to cluster
5056

@@ -87,7 +93,7 @@ Note: an issue has been filed regarding this ticket here:
8793
#### 4. Setup a port forward to the service
8894

8995
In order to access the MR REST API locally you need to forward a local port to 8080 on the MR service. Run the following
90-
command:
96+
command: (Note: this command starts a long-running service and will not exit the shell)
9197

9298
```shell
9399
kubectl port-forward svc/model-registry-service -n kubeflow 8080:8080
@@ -110,7 +116,7 @@ You should receive a 200 response if everything is working correctly, the body s
110116
{"items":[],"nextPageToken":"","pageSize":0,"size":0}
111117
```
112118

113-
#### 6. Run BFF locally in Dev Mode
119+
#### 6. (Optional) Run BFF locally in Dev Mode
114120

115121
To access your local kind cluster when running the BFF locally, you can use the `DEV_MODE` option. This is useful for when
116122
you want to test live changes on real cluster. To do so, simply run:

0 commit comments

Comments
 (0)