From bb92729ef9c624ef0e0673019a7944b5e95033cc Mon Sep 17 00:00:00 2001 From: Vasil Sudakou Date: Fri, 23 May 2025 16:53:25 +0300 Subject: [PATCH 1/2] fix: README.md --- codefresh/README.md.gotmpl | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/codefresh/README.md.gotmpl b/codefresh/README.md.gotmpl index 16b890f9c..a243fb284 100644 --- a/codefresh/README.md.gotmpl +++ b/codefresh/README.md.gotmpl @@ -837,6 +837,11 @@ Ref: - [Create an Index in Atlas DB](https://www.mongodb.com/docs/atlas/atlas-ui/indexes/#create-an-index) - [Create an Index with mongosh](https://www.mongodb.com/docs/manual/reference/method/db.collection.createIndex/) +##### ⚠️ Upgrading when the indexes are maintained manually + +If you maintain indexes manually and you upgrade your On-Prem installation you must create all indexes which were introduced from your current version up to the version you upgrade to manually. + +You can follow [Upgrading section](#upgrading) to see what changes were made for indexes in every specific release. ### High Availability @@ -1751,7 +1756,7 @@ nomios: ... ``` -### To 2.0.12 +### To 2-0-12 #### ⚠️ Legacy ChartMuseum subchart deprecation @@ -2038,6 +2043,12 @@ cfapi: [Auto-index creation in MongoDB](#auto-index-creation-in-mongodb) +#### ⚠️ New indexes in MongoDB + +If you maintain indexes manually (i.e. [Auto-index creation](#enabling-auto-index-creation) is off) you must create the following index **before** the upgrade: + +- [Database: `read-models`, collection: `images-binaries`, index: `accountId_1_imageName_1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/read-models/images-binaries.json#L75-L94) + ### To 2-7-0 ### [What's new in 2.7.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-27) @@ -2069,6 +2080,15 @@ global: - "value" ``` +#### ⚠️ New indexes in MongoDB + +If you maintain indexes manually (i.e. [Auto-index creation](#enabling-auto-index-creation) is off) you must create the following indexes **before or right after** the upgrade: + +> ⚠ **Note!** In case if you create indexes **before** the upgrade, please, create `codefresh.feature-store-versioned` collection manually in advance. + +- [Database: `codefresh`, collection: `feature-store-versioned`, index: `createdAt_1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/codefresh/feature-store-versioned.json#L2-L9) +- [Database: `codefresh`, collection: `feature-store-versioned`, index: `LDRedisStoreVersion_1__id_-1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/codefresh/feature-store-versioned.json#L10-L17) + ### To 2-8-0 ### [What's new in 2.8.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-28) From 9301695dd194bd587e5de322a1e54d37a1c2fb79 Mon Sep 17 00:00:00 2001 From: Vasil Sudakou Date: Fri, 23 May 2025 16:54:24 +0300 Subject: [PATCH 2/2] fix: README.md --- codefresh/README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/codefresh/README.md b/codefresh/README.md index 2f0d38d46..88ef27e63 100644 --- a/codefresh/README.md +++ b/codefresh/README.md @@ -834,6 +834,12 @@ Ref: - [Create an Index in Atlas DB](https://www.mongodb.com/docs/atlas/atlas-ui/indexes/#create-an-index) - [Create an Index with mongosh](https://www.mongodb.com/docs/manual/reference/method/db.collection.createIndex/) +##### ⚠️ Upgrading when the indexes are maintained manually + +If you maintain indexes manually and you upgrade your On-Prem installation you must create all indexes which were introduced from your current version up to the version you upgrade to manually. + +You can follow [Upgrading section](#upgrading) to see what changes were made for indexes in every specific release. + ### High Availability The chart installs the non-HA version of Codefresh by default. If you want to run Codefresh in HA mode, use the example values below. @@ -1742,7 +1748,7 @@ nomios: ... ``` -### To 2.0.12 +### To 2-0-12 #### ⚠️ Legacy ChartMuseum subchart deprecation @@ -2028,6 +2034,12 @@ cfapi: [Auto-index creation in MongoDB](#auto-index-creation-in-mongodb) +#### ⚠️ New indexes in MongoDB + +If you maintain indexes manually (i.e. [Auto-index creation](#enabling-auto-index-creation) is off) you must create the following index **before** the upgrade: + +- [Database: `read-models`, collection: `images-binaries`, index: `accountId_1_imageName_1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/read-models/images-binaries.json#L75-L94) + ### To 2-7-0 ### [What's new in 2.7.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-27) @@ -2059,6 +2071,15 @@ global: - "value" ``` +#### ⚠️ New indexes in MongoDB + +If you maintain indexes manually (i.e. [Auto-index creation](#enabling-auto-index-creation) is off) you must create the following indexes **before or right after** the upgrade: + +> ⚠ **Note!** In case if you create indexes **before** the upgrade, please, create `codefresh.feature-store-versioned` collection manually in advance. + +- [Database: `codefresh`, collection: `feature-store-versioned`, index: `createdAt_1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/codefresh/feature-store-versioned.json#L2-L9) +- [Database: `codefresh`, collection: `feature-store-versioned`, index: `LDRedisStoreVersion_1__id_-1`](https://github.com/codefresh-io/codefresh-onprem-helm/tree/release-2.8/indexes/codefresh/feature-store-versioned.json#L10-L17) + ### To 2-8-0 ### [What's new in 2.8.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-28)