Fixes based on feedback

Author: MonkeyCanCode

helm/polaris/README.md

@@ -62,14 +62,29 @@ minikube start
 eval $(minikube docker-env)
 
 ./gradlew \
-    :polaris-server:assemble \
-    :polaris-server:quarkusAppPartsBuild --rerun \
-    :polaris-admin:assemble \
-    :polaris-admin:quarkusAppPartsBuild --rerun \
-    -Dquarkus.container-image.build=true
+  :polaris-server:assemble \
+  :polaris-server:quarkusAppPartsBuild --rerun \
+  :polaris-admin:assemble \
+  :polaris-admin:quarkusAppPartsBuild --rerun \
+  -Dquarkus.container-image.tag=postgres-latest \
+  -Dquarkus.container-image.build=true
 ```
 
-#### Installing the Helm chart
+### Installing the chart locally
+
+The below instructions assume a local Kubernetes cluster is running and Helm is installed.
+
+#### Common setup
+
+Create the target namespace:
+```bash
+kubectl create namespace polaris
+```
+
+Create all the required resources in the `polaris` namespace. This usually includes a Postgres
+database and a Kubernetes Secret for Polaris service certification files. The Polaris chart does not create
+these resources automatically, as they are not required for all Polaris deployments. The chart will
+fail if these resources are not created beforehand. You can find a reference for these resources in the `Prerequisites` section within `Development & Testing`.
 
 Below are two sample deployment models for installing the chart: one with a non-persistent backend and another with a persistent backend.
 
@@ -78,13 +93,13 @@ Below are two sample deployment models for installing the chart: one with a non-
 > **These files are intended for testing purposes primarily, and may not be suitable for production use**.
 > For production deployments, create your own values files based on the provided examples.
 
-##### Non-persistent backend
+#### Non-persistent backend
 
 Install the chart with a non-persistent backend. From Polaris repo root:
 ```bash
 helm upgrade --install --namespace polaris \
   --values helm/polaris/ci/simple-values.yaml \
-  polaris helm/polaris --create-namespace polaris
+  polaris helm/polaris
 ```
 
 Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained
@@ -93,21 +108,14 @@ above, then you need to run `helm upgrade` as follows:
 helm upgrade --install --namespace polaris \
   --values helm/polaris/ci/simple-values.yaml \
   --set=image.repository=localhost:5001/apache/polaris \
-  polaris helm/polaris --create-namespace polaris
+  polaris helm/polaris
 ```
 
 #### Persistent backend
 
 > [!WARNING]
 > The Postgres deployment set up in the fixtures directory is intended for testing purposes only and is not suitable for production use. For production deployments, use a managed Postgres service or a properly configured and secured Postgres instance.
 
-Install the dependencies in fixtures directory. From Polaris repo root:
-```bash
-kubectl create namespace polaris
-kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
-kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=postgres --timeout=120s
-```
-
 Install the chart with a persistent backend. From Polaris repo root:
 ```bash
 helm upgrade --install --namespace polaris \
@@ -160,14 +168,20 @@ helm plugin install https://github.com/helm-unittest/helm-unittest.git
 brew install chart-testing
 ```
 
-The integration tests also require some fixtures to be deployed. Follow the above commands to setup required resources.
+The integration tests also require some fixtures to be deployed. The `ci/fixtures` directory
+contains the required resources. To deploy them, run the following command:
+```bash
+kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
+kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=postgres --timeout=120s
+```
 
-The `helm/polaris/ci` contains a number of values files that will be used to install the chart with different configurations.
+The `helm/polaris/ci` contains a number of values files that will be used to install the chart with
+different configurations.
 
 ### Running the unit tests
 
-Helm unit tests do not require a Kubernetes cluster. To run the unit tests, execute Helm Unit from the Polaris repo root:
-
+Helm unit tests do not require a Kubernetes cluster. To run the unit tests, execute Helm Unit from
+the Polaris repo root:
 ```bash
 helm unittest helm/polaris
 ```
@@ -180,7 +194,8 @@ ct lint --charts helm/polaris
 
 ### Running the integration tests
 
