docs: mention the purpose of the deploy script

deploy.py

@@ -2,8 +2,8 @@
 
 import argparse
 import subprocess
-from pathlib import Path
 import time
+from pathlib import Path
 
 script_path = Path(__file__).resolve()
 ROOT_DIR = script_path.parent
@@ -23,16 +23,17 @@
 parser = argparse.ArgumentParser(description='Manage k3d cluster and helm installations.')
 subparsers = parser.add_subparsers(dest='subcommand', required=True, help='Subcommands')
 
-cluster_parser = subparsers.add_parser('cluster', help='Manage the k3d cluster')
+cluster_parser = subparsers.add_parser('cluster', help='Start the k3d cluster')
 cluster_parser.add_argument('--dev', action='store_true',
                             help='Set up a development environment for running the website and the backend locally')
 cluster_parser.add_argument('--delete', action='store_true', help='Delete the cluster')
 
-helm_parser = subparsers.add_parser('helm', help='Manage helm installation')
+helm_parser = subparsers.add_parser('helm', help='Install the Helm chart to the k3d cluster')
 helm_parser.add_argument('--dev', action='store_true',
                          help='Set up a development environment for running the website and the backend locally')
 helm_parser.add_argument('--branch', help='Set the branch to deploy with the Helm chart')
-helm_parser.add_argument('--dockerconfigjson', help='Base64 encoded dockerconfigjson secret for pulling the images')
+helm_parser.add_argument('--dockerconfigjson',
+                         help='Set the base64 encoded dockerconfigjson secret for pulling the images')
 helm_parser.add_argument('--uninstall', action='store_true', help='Uninstall installation')
 helm_parser.add_argument('--enablePreprocessing', action='store_true',
                          help='Include deployment of preprocessing pipelines')

kubernetes/README.md

@@ -20,6 +20,18 @@ Install [k3d](https://k3d.io/v5.6.0/) and [helm](https://helm.sh/).
 
 Start the [backend](/backend/README.md) and the [website](/website/README.md) locally.
 
+### The `deploy.py` script
+
+The `deploy.py` script wraps the most important `k3d` and `helm` commands.
+Check the help for more information:
+
+```shell
+../deploy.py --help
+```
+
+Basic cluster management should be done with this script.
+Use `kubectl` to interact with the running cluster in full power (e.g. accessing individual pods, getting logs, etc.).
+
 ### Details
 
 Create a cluster that doesn't expose the ports of the backend and the website: