You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-9Lines changed: 34 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1484,7 +1484,8 @@ Use [obtain-oidc-id-token](https://github.com/codefresh-io/steps/blob/822afc0a9a
1484
1484
1485
1485
Sometimes, in new releases of Codefresh On-Prem, index requirements change. When this happens, it's mentioned in the [Upgrading section](#upgrading) for the specific release.
1486
1486
1487
-
> ℹ️ If you're upgrading from version `X` to version `Y`, and index requirements were updated in any of the intermediate versions, you only need to align your indexes with the index requirements of version `Y`. To do that, follow [Index alignment](#index-alignment) instructions.
1487
+
> [!TIP]
1488
+
> If you're upgrading from version `X` to version `Y`, and index requirements were updated in any of the intermediate versions, you only need to align your indexes with the index requirements of version `Y`. To do that, follow [Index alignment](#index-alignment) instructions.
1488
1489
1489
1490
### Index alignment
1490
1491
@@ -1507,11 +1508,12 @@ indexes
1507
1508
**Overview of the index alignment process:**
1508
1509
1509
1510
1. Identify the differences between the indexes in your MongoDB instance and the required index definitions.
1510
-
2. Create any missing indexes one by one. (It's important not to create them in bulk.)
1511
+
2. Create any missing indexes.
1511
1512
3. Perform the upgrade of Codefresh On-Prem installation.
1512
1513
4. Then remove any unnecessary indexes.
1513
1514
1514
-
> ⚠️ **Note! Any changes to indexes should be performed during a defined maintenance window or during periods of lowest traffic to MongoDB.**
1515
+
> [!IMPORTANT]
1516
+
> Any changes to indexes should be performed during a defined maintenance window or during periods of lowest traffic to MongoDB.**
1515
1517
>
1516
1518
> Building indexes during time periods where the target collection is under heavy write load can result in reduced write performance and longer index builds. ([*Source: MongoDB official documentation*](https://www.mongodb.com/docs/manual/core/index-creation/#index-build-impact-on-database-performance))
- Compare your indexes with the required indexes for the target release, and adjust them by creating any missing indexes or removing any unnecessary ones
1538
+
- Compare your indexes with the required indexes for the target release, and adjust them by creating any missing indexes or removing any unnecessary ones.
1537
1539
1538
1540
**Index creation**
1539
1541
1540
-
> ⚠ **Note! Always create indexes sequentially, one by one. Don't create them in bulk.**
1542
+
- To create an indexes, we recommend using the `createIndexes` command ([ref](https://www.mongodb.com/docs/manual/reference/command/createIndexes/)):
1541
1543
1542
-
- To create an index, use the `createIndex()` method:
1544
+
> [!IMPORTANT]
1545
+
> We recommend to create indexes in batches of 3 indexes at a time.
1546
+
> However, it's highly recommended before creating indexes in production DB to test performance impact on a staging instance with prod-like amount of data.
1547
+
>
1548
+
> Previous command should be completed before starting the next batch.
If you're hosting MongoDB on [Atlas](https://www.mongodb.com/atlas/database), use the following [Manage Indexes](https://www.mongodb.com/docs/atlas/atlas-ui/indexes/) guide to View, Create or Remove indexes.
1561
1576
1562
-
> ⚠️ **Important!** In Atlas, for production environments, it is recommended to use rolling index builds by enabling the "Build index via rolling process" checkbox. ([*MongoDB official documentation*](https://www.mongodb.com/docs/v6.0/tutorial/build-indexes-on-replica-sets/))
1577
+
> [!IMPORTANT]
1578
+
> In Atlas, for production environments, it may be recommended to use rolling index builds by enabling the "Build index via rolling process" checkbox. ([*MongoDB official documentation*](https://www.mongodb.com/docs/v7.0/tutorial/build-indexes-on-replica-sets/))
1563
1579
1564
1580
## Upgrading
1565
1581
@@ -2360,6 +2376,15 @@ For built-in RabbitMQ `bitnami/rabbitmq` subchart, pre-upgrade hook was added to
2360
2376
2361
2377
- `.Values.runner`is removed
2362
2378
2379
+
#### Changes in MongoDB schema
2380
+
2381
+
Changes in indexes: follow [Maintaining MongoDB indexes](#maintaining-mongodb-indexes) guide to meet index requirements *before* the upgrade process.
2382
+
2383
+
Changes in collections: following collections can be safely dropped *after* the upgrade to 2.9.x if they exist:
2384
+
2385
+
- `read-models.application-tree`
2386
+
- `read-models.<entity>-history`— every collection with `~-history` suffix, such as `read-models.applications-history`, `read-models.services-history`, etc.
2387
+
2363
2388
## Troubleshooting
2364
2389
2365
2390
### Error: Failed to validate connection to Docker daemon; caused by Error: certificate has expired
0 commit comments