Skip to content

feat: add compatibility table for onprem services #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 23, 2025
Merged

feat: add compatibility table for onprem services #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c1b55e
feat: add compatibility table for onprem services
masontikhonov Sep 21, 2025
83e2756
docs: improve docs
masontikhonov Sep 22, 2025
84d18b0
Merge branch 'main' into CR-31002-drw-prepare-for-mongodb-on-prem-upg…
masontikhonov Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <br> Recommended: 7.x (`featureCompatibilityVersion: 7.0`)| \>= 16.x \<= 17.x <br> Recommended: 17.x | \>= 7.0.x \<= 7.4.x <br> Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x <br> Recommended: 4.1.x |
| 2.8.x | \>=4.2 \<=7.x <br> Recommended: 7.x (`featureCompatibilityVersion: 6.0`)| \>= 13.x \<= 17.x <br> Recommended: 16.x \| 17.x | \>= 7.0.x \<= 7.4.x <br> Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x <br> Recommended: 4.0.x |
| 2.7.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x |
| 2.6.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x |

> Running on netfs (nfs, cifs) is not recommended.

Expand Down
23 changes: 15 additions & 8 deletions README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +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:

| 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 <br> Recommended: 7.x (`featureCompatibilityVersion: 7.0`)| \>= 16.x \<= 17.x <br> Recommended: 17.x | \>= 7.0.x \<= 7.4.x <br> Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x <br> Recommended: 4.1.x |
| 2.8.x | \>=4.2 \<=7.x <br> Recommended: 7.x (`featureCompatibilityVersion: 6.0`)| \>= 13.x \<= 17.x <br> Recommended: 16.x \| 17.x | \>= 7.0.x \<= 7.4.x <br> Recommended: 7.4.x | 3.13.x \| 4.0.x \| 4.1.x <br> Recommended: 4.0.x |
| 2.7.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x |
| 2.6.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x |

> Running on netfs (nfs, cifs) is not recommended.

Expand Down