-Integration tests require a Kubernetes cluster. See installation instructions above for setting up a local cluster.
+Integration tests require a Kubernetes cluster. See installation instructions above for setting up
+a local cluster.
 
 Integration tests are run with the Chart Testing tool:
 ```bash

helm/polaris/README.md.gotmpl

@@ -64,14 +64,29 @@ minikube start
 eval $(minikube docker-env)
 
 ./gradlew \
-    :polaris-server:assemble \
-    :polaris-server:quarkusAppPartsBuild --rerun \
-    :polaris-admin:assemble \
-    :polaris-admin:quarkusAppPartsBuild --rerun \
-    -Dquarkus.container-image.build=true
+  :polaris-server:assemble \
+  :polaris-server:quarkusAppPartsBuild --rerun \
+  :polaris-admin:assemble \
+  :polaris-admin:quarkusAppPartsBuild --rerun \
+  -Dquarkus.container-image.tag=postgres-latest \
+  -Dquarkus.container-image.build=true
 ```
 
-#### Installing the Helm chart
+### Installing the chart locally
+
+The below instructions assume a local Kubernetes cluster is running and Helm is installed.
+
+#### Common setup
+
+Create the target namespace:
+```bash
+kubectl create namespace polaris
+```
+
+Create all the required resources in the `polaris` namespace. This usually includes a Postgres
+database and a Kubernetes Secret for Polaris service certification files. The Polaris chart does not create
+these resources automatically, as they are not required for all Polaris deployments. The chart will
+fail if these resources are not created beforehand. You can find a reference for these resources in the `Prerequisites` section within `Development & Testing`.
 
 Below are two sample deployment models for installing the chart: one with a non-persistent backend and another with a persistent backend.
 
@@ -80,13 +95,13 @@ Below are two sample deployment models for installing the chart: one with a non-
 > **These files are intended for testing purposes primarily, and may not be suitable for production use**.
 > For production deployments, create your own values files based on the provided examples.
 
-##### Non-persistent backend
+#### Non-persistent backend
 
 Install the chart with a non-persistent backend. From Polaris repo root:
 ```bash
 helm upgrade --install --namespace polaris \
   --values helm/polaris/ci/simple-values.yaml \
-  polaris helm/polaris --create-namespace polaris
+  polaris helm/polaris
 ```
 
 Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained
@@ -95,21 +110,14 @@ above, then you need to run `helm upgrade` as follows:
 helm upgrade --install --namespace polaris \
   --values helm/polaris/ci/simple-values.yaml \
   --set=image.repository=localhost:5001/apache/polaris \
-  polaris helm/polaris --create-namespace polaris
+  polaris helm/polaris
 ```
 
 #### Persistent backend
 
 > [!WARNING]
 > The Postgres deployment set up in the fixtures directory is intended for testing purposes only and is not suitable for production use. For production deployments, use a managed Postgres service or a properly configured and secured Postgres instance.
 
-Install the dependencies in fixtures directory. From Polaris repo root:
-```bash
-kubectl create namespace polaris
-kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
-kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=postgres --timeout=120s
-```
-
 Install the chart with a persistent backend. From Polaris repo root:
 ```bash
 helm upgrade --install --namespace polaris \
@@ -162,14 +170,20 @@ helm plugin install https://github.com/helm-unittest/helm-unittest.git
 brew install chart-testing
 ```
 
-The integration tests also require some fixtures to be deployed. Follow the above commands to setup required resources.
+The integration tests also require some fixtures to be deployed. The `ci/fixtures` directory
+contains the required resources. To deploy them, run the following command:
+```bash
+kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
+kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=postgres --timeout=120s
+```
 
-The `helm/polaris/ci` contains a number of values files that will be used to install the chart with different configurations.
+The `helm/polaris/ci` contains a number of values files that will be used to install the chart with
+different configurations.
 
 ### Running the unit tests
 
-Helm unit tests do not require a Kubernetes cluster. To run the unit tests, execute Helm Unit from the Polaris repo root:
-
+Helm unit tests do not require a Kubernetes cluster. To run the unit tests, execute Helm Unit from
+the Polaris repo root:
 ```bash
 helm unittest helm/polaris
 ```
@@ -182,7 +196,8 @@ ct lint --charts helm/polaris
 
 ### Running the integration tests
 
-Integration tests require a Kubernetes cluster. See installation instructions above for setting up a local cluster.
+Integration tests require a Kubernetes cluster. See installation instructions above for setting up
+a local cluster.
 
 Integration tests are run with the Chart Testing tool:
 ```bash