Add rose dir to path when running driver outside a container

Signed-off-by: yzamir <kobi.zamir@gmail.com>

rose/client/Makefile

@@ -1,7 +1,9 @@
 .PHONY: lint test lint-fix code-quality run build-image run-image clean
 
+ROSE_DIR = ../..
+
 IMAGE_NAME ?= quay.io/rose/rose-client
-DRIVER_PATH ?= ./mydriver.py
+DRIVER_PATH ?= $(ROSE_DIR)/examples/none.py
 PORT ?= 8081
 
 # By default, run both linting and tests
@@ -27,7 +29,7 @@ test:
 
 run:
 	@echo "Running driver logic server ..."
-	python main.py --port $(PORT) --driver $(DRIVER_PATH)
+	PYTHONPATH=$(ROSE_DIR):$$PYTHONPATH python main.py --port $(PORT) --driver $(DRIVER_PATH)
 
 build-image:
 	@echo "Building container image ..."

rose/client/README.rst

@@ -44,23 +44,49 @@ This server uses a default driver logic which chooses the next action randomly.
 
 Podman Usage
 ============
-1. Build the Podman image:
+1. Build the container image:
 
    .. code-block:: bash
 
       # Edit mydriver.py file.
       podman build -t rose-driver .
 
-2. Run the container:
+2. Build and run a custom container image:
 
    .. code-block:: bash
 
-      # Edit mydriver.py file, and create the best driver code,
-      # once mydriver.py is ready build and run the container.
+      # Customize the container using your driver.
+      # Copy a driver to current directory
+      cp ../../examples/none.py ./mydriver.py
+
+      # Edit ./mydriver.py file, and create the best driver code,
+      # once ./mydriver.py is ready build the custom container.
+
+      # Build the custom image:
+      # The driver ./mydriver.py will be baked into the custom container image.
       podman build -t rose-driver .
-      podman run -it --rm --network host rose-driver --port 8081
 
-3. Run the container using local driver python file:
+      # Run the custom container
+      # Important: ./mydriver.py must be baked into the image during build,
+      #            see bellow for instructions on running a local driver. 
+      podman run -it --rm --network host rose-driver
+
+3. (Optional) To use you custom container image in an Openshift cluster you need to push it to a publich repository.
+
+   .. code-block:: bash
+
+      # Login (this example use quay.io)
+      podman login quay.io
+      
+      # Tag the image uging your name (for example 'jhon_doe')
+      podman tag rose-driver quay.io/john_doe/my_rose_driver:latest
+      
+      # Push the image to the public repository (use the name you like, for example 'my_rose_driver')
+      podman push quay.io/john_doe/my_rose_driver:latest
+
+      # Now you can deploy your custom container image into an openshift cluster
+
+4. Run the container using local driver python file:
 
    .. code-block:: bash