From f697f10286cc55bf69ce7fc4e8829a4a682ff5b8 Mon Sep 17 00:00:00 2001 From: shirady <57721533+shirady@users.noreply.github.com> Date: Mon, 31 Jul 2023 12:18:33 +0300 Subject: [PATCH] code review changes - add tips about minikube Signed-off-by: shirady <57721533+shirady@users.noreply.github.com> --- ..._noobaa_on_minikube_or_rancher_desktop.md} | 27 +++++++++++++++---- 1 file changed, 22 insertions(+), 5 deletions(-) rename doc/dev_guide/{deply_noobaa_on_local_machine.md => deply_noobaa_on_minikube_or_rancher_desktop.md} (84%) diff --git a/doc/dev_guide/deply_noobaa_on_local_machine.md b/doc/dev_guide/deply_noobaa_on_minikube_or_rancher_desktop.md similarity index 84% rename from doc/dev_guide/deply_noobaa_on_local_machine.md rename to doc/dev_guide/deply_noobaa_on_minikube_or_rancher_desktop.md index f20ac327c1..ea985ba2af 100644 --- a/doc/dev_guide/deply_noobaa_on_local_machine.md +++ b/doc/dev_guide/deply_noobaa_on_minikube_or_rancher_desktop.md @@ -1,4 +1,4 @@ -# Deploy NooBaa on Local Machine +# Deploy NooBaa on Minikube / Rancher Desktop There are many ways to deploy NooBaa on k8s on you local machine, this guide refers to 2 options (the difference is in the configurations): 1. Docker Desktop + Minikube 2. Rancher Desktop @@ -21,10 +21,18 @@ minikube start ``` b. Set configurations: ```bash - minikube config set memory 8000 - minikube config set cpus 5 +minikube config set memory 8000 +minikube config set cpus 5 +``` +##### Tips for minikube users: +c. Optional - You can also use minikube dashboard: +```bash +minikube dashboard --url +``` +d. Optional - before starting you cluster (not talking about first time installation) it is better to run this command so the user won't get the previous cluster (sometimes minikube won't get deleted even after the system restart): +```bash +minikube delete --all ``` - ### Rancher Desktop Inside the application -> preferences -> Virtual Machine (left tab) -> Memory: 10 GB, CPU: 6 @@ -44,6 +52,8 @@ In each step, it is mentioned what tab you should use. ```bash eval $(minikube docker-env) ``` +Note: You can build on your local machine (it would be faster, since n minikube it would build the image from scratch) - but minikube doesn't have access to it, so you will need to push the image to a remote repository Docker Hub or Quay (and then pull it). + ## 3) Before Building The Images (Noobaa-Operator Tab) Change the working directory to the local repository (in this example the local repository is inside `SourceCode` directory). ```bash @@ -89,10 +99,17 @@ Change the tag name `noobaa:latest noobaa-core:`, for example: ```bash docker tag noobaa:latest noobaa-core:my-deploy ``` - +Tip: You can use this option instead of running the two commands: +```bash +make noobaa NOOBAA_TAG=noobaa-core: +``` ### 7) Push Core Images (Noobaa-Core Tab) - Optional Please refer to [Push Operator Images (Noobaa-Operator Tab) - Optional](#5-push-operator-images-noobaa-operator-tab---optional), the only change is instead of `noobaa-operator` use `noobaa-core`. +Tip: You can use this option instead of running the two commands (using Quay, your user in Quay): +```bash +make noobaa NOOBAA_TAG=quay.io//noobaa-core: +``` ### 8) Deploy Noobaa (Noobaa-Operator Tab) Deploy noobaa and you the image you created and tagged: ```bash