Skip to content

Commit fd24439

Browse files
feat: add compatibility table for onprem services (#111)
* feat: add compatibility table for onprem services * docs: improve docs
1 parent ae568e7 commit fd24439

File tree

2 files changed

+30
-16
lines changed

2 files changed

+30
-16
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -204,14 +204,21 @@ helm show values codefresh/codefresh
204204

205205
### Persistent services
206206

207-
The following table displays the list of **persistent** services created as part of the on-premises installation:
208-
209-
| Database | Purpose | Required version |
210-
| :--- | :---- | :--- |
211-
| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x |
212-
| 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 |
213-
| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x |
214-
| RabbitMQ | Used for message queueing. | 3.13 \| 4.0.x |
207+
Codefresh relies on several persistent services to store its data:
208+
209+
- **MongoDB**: Stores all account data (account settings, users, projects, pipelines, builds etc.)
210+
- **PostgreSQL**: Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database.
211+
- **Redis**: Used for caching, and as a key-value store for cron trigger manager.
212+
- **RabbitMQ**: Used for message queueing.
213+
214+
The following table reflects the recommended and supported versions of these databases for different Codefresh releases:
215+
216+
| Codefresh version | MongoDB | PostgreSQL | Redis | RabbitMQ |
217+
| :--- | :--- | :--- | :--- | :--- |
218+
| 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 |
219+
| 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 |
220+
| 2.7.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x |
221+
| 2.6.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x |
215222

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

README.md.gotmpl

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -205,14 +205,21 @@ helm show values codefresh/codefresh
205205

206206
### Persistent services
207207

208-
The following table displays the list of **persistent** services created as part of the on-premises installation:
209-
210-
| Database | Purpose | Required version |
211-
| :--- | :---- | :--- |
212-
| MongoDB | Stores all account data (account settings, users, projects, pipelines, builds etc.) | 7.x |
213-
| 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 |
214-
| Redis | Used for caching, and as a key-value store for cron trigger manager. | 7.0.x |
215-
| RabbitMQ | Used for message queueing. | 3.13 \| 4.0.x |
208+
Codefresh relies on several persistent services to store its data:
209+
210+
- **MongoDB**: Stores all account data (account settings, users, projects, pipelines, builds etc.)
211+
- **PostgreSQL**: Stores data about events for the account (pipeline updates, deletes, etc.). The audit log uses the data from this database.
212+
- **Redis**: Used for caching, and as a key-value store for cron trigger manager.
213+
- **RabbitMQ**: Used for message queueing.
214+
215+
The following table reflects the recommended and supported versions of these databases for different Codefresh releases:
216+
217+
| Codefresh version | MongoDB | PostgreSQL | Redis | RabbitMQ |
218+
| :--- | :--- | :--- | :--- | :--- |
219+
| 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 |
220+
| 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 |
221+
| 2.7.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 6.0`)| 13.x | 7.0.x | 3.13.x |
222+
| 2.6.x | \>=4.2 \<=6.x <br> Recommended: 6.x (`featureCompatibilityVersion: 5.0`)| 13.x | 7.0.x | 3.13.x |
216223

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

0 commit comments

Comments
 (0)