Skip to content

fix: indxes docs #60

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.

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 2 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 22 additions & 1 deletion codefresh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -1742,7 +1748,7 @@ nomios:
...
```

### To 2.0.12
### To 2-0-12

#### ⚠️ Legacy ChartMuseum subchart deprecation

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
22 changes: 21 additions & 1 deletion codefresh/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -1751,7 +1756,7 @@ nomios:
...
```

### To 2.0.12
### To 2-0-12

#### ⚠️ Legacy ChartMuseum subchart deprecation

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
Loading