Skip to content

Commit 8ed9905

Browse files
authored
fix: indxes docs (#60)
1 parent 1bcc3a6 commit 8ed9905

File tree

2 files changed

+43
-2
lines changed

2 files changed

+43
-2
lines changed

codefresh/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -834,6 +834,12 @@ Ref:
834834
- [Create an Index in Atlas DB](https://www.mongodb.com/docs/atlas/atlas-ui/indexes/#create-an-index)
835835
- [Create an Index with mongosh](https://www.mongodb.com/docs/manual/reference/method/db.collection.createIndex/)
836836

837+
##### ⚠️ Upgrading when the indexes are maintained manually
838+
839+
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.
840+
841+
You can follow [Upgrading section](#upgrading) to see what changes were made for indexes in every specific release.
842+
837843
### High Availability
838844

839845
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:
17421748
...
17431749
```
17441750

1745-
### To 2.0.12
1751+
### To 2-0-12
17461752

17471753
#### ⚠️ Legacy ChartMuseum subchart deprecation
17481754

@@ -2028,6 +2034,12 @@ cfapi:
20282034

20292035
[Auto-index creation in MongoDB](#auto-index-creation-in-mongodb)
20302036

2037+
#### ⚠️ New indexes in MongoDB
2038+
2039+
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:
2040+
2041+
- [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)
2042+
20312043
### To 2-7-0
20322044

20332045
### [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:
20592071
- "value"
20602072
```
20612073

2074+
#### ⚠️ New indexes in MongoDB
2075+
2076+
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:
2077+
2078+
> ⚠ **Note!** In case if you create indexes **before** the upgrade, please, create `codefresh.feature-store-versioned` collection manually in advance.
2079+
2080+
- [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)
2081+
- [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)
2082+
20622083
### To 2-8-0
20632084

20642085
### [What's new in 2.8.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-28)

codefresh/README.md.gotmpl

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -837,6 +837,11 @@ Ref:
837837
- [Create an Index in Atlas DB](https://www.mongodb.com/docs/atlas/atlas-ui/indexes/#create-an-index)
838838
- [Create an Index with mongosh](https://www.mongodb.com/docs/manual/reference/method/db.collection.createIndex/)
839839

840+
##### ⚠️ Upgrading when the indexes are maintained manually
841+
842+
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.
843+
844+
You can follow [Upgrading section](#upgrading) to see what changes were made for indexes in every specific release.
840845

841846
### High Availability
842847

@@ -1751,7 +1756,7 @@ nomios:
17511756
...
17521757
```
17531758

1754-
### To 2.0.12
1759+
### To 2-0-12
17551760

17561761
#### ⚠️ Legacy ChartMuseum subchart deprecation
17571762

@@ -2038,6 +2043,12 @@ cfapi:
20382043

20392044
[Auto-index creation in MongoDB](#auto-index-creation-in-mongodb)
20402045

2046+
#### ⚠️ New indexes in MongoDB
2047+
2048+
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:
2049+
2050+
- [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)
2051+
20412052
### To 2-7-0
20422053

20432054
### [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:
20692080
- "value"
20702081
```
20712082

2083+
#### ⚠️ New indexes in MongoDB
2084+
2085+
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:
2086+
2087+
> ⚠ **Note!** In case if you create indexes **before** the upgrade, please, create `codefresh.feature-store-versioned` collection manually in advance.
2088+
2089+
- [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)
2090+
- [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)
2091+
20722092
### To 2-8-0
20732093

20742094
### [What's new in 2.8.x](https://codefresh.io/docs/docs/whats-new/on-prem-release-notes/#on-premises-version-28)

0 commit comments

Comments
 (0)