Merge branch 'merge-1.18.0-rc2' into 'main'

Merge 1.18.0-rc2

Closes #3080

See merge request ongresinc/stackgres!1700

Author: teoincontatto

CHANGELOG.md

@@ -1,3 +1,67 @@
+# :rocket: Release 1.18.0-rc2 (2025-11-17)
+
+## :notepad_spiral: NOTES
+
+StackGres 1.18.0-rc2 is out! :confetti_ball: :champagne: 
+
+Among other features this release will allow you to upgrade your clusters using a strategy and with a renewed rollout implementation that no longer relies on Jobs but is handled directly by the operator. You can still rely on SGDbOps to perform restarts, security upgrades and minor version upgrades operations or configure the clusters to preform them in an automatic fashion.
+
+Another important change is the ability to set the version of your SGCluster or SGShardedCluster directly in the cluster resource. The final Postgres version (and the final extensions versions too) will no longer be changed by the operator, instead it will be set in the status and will be updated by the operator. This change will allow a much better integration with DevOps tools!
+
+So, what you are waiting for! Upgrade now and have a look at the future of StackGres! 
+
+## :sparkles: NEW FEATURES AND CHANGES
+
+* Added PostgreSQL versions 18.1, 17.7, 16.11, 15.15, 14.20 and 13.23
+* PgBouncer 1.25.0
+* Prometheus Postgres Exporter 0.18.1
+* FluentBit 4.2.0
+* OTEL Collector 0.139.0
+* Allow to change postgres version/extensions/config at any time and have the operator perform the rollout
+* Support replicate from in sharded cluster
+* Improved metadata and added useIAMRole to SGObjectStorage for S3
+* Allow to set patroni failsafe_mode and check_timeline
+* Allow to remove primary keys and not null constraints on snapshot and set metadata on Pod for SGStream
+* Updated default citus versions for sharded cluster
+* PostgreSQL versions 17.5, 16.9, 15.13, 14.18, 13.21 should not be advertized as bugged
+* Support to re-creating the SSL cluster certificate before it expires
+
+## Web Console
+
+Nothing new here! :eyes:
+
+## :bug: FIXES
+
+* Updated Patroni config to latest version
+* Allow to set null backup paths or null elements in backup paths for sharded clusters
+* Extension cache is not including all extensions when preloading
+* Cluster local controller check extension cache when no changes are performed on extensions
+* SGStream is not using detectInsertMode by default
+* Changing authenticator username breaks PgBouncer
+
+## Web Console
+
+* Allow to unset cronSchedule and backup paths for clusters and sharded clusters
+
+## :construction: KNOWN ISSUES
+
+* Backups may be restored with inconsistencies when performed with a Postgres instance running on a different architecture ([#1539](https://gitlab.com/ongresinc/stackgres/-/issues/1539))
+
+## :up: UPGRADE
+
+To upgrade from a previous installation of the StackGres operator's helm chart you will have to upgrade the helm chart release.
+ For more detailed information please refer to [our documentation](https://stackgres.io/doc/latest/install/helm/upgrade/#upgrade-operator).
+
+To upgrade StackGres operator's (upgrade only works starting from 1.1 version or above) helm chart issue the following commands (replace namespace and release name if you used something different):
+
+`helm upgrade -n "stackgres" "stackgres-operator" https://stackgres.io/downloads/stackgres-k8s/stackgres/1.18.0-rc2/helm/stackgres-operator.tgz`
+
+> IMPORTANT: This release is incompatible with previous `alpha` or `beta` versions. Upgrading from those versions will require uninstalling completely StackGres including all clusters and StackGres CRDs (those in `stackgres.io` group) first.
+
+Thank you for all the issues created, ideas, and code contributions by the StackGres Community!
+
+## :twisted_rightwards_arrows: [FULL LIST OF COMMITS](https://gitlab.com/ongresinc/stackgres/-/commits/1.18.0-rc2)
+
 # :rocket: Release 1.18.0-rc1 (2025-11-11)
 
 ## :notepad_spiral: NOTES

doc/.gitignore

@@ -0,0 +1,2 @@
+content/en/04-administration-guide/01-installation/02-installation-via-helm/01-operator-parameters/_index.md
+content/en/06-crd-reference/*/_index.md

doc/CRD.tmpl

@@ -7,7 +7,7 @@
 {{- $onlyOnCreationTypes := dict }}
 {{- $requireRestartTypes := dict }}
 {{- range .Types}}
-{{- $key := regexReplaceAll "\\[index\\]" .Name "" }}
+{{- $key := regexReplaceAll "\\[(index|key)\\]" .Name "" }}
 {{- range .Fields -}}
 {{- $description := .Description }}
 {{- $fieldKey := (print $key "." .Name) }}
@@ -28,7 +28,7 @@
 {{- end }}
 {{- end }}
 {{- range .Types}}
-{{- $key := regexReplaceAll "\\[index\\]" .Name "" }}
+{{- $key := regexReplaceAll "\\[(index|key)\\]" .Name "" }}
 {{- if not (get $hiddenTypes $key) }}
 {{- if not .IsTopLevel}}
 

doc/build.sh

@@ -2,20 +2,51 @@
 
 set -e
 
-rm -Rf "$(dirname "$0")/data/crds"
-mkdir -p "$(dirname "$0")/data/crds"
-find "$(dirname "$0")/../stackgres-k8s/src/common/src/main/resources/crds" -name '*.yaml' \
+PROJECT_PATH=".."
+
+cd "$(dirname "$0")"
+
+rm -Rf "data/crds"
+mkdir -p "data/crds"
+
+STACKGRES_VERSION="${STACKGRES_VERSION:-$(sh "$PROJECT_PATH/stackgres-k8s/ci/build/version.sh")}"
+echo "current_version: \"$STACKGRES_VERSION\"" > "data/versions.yml"
+
+find "$PROJECT_PATH/stackgres-k8s/src/common/src/main/resources/crds" -name '*.yaml' \
   | while read -r FILE
     do
-      cp "$FILE" "$(dirname "$0")/data/crds"
+      cp "$FILE" "data/crds"
     done
-cp "$(dirname "$0")/../stackgres-k8s/install/helm/stackgres-operator/Chart.yaml" "$(dirname "$0")/data/stackgres_operator_Chart.yaml"
-sed -n 's#^ *RUN wget "https://get.helm.sh/helm-v\([^-]\+\)-.*$#version: \1#p' "$(dirname "$0")/../stackgres-k8s/ci/build/Dockerfile-ci" > "$(dirname "$0")/data/helm_version.yaml"
-
-STACKGRES_VERSION="${STACKGRES_VERSION:-$(sh stackgres-k8s/ci/build/version.sh)}"
-echo "current_version: \"$STACKGRES_VERSION\"" > "$(dirname "$0")/data/versions.yml"
+cp "$PROJECT_PATH/stackgres-k8s/install/helm/stackgres-operator/Chart.yaml" \
+  "data/stackgres_operator_Chart.yaml"
+cp "$PROJECT_PATH/stackgres-k8s/install/operator-sdk/stackgres-operator/openshift-operator-bundle/metadata/annotations.yaml" \
+  "data/stackgres_operator_openshift_annotations.yaml"
+sed -n 's#^ *RUN wget "https://get.helm.sh/helm-v\([^-]\+\)-.*$#version: \1#p' \
+  "$PROJECT_PATH/stackgres-k8s/ci/build/Dockerfile-ci" \
+  > "data/helm_version.yaml"
+(
+  cat "$(ls -1 "$PROJECT_PATH/stackgres-k8s/src/operator/src/main/resources"/*/postgresql-default-values-pg*.properties \
+    | tail -n 1)" \
+  || echo :
+) \
+  | sed 's/=\(.*\)$/: "\1"/' | yq . > "data/postgresql_default_values.yaml"
+(
+  cat "$PROJECT_PATH/stackgres-k8s/src/operator/src/main/resources/postgresql-blocklist.properties" \
+  || echo :
+) \
+  | yq 'split(" ")' > "data/postgresql_blocklist.yaml"
+(
+  cat "$PROJECT_PATH/stackgres-k8s/src/operator/src/main/resources/pgbouncer-default-values.properties" \
+  || echo :
+) \
+  | sed 's/=\(.*\)$/: "\1"/' | yq . > "data/pgbouncer_default_values.yaml"
+(
+  cat "$PROJECT_PATH/stackgres-k8s/src/operator/src/main/resources/pgbouncer-blocklist.properties" \
+  || echo :
+) \
+  | yq 'split(" ")' > "data/pgbouncer_blocklist.yaml"
 
-if [ ! -f "$(dirname "$0")/../stackgres-k8s/src/restapi/target/swagger-merged.yaml" ]
+if [ ! -f "$PROJECT_PATH/stackgres-k8s/src/restapi/target/swagger-merged.yaml" ]
 then
   echo "Please build Stackgres operator and swagger first:"
   echo
@@ -25,35 +56,36 @@ then
   echo
   exit 1
 fi
-cp "$(dirname "$0")/../stackgres-k8s/src/restapi/target/swagger-merged.yaml" "$(dirname "$0")/themes/sg-doc/static/sg-swagger.yaml"
+cp "$PROJECT_PATH/stackgres-k8s/src/restapi/target/swagger-merged.yaml" "themes/sg-doc/static/sg-swagger.yaml"
 
-mkdir -p "$(dirname "$0")/generated"
-CRD_PATH="$(dirname "$0")/../stackgres-k8s/src/common/src/main/resources/crds"
+mkdir -p "generated"
+CRD_PATH="$PROJECT_PATH/stackgres-k8s/src/common/src/main/resources/crds"
 cat "$CRD_PATH/index.txt" \
   | {
     while read -r CRD_FILE
     do
       crdoc --resources "$CRD_PATH/$CRD_FILE" \
-        -o "$(dirname "$0")/generated/${CRD_FILE%.yaml}.md" \
-        --template "$(dirname "$0")/CRD.tmpl"
-      TARGET_PATH="$(ls -d "$(dirname "$0")/content/en/06-crd-reference/"*"-$(echo "${CRD_FILE%.yaml}" | tr 'A-Z' 'a-z')")"
+        -o "generated/${CRD_FILE%.yaml}.md" \
+        --template "./CRD.tmpl"
+      TARGET_PATH="$(ls -d "content/en/06-crd-reference/"*"-$(echo "${CRD_FILE%.yaml}" | tr 'A-Z' 'a-z')")"
       INCLUDE_LINE="$(cat "$TARGET_PATH/_index.template.md" | grep -nxF '{{% include "generated/'"${CRD_FILE%.yaml}"'.md" %}}' | cut -d : -f 1)"
       head -n "$((INCLUDE_LINE - 1))" "$TARGET_PATH/_index.template.md" > "$TARGET_PATH/_index.md"
-      cat "$(dirname "$0")/generated/${CRD_FILE%.yaml}.md" >> "$TARGET_PATH/_index.md"
+      cat "generated/${CRD_FILE%.yaml}.md" >> "$TARGET_PATH/_index.md"
       tail -n +"$((INCLUDE_LINE + 1))" "$TARGET_PATH/_index.template.md" >> "$TARGET_PATH/_index.md"
+      sed -i -z 's/```/\n```\n/g' "$TARGET_PATH/_index.md"
     done
     }
 (
-cd "$(dirname "$0")/../stackgres-k8s/install/helm/stackgres-operator"
+cd "$PROJECT_PATH/stackgres-k8s/install/helm/stackgres-operator"
 helm-docs \
   -o "generated.md" \
   -f "values.yaml" \
   -t "VALUES.html.gotmpl"
 )
-mv "$(dirname "$0")/../stackgres-k8s/install/helm/stackgres-operator/generated.md" \
-  "$(dirname "$0")/generated/stackgres-operator.md"
-TARGET_PATH="$(dirname "$0")/../doc/content/en/04-administration-guide/01-installation/02-installation-via-helm/01-operator-parameters"
+mv "$PROJECT_PATH/stackgres-k8s/install/helm/stackgres-operator/generated.md" \
+  "generated/stackgres-operator.md"
+TARGET_PATH="content/en/04-administration-guide/01-installation/02-installation-via-helm/01-operator-parameters"
 INCLUDE_LINE="$(cat "$TARGET_PATH/_index.template.md" | grep -nxF '{{% include "generated/stackgres-operator.md" %}}' | cut -d : -f 1)"
 head -n "$((INCLUDE_LINE - 1))" "$TARGET_PATH/_index.template.md" > "$TARGET_PATH/_index.md"
-cat "$(dirname "$0")/generated/stackgres-operator.md" >> "$TARGET_PATH/_index.md"
+cat "generated/stackgres-operator.md" >> "$TARGET_PATH/_index.md"
 tail -n +"$((INCLUDE_LINE + 1))" "$TARGET_PATH/_index.template.md" >> "$TARGET_PATH/_index.md"

doc/config.toml

@@ -136,5 +136,9 @@ home = [ "HTML", "RSS", "JSON"]
             weight  = 5
 
 
+[markup.tableOfContents]
+  endLevel = 3
+  ordered = true
+
 [markup.goldmark.renderer]
   unsafe= true

doc/content/en/01-introduction/06-versions/_index.md

@@ -8,6 +8,32 @@ showToc: true
 
 =======
 
+## StackGres 1.18.0-rc2
+
+| Component | Versions |
+| ------ | ----------- |
+| PostgreSQL 18 | 18.1 |
+| PostgreSQL 17 | 17.7, 17.6, ~17.5~, 17.4, 17.2, 17.0 |
+| PostgreSQL 16 | 16.11, 16.10, ~16.9~, 16.8, 16.6, 16.4, 16.3, 16.2, 16.1, 16.0 |
+| PostgreSQL 15 | 15.15, 15.14, ~15.13~, 15.12, 15.10, 15.8, 15.7, 15.6, 15.5, 15.4, 15.3, 15.2, 15.1, 15.0 |
+| PostgreSQL 14 | 14.20, 14.19, ~14.18~, 14.17, 14.15, 14.13, 14.12, 14.11, 14.10, 14.9, 14.8, 14.7, 14.6, 14.5, 14.4, ~14.2, 14.1, 14.0~ |
+| PostgreSQL 13 | 13.23, 13.22, ~13.21~, 13.20, 13.18, 13.16 13.15, 13.14, 13.13, 13.12, 13.11, 13.10, 13.9, 13.8, 13.7, 13.6, 13.5, 13.4, 13.3, 13.2, 13.1, 13.0 |
+| PostgreSQL 12 | 12.22, 12.20, 12.19, 12.18, 12.17, 12.16, 12.15, 12.14, 12.13, 12.12, 12.11, 12.10, 12.9, 12.8, 12.7, 12.6, 12.5, 12.4, 12.3, 12.2 and 12.1 |
+| PostgreSQL for Babelfish 17 | 17.6 |
+| PostgreSQL for Babelfish 16 | 16.9, 16.6, 16.4, 16.2, 16.1 |
+| PostgreSQL for Babelfish 15 | 15.8, 15.5 |
+| PostgreSQL for Babelfish 14 | 14.11, 14.10, 14.3 |
+| PostgreSQL for Babelfish 13 | 13.9, 13.6 |
+| Patroni | 4.1.0, 4.0.5, 4.0.4, 3.3.3, 3.3.2, 3.3.0, 3.2.2, 3.0.2, 2.1.4 |
+| WAL-G | 3.0.7, 3.0.3, 3.0.2, 3.0.1, 2.0.1, 2.0.0, 1.1 |
+| PgBouncer | 1.25.0 |
+| Postgres Exporter | 0.18.1 |
+| Envoy | 1.33.2 |
+| Fluent-Bit | 4.2.0 |
+| Fluentd | 1.18.0 |
+| Babelfish Compass | 2025.06 |
+| OTEL Collector | 0.139.0 |
+
 ## StackGres 1.18.0-rc1
 
 | Component | Versions |

doc/content/en/01-introduction/07-tested-environments/_index.md

@@ -8,6 +8,6 @@ StackGres was tested and validated in the following environments:
 
 | Cloud Provider | Kubernetes versions |
 |----------------|---------------------|
-| AWS EKS        | 1.18                |
+| AWS EKS        | 1.34                |
 | Google GKE     | 1.13.11-gke.23      |
 | Digital Ocean  | 1.18.14<br>1.19.6   |

doc/content/en/02-features/01-declarative-resources/_index.md

@@ -20,6 +20,6 @@ Have a look at the [CRD Reference]({{% relref "06-crd-reference" %}}) to learn a
 
 Have a look at the [Getting Started]({{% relref "03-demo-quickstart" %}}) guide to get started with a simple StackGres installation.
 
-> **Note:** If you prefer a visual UI over YAML files and the command line, note that every single action that you can query or perform via CRDs is also possible via the web console.
-> Likewise, any action performed in the web console will automatically be reflected in the CRDs.
+> **Note:** If you prefer a visual UI over YAML files and the command line, note that every single action that you can query or perform via CRDs is also possible via the Web Console.
+> Likewise, any action performed in the Web Console will automatically be reflected in the CRDs.
 > The choice is yours.

doc/content/en/02-features/03-custom-config/_index.md

@@ -19,7 +19,10 @@ You own it without any caveats.
 StackGres allows advanced Postgres users to further customize the components and configurations.
 The configurations are backed by CRDs and fully validated, so there is not a simple ConfigMap that may break your cluster if you set it wrongly.
 
+The operator creates default configuration custom resources if they are not specified. It also allows to set the configurations inline inside of the cluster CRD including those components that does not have a separate CRD like Patroni or the Postgres Exporter.
+
 Have a look at the [Configuration Guide]({{% relref "04-administration-guide/04-configuration" %}}) for a deep dive in how to tune Postgres or connection pool configurations.
+
 As for the other Kubernetes resources, you can customize the services exposed, the pod's labels and, node tolerations, among many others.
 
 In general, StackGres lets you be in full control.

doc/content/en/02-features/04-high-availability/_index.md

@@ -10,6 +10,6 @@ StackGres integrates the most renowned and production-tested high availability s
 StackGres fully integrates Patroni, and for you there's nothing else to do.
 If any pod, any node, anything fails, the cluster will perform a failover and re-heal automatically in a matter of seconds, without human intervention.
 
-StackGres exposes one read-write (master) and one read-only (replicas) connection for the applications via Kubernetes services, that will automatically be updated after any disruptive event happens.
+StackGres exposes one read-write (primary) and one read-only (replicas) connection for the applications via Kubernetes services, that will automatically be updated after any disruptive event happens.
 
 Have a look at the [High Availability Guide]({{% relref "04-administration-guide/09-high-availability" %}}) to learn more about Patroni is integrated into StackGres, and how to perform manual switchovers, or how test failovers.