From 0c1b55e6350c00a808b6ee990f46ff66506e2bfc Mon Sep 17 00:00:00 2001 From: Zhenya Tikhonov Date: Sun, 21 Sep 2025 17:24:52 +0400 Subject: [PATCH 1/2] feat: add compatibility table for onprem services --- README.md.gotmpl | 45 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/README.md.gotmpl b/README.md.gotmpl index 013502286..9c5ac4c37 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -205,14 +205,43 @@ helm show values codefresh/codefresh ### Persistent services -The following table displays the list of **persistent** services created as part of the on-premises installation: - -| Database | Purpose | Required version | -| :--- | :---- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 16.x or 17.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | -| RabbitMQ | Used for message queueing. | 3.13 \| 4.0.x | +The following table displays the list of **persistent** services created as part of the on-premises installation (for each Codefresh version): + +#### 2.9 + +| Database | Purpose | Recommended version | Supported versions | +| :--- | :---- | :--- | :--- | +| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x (`featureCompatibilityVersion: 7.0`) | \>=4.2 \<=7.x | +| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 17.x | \>= 16.x \<= 17.x | +| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.4.x | \>= 7.0.x \<= 7.4.x | +| RabbitMQ | Used for message queueing. | 4.1.x | 3.13.x \| 4.0.x \| 4.1.x | + +#### 2.8 + +| Database | Purpose | Recommended version | Supported versions | +| :--- | :---- | :--- | :--- | +| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x (`featureCompatibilityVersion: 6.0`) | \>=4.2 \<=7.x | +| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 16.x \| 17.x | \>= 13.x \<= 17.x | +| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.4.x | \>= 7.0.x \<= 7.4.x | +| RabbitMQ | Used for message queueing. | 4.0.x | 3.13.x \| 4.0.x \| 4.1.x | + +#### 2.7 + +| Database | Purpose | Recommended version | Supported versions | +| :--- | :---- | :--- | :--- | +| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 6.x (`featureCompatibilityVersion: 6.0`) | \>=4.2 \<=6.x | +| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 13.x | 13.x | +| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | 7.0.x | +| RabbitMQ | Used for message queueing. | 3.13.x | 3.13.x | + +#### 2.6 + +| Database | Purpose | Recommended version | Supported versions | +| :--- | :---- | :--- | :--- | +| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 6.x (`featureCompatibilityVersion: 5.0`) | \>=4.2 \<=6.x | +| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 13.x | 13.x | +| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | 7.0.x | +| RabbitMQ | Used for message queueing. | 3.13.x | 3.13.x | > Running on netfs (nfs, cifs) is not recommended. From 83e275660ce48e206e4ce9e4eaa4be370d4383a1 Mon Sep 17 00:00:00 2001 From: Zhenya Tikhonov Date: Mon, 22 Sep 2025 23:29:33 +0400 Subject: [PATCH 2/2] docs: improve docs --- README.md | 23 +++++++++++++-------- README.md.gotmpl | 52 ++++++++++++++---------------------------------- 2 files changed, 30 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 12c905f36..41af5e2c8 100644 --- a/README.md +++ b/README.md @@ -204,14 +204,21 @@ helm show values codefresh/codefresh ### Persistent services -The following table displays the list of **persistent** services created as part of the on-premises installation: - -| Database | Purpose | Required version | -| :--- | :---- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 16.x or 17.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | -| RabbitMQ | Used for message queueing. | 3.13 \| 4.0.x | +Codefresh relies on several persistent services to store its data: + +- **MongoDB**: Stores all account data (account settings, users, projects, pipelines, builds etc.) +- **PostgreSQL**: Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. +- **Redis**: Used for caching, and as a key-value store for cron trigger manager. +- **RabbitMQ**: Used for message queueing. + +The following table reflects the recommended and supported versions of these databases for different Codefresh releases: + +| Codefresh version | MongoDB | PostgreSQL | Redis | RabbitMQ | +| :--- | :--- | :--- | :--- | :--- | +| 2.9.x | \>=4.2 \<=7.x
Recommended: 7.x (`featureCompatibilityVersion: 7.0`)| \>= 16.x \<= 17.x
Recommended: 17.x | \>= 7.0.x \<= 7.4.x
Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x
Recommended: 4.1.x | +| 2.8.x | \>=4.2 \<=7.x
Recommended: 7.x (`featureCompatibilityVersion: 6.0`)| \>= 13.x \<= 17.x
Recommended: 16.x \| 17.x | \>= 7.0.x \<= 7.4.x
Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x
Recommended: 4.0.x | +| 2.7.x | \>=4.2 \<=6.x
Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x | +| 2.6.x | \>=4.2 \<=6.x
Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x | > Running on netfs (nfs, cifs) is not recommended. diff --git a/README.md.gotmpl b/README.md.gotmpl index 9c5ac4c37..f54d66f4a 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -205,43 +205,21 @@ helm show values codefresh/codefresh ### Persistent services -The following table displays the list of **persistent** services created as part of the on-premises installation (for each Codefresh version): - -#### 2.9 - -| Database | Purpose | Recommended version | Supported versions | -| :--- | :---- | :--- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x (`featureCompatibilityVersion: 7.0`) | \>=4.2 \<=7.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 17.x | \>= 16.x \<= 17.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.4.x | \>= 7.0.x \<= 7.4.x | -| RabbitMQ | Used for message queueing. | 4.1.x | 3.13.x \| 4.0.x \| 4.1.x | - -#### 2.8 - -| Database | Purpose | Recommended version | Supported versions | -| :--- | :---- | :--- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x (`featureCompatibilityVersion: 6.0`) | \>=4.2 \<=7.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 16.x \| 17.x | \>= 13.x \<= 17.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.4.x | \>= 7.0.x \<= 7.4.x | -| RabbitMQ | Used for message queueing. | 4.0.x | 3.13.x \| 4.0.x \| 4.1.x | - -#### 2.7 - -| Database | Purpose | Recommended version | Supported versions | -| :--- | :---- | :--- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 6.x (`featureCompatibilityVersion: 6.0`) | \>=4.2 \<=6.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 13.x | 13.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | 7.0.x | -| RabbitMQ | Used for message queueing. | 3.13.x | 3.13.x | - -#### 2.6 - -| Database | Purpose | Recommended version | Supported versions | -| :--- | :---- | :--- | :--- | -| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 6.x (`featureCompatibilityVersion: 5.0`) | \>=4.2 \<=6.x | -| Postgresql | Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 13.x | 13.x | -| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x | 7.0.x | -| RabbitMQ | Used for message queueing. | 3.13.x | 3.13.x | +Codefresh relies on several persistent services to store its data: + +- **MongoDB**: Stores all account data (account settings, users, projects, pipelines, builds etc.) +- **PostgreSQL**: Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. +- **Redis**: Used for caching, and as a key-value store for cron trigger manager. +- **RabbitMQ**: Used for message queueing. + +The following table reflects the recommended and supported versions of these databases for different Codefresh releases: + +| Codefresh version | MongoDB | PostgreSQL | Redis | RabbitMQ | +| :--- | :--- | :--- | :--- | :--- | +| 2.9.x | \>=4.2 \<=7.x
Recommended: 7.x (`featureCompatibilityVersion: 7.0`)| \>= 16.x \<= 17.x
Recommended: 17.x | \>= 7.0.x \<= 7.4.x
Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x
Recommended: 4.1.x | +| 2.8.x | \>=4.2 \<=7.x
Recommended: 7.x (`featureCompatibilityVersion: 6.0`)| \>= 13.x \<= 17.x
Recommended: 16.x \| 17.x | \>= 7.0.x \<= 7.4.x
Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x
Recommended: 4.0.x | +| 2.7.x | \>=4.2 \<=6.x
Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x | +| 2.6.x | \>=4.2 \<=6.x
Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x | > Running on netfs (nfs, cifs) is not recommended.