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.gotmpl
+25-9Lines changed: 25 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1492,7 +1492,8 @@ Use [obtain-oidc-id-token](https://github.com/codefresh-io/steps/blob/822afc0a9a
1492
1492
1493
1493
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.
1494
1494
1495
-
> ℹ️ 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.
1495
+
> [!TIP]
1496
+
> 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.
1496
1497
1497
1498
### Index alignment
1498
1499
@@ -1515,11 +1516,12 @@ indexes
1515
1516
**Overview of the index alignment process:**
1516
1517
1517
1518
1. Identify the differences between the indexes in your MongoDB instance and the required index definitions.
1518
-
2. Create any missing indexes one by one. (It's important not to create them in bulk.)
1519
+
2. Create any missing indexes.
1519
1520
3. Perform the upgrade of Codefresh On-Prem installation.
1520
1521
4. Then remove any unnecessary indexes.
1521
1522
1522
-
> ⚠️ **Note! Any changes to indexes should be performed during a defined maintenance window or during periods of lowest traffic to MongoDB.**
1523
+
> [!IMPORTANT]
1524
+
> Any changes to indexes should be performed during a defined maintenance window or during periods of lowest traffic to MongoDB.**
1523
1525
>
1524
1526
> 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
1547
+
- Compare your indexes with the required indexes for the target release, and adjust them by creating any missing indexes or removing any unnecessary ones.
1546
1548
1547
1549
**Index creation**
1548
1550
1549
-
> ⚠ **Note! Always create indexes sequentially, one by one. Don't create them in bulk.**
1551
+
- To create an indexes, we recommend using the `createIndexes` command ([ref](https://www.mongodb.com/docs/manual/reference/command/createIndexes/)):
1550
1552
1551
-
- To create an index, use the `createIndex()` method:
1553
+
> [!IMPORTANT]
1554
+
> We recommend to create indexes in batches of 3 indexes at a time.
1555
+
> 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.
1556
+
>
1557
+
> 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.
1570
1585
1571
-
> ⚠️ **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/))
1586
+
> [!IMPORTANT]
1587
+
> 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/))
0 commit comments