Outdated and broken information in README.md and stackgres-k8s/src/README.md

Summary

README.md contains outdated and broken information.

Issues found

The supported PostgreSQL versions are wrong

### What PostgreSQL versions are supported?
As of now, PostgreSQL major version 12 and 13. As a general rule, StackGres will support the last 2 Postgres version.

StackGres ships PostgreSQL major versions 12 to 18 (see stackgres-k8s/src/common/src/main/resources/versions-1.20.properties), and it keeps supporting the major versions that were available in previous releases instead of only the last 2. The FAQ of the documentation already answer this correctly, the README has to be aligned with it.

The question about the license switch is not a heading

The question Will you ever switch from an open-source license to a source-available one? is written as plain text inside the answer of the previous question, therefore it is rendered as part of that answer instead of being a question of its own.

The base image version is outdated

- [Lightweight, secure container images based on RedHat’s UBI 8](https://stackgres.io/features/#redhat-based)

Images are built on both UBI 8 and UBI 9 (ubi9/openjdk-21 and ubi9/ubi-minimal for the operator, ubi8/ubi-micro and ubi8/nginx-124 for the other components), so the version have to be dropped. Also RedHat have to be written Red Hat as in the rest of the README.

Grammar errors

  • ### Why is used UBI as the base image for StackGres?
  • Some applications, such as databases, required more hand-holding

stackgres-k8s/src/README.md

The build instructions are also wrong:

  • The maven profiles build-image-jvm, build-image-native and integration do not exist anymore.
  • The required JDK is 21, not 17.
  • The operator is deployed with the stackgres-operator helm chart, not with stackgres-cluster.
  • The ASCII art is in the middle of the document instead of being at the end.

It have to explain instead how to build a module with stackgres-k8s/ci/build/build.sh through the stackgres-k8s/ci/build/ciw wrapper, that provides all the tools required to drive the build, for instance:

sh stackgres-k8s/ci/build/ciw sh stackgres-k8s/ci/build/build.sh operator-jvm-image

It also have to explain how to run the e2e tests with the same wrapper and the stackgres-k8s/e2e/e2e CLI (setting K8S_FROM_DIND=true so that the kubernetes configuration uses the docker internal IPs to reach the kind cluster created from inside the container):

K8S_FROM_DIND=true sh stackgres-k8s/ci/build/ciw \
  sh stackgres-k8s/e2e/e2e cli pull test -- stackgres-k8s/e2e/spec/dbops-pgbench

Finally, the section about the utils only mention update-crds.sh and utils while there are more of them now under stackgres-k8s/ci/utils, so all of them have to be listed.

Edited by Matteo Melli