Merge pull request #5333 from GeorgianaTurcsanyi/update_kind_deploy_docs

update documentation on deploying OVN K8s with KIND

Author: trozet

contrib/kind.sh

@@ -459,8 +459,8 @@ print_params() {
 
 install_jinjanator_renderer() {
   # ensure jinjanator renderer installed
-  pip install wheel --user
-  pip freeze | grep jinjanator || pip install jinjanator[yaml] --user
+  pipx install jinjanator[yaml]
+  pipx ensurepath --force >/dev/null
   export PATH=~/.local/bin:$PATH
 }
 
@@ -499,11 +499,11 @@ check_dependencies() {
   fi
 
   if ! command_exists jinjanate ; then
-    if ! command_exists pip ; then
-      echo "Dependency not met: 'jinjanator' not installed and cannot install with 'pip'"
+    if ! command_exists pipx ; then
+      echo "Dependency not met: 'jinjanator' not installed and cannot install with 'pipx'"
       exit 1
     fi
-    echo "'jinjanate' not found, installing with 'pip'"
+    echo "'jinjanate' not found, installing with 'pipx'"
     install_jinjanator_renderer
   fi
 

docs/installation/launching-ovn-kubernetes-on-kind.md

@@ -14,19 +14,19 @@ KIND (Kubernetes in Docker) deployment of OVN kubernetes is a fast and easy mean
       sudo firewall-cmd --permanent --add-port=11337/tcp; sudo firewall-cmd --reload
       ```
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
-- Python and pip
+- Python 3 and [pipx](https://pipx.pypa.io/stable/installation/)
 - jq
 - openssl
 - openvswitch
-
-**NOTE :**  In certain operating systems such as CentOS 8.x, pip2 and pip3 binaries are installed instead of pip. In such situations create a softlink for "pip" that points to "pip2".
+- Go 1.23.0 or above
+- For podman users: skopeo
 
 For OVN kubernetes KIND deployment, use the `kind.sh` script.
 
 First Download and build the OVN-Kubernetes repo: 
 
-```
-git clone github.com/ovn-org/ovn-kubernetes; 
+```shell
+git clone https://github.com/ovn-kubernetes/ovn-kubernetes.git 
 cd ovn-kubernetes
 ```
 The `kind.sh` script builds OVN-Kubernetes into a container image. To verify
@@ -79,13 +79,16 @@ To deploy KIND however, you need to start it as root and then copy root's kube c
 ```
 $ pushd contrib
 $ sudo ./kind.sh -ep podman
+$ mkdir -p ~/.kube
 $ sudo cp /root/ovn.conf ~/.kube/kind-config
 $ sudo chown $(id -u):$(id -g) ~/.kube/kind-config
 $ export KUBECONFIG=~/.kube/kind-config
 $ popd
 ```
 
-This will launch a KIND deployment. By default the cluster is named `ovn`.
+**NOTE:** If you installed go via the official path on Linux and have encountered the "go: command not found" issue, you can preserve your environment when doing sudo: `sudo --preserve-env=PATH ./kind.sh -ep podman`
+
+This will launch a KIND deployment. By default, the cluster is named `ovn`.
 
 ```
 $ kubectl get nodes