From 2a56bec0c9fa5c60bc62a1f1285a80cf8a300f30 Mon Sep 17 00:00:00 2001 From: Phil Bracikowski <13472206+philjb@users.noreply.github.com> Date: Wed, 20 Aug 2025 14:53:15 -0700 Subject: [PATCH 1/5] Adjust wording for the two types of tsi index: inmen and on disk tsi1 --- content/influxdb/v1/administration/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/v1/administration/upgrading.md b/content/influxdb/v1/administration/upgrading.md index f67dd08e4..3fffdadaf 100644 --- a/content/influxdb/v1/administration/upgrading.md +++ b/content/influxdb/v1/administration/upgrading.md @@ -9,7 +9,7 @@ menu: --- -We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.11.x). [Switch between TSM and TSI](#switch-index-types) as needed. To learn more about TSI, see: +We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.11.x). [Switch between TSI and inmem index types](#switch-index-types) as needed. To learn more about TSI, see: - [Time Series Index (TSI) overview](/influxdb/v1/concepts/time-series-index/) - [Time Series Index (TSI) details](/influxdb/v1/concepts/tsi-details/) From 127b15b6e2a7f126fde0ce5184b946663e394cb4 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 20 Aug 2025 17:25:15 -0500 Subject: [PATCH 2/5] fix(v1): improve TSI recommendation clarity and fix grammar typos - Make TSI recommendation more actionable by explaining benefits (removes RAM limits, better performance for high-cardinality data) - Fix "from to" grammar typos in index switching instructions - Add specific scenarios for when to switch between TSI and inmem index types - Remove "above" directional language per style guidelines Source: Verified against InfluxDB v1 documentation via MCP docs verification - TSI details: https://docs.influxdata.com/influxdb/v1/concepts/tsi-details/ - TSI overview: https://docs.influxdata.com/influxdb/v1/concepts/time-series-index/ --- content/influxdb/v1/administration/upgrading.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/influxdb/v1/administration/upgrading.md b/content/influxdb/v1/administration/upgrading.md index 3fffdadaf..4b9fa82b0 100644 --- a/content/influxdb/v1/administration/upgrading.md +++ b/content/influxdb/v1/administration/upgrading.md @@ -9,7 +9,7 @@ menu: --- -We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.11.x). [Switch between TSI and inmem index types](#switch-index-types) as needed. To learn more about TSI, see: +We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.11.x) because it removes RAM-based limits on series cardinality and provides better performance for high-cardinality datasets compared to the default in-memory index. [Switch between TSI and inmem index types](#switch-index-types) as needed. To learn more about TSI, see: - [Time Series Index (TSI) overview](/influxdb/v1/concepts/time-series-index/) - [Time Series Index (TSI) details](/influxdb/v1/concepts/tsi-details/) @@ -53,8 +53,8 @@ Run the `buildtsi` command using the user account that you are going to run the Switch index types at any time by doing one of the following: -- To switch from to `inmem` to `tsi1`, complete steps 3 and 4 above in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). -- To switch from to `tsi1` to `inmem`, change `tsi1` to `inmem` by completing steps 3a-3c and 4 above in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). +- To switch from `inmem` to `tsi1` (for example, when experiencing high memory usage or out-of-memory errors with high-cardinality data), complete steps 3 and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). +- To switch from `tsi1` to `inmem` (for example, for small datasets where memory is not a constraint), change `tsi1` to `inmem` by completing steps 3a-3c and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). ## Downgrade InfluxDB From e42df8a4adb24665e24d073362fb29a2647de66e Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 20 Aug 2025 17:48:58 -0500 Subject: [PATCH 3/5] docs(v1): restructure upgrade guide for better UX and progressive disclosure - Restructure content flow to follow progressive disclosure principles - Move index type decision to Important callout after basic upgrade steps - Improve headings with active voice ("Switch index types anytime") - Enhance callout formatting (Important, Tip, Warning callouts) - Consolidate Enterprise upgrade information into dedicated section - Improve information hierarchy and scanability Changes are primarily formatting and phrasing improvements to enhance developer experience and follow Google Developer Documentation best practices. --- .../influxdb/v1/administration/upgrading.md | 67 ++++++++++++------- 1 file changed, 43 insertions(+), 24 deletions(-) diff --git a/content/influxdb/v1/administration/upgrading.md b/content/influxdb/v1/administration/upgrading.md index 4b9fa82b0..33de0ea92 100644 --- a/content/influxdb/v1/administration/upgrading.md +++ b/content/influxdb/v1/administration/upgrading.md @@ -6,22 +6,12 @@ menu: name: Upgrade InfluxDB weight: 25 parent: Administration +related: + - /enterprise_influxdb/v1/guides/migration/ + - /enterprise_influxdb/v1/administration/upgrading/ --- - -We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.11.x) because it removes RAM-based limits on series cardinality and provides better performance for high-cardinality datasets compared to the default in-memory index. [Switch between TSI and inmem index types](#switch-index-types) as needed. To learn more about TSI, see: - -- [Time Series Index (TSI) overview](/influxdb/v1/concepts/time-series-index/) -- [Time Series Index (TSI) details](/influxdb/v1/concepts/tsi-details/) - -> **_Note:_** The default configuration continues to use TSM-based shards with in-memory indexes (as in earlier versions). - -{{% note %}} -### Upgrade to InfluxDB Enterprise - -To upgrade from InfluxDB OSS to InfluxDB Enterprise, [contact InfluxData Sales](https://www.influxdata.com/contact-sales/) -and see [Migrate to InfluxDB Enterprise](/enterprise_influxdb/v1/guides/migration/). -{{% /note %}} +Upgrade to the latest version of InfluxDB OSS v1. ## Upgrade to InfluxDB 1.11.x @@ -29,7 +19,26 @@ and see [Migrate to InfluxDB Enterprise](/enterprise_influxdb/v1/guides/migratio 2. Migrate configuration file customizations from your existing configuration file to the InfluxDB 1.11.x [configuration file](/influxdb/v1/administration/config/). Add or modify your environment variables as needed. -3. To enable TSI in InfluxDB 1.11.x, complete the following steps: +> [!Important] +> #### Choose your index type +> InfluxDB 1.11.x supports two index types: +> +> - **Time Series Index (TSI)** - Recommended for most users. Removes RAM-based limits on series cardinality and provides better performance for high-cardinality datasets. +> - **In-memory index (inmem)** - Default option that maintains compatibility with earlier versions but has RAM limitations. +> +> **When to use TSI:** +> - High-cardinality datasets (many unique tag combinations) +> - Experiencing high memory usage or out-of-memory errors +> - Large production deployments +> +> **When to use inmem:** +> - Small datasets where memory is not a constraint +> - Development or testing environments +> - Maintaining compatibility with existing tooling +> +> To learn more about TSI, see [Time Series Index overview](/influxdb/v1/concepts/time-series-index/) and [TSI details](/influxdb/v1/concepts/tsi-details/). + +3. **Optional:** To enable TSI in InfluxDB 1.11.x, complete the following steps: 1. If using the InfluxDB configuration file, find the `[data]` section, uncomment `index-version = "inmem"` and change the value to `tsi1`. @@ -43,26 +52,36 @@ and see [Migrate to InfluxDB Enterprise](/enterprise_influxdb/v1/guides/migratio ``` 4. Build TSI by running the [influx_inspect buildtsi](/influxdb/v1/tools/influx_inspect/#buildtsi) command. - {{% note %}} -Run the `buildtsi` command using the user account that you are going to run the database as, or ensure that the permissions match afterward. - {{% /note %}} + > [!Important] + > Run the `buildtsi` command using the user account that you are going to run the database as, or ensure that the permissions match afterward. 4. Restart the `influxdb` service. +> [!Tip] +> #### Switch index types anytime +> +> The default configuration continues to use TSM-based shards with in-memory indexes (as in earlier versions). You can [switch between TSI and inmem index types](#switch-index-types) at any time. + ## Switch index types -Switch index types at any time by doing one of the following: +You can switch between index types at any time after upgrading: -- To switch from `inmem` to `tsi1` (for example, when experiencing high memory usage or out-of-memory errors with high-cardinality data), complete steps 3 and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). -- To switch from `tsi1` to `inmem` (for example, for small datasets where memory is not a constraint), change `tsi1` to `inmem` by completing steps 3a-3c and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x). +**Switch from inmem to TSI:** +- Complete steps 3 and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x) +- Recommended when experiencing high memory usage or out-of-memory errors with high-cardinality data + +**Switch from TSI to inmem:** +- Change `tsi1` to `inmem` by completing steps 3a-3c and 4 in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x) +- Suitable for small datasets where memory is not a constraint ## Downgrade InfluxDB To downgrade to an earlier version, complete the procedures above in [Upgrade to InfluxDB 1.11.x](#upgrade-to-influxdb-111x), replacing the version numbers with the version that you want to downgrade to. After downloading the release, migrating your configuration settings, and enabling TSI or TSM, make sure to [rebuild your index](/influxdb/v1/administration/rebuild-tsi-index/). ->**Note:** Some versions of InfluxDB may have breaking changes that impact your ability to upgrade and downgrade. For example, you cannot downgrade from InfluxDB 1.3 or later to an earlier version. Please review the applicable version of release notes to check for compatibility issues between releases. +> [!Warning] +> Some versions of InfluxDB may have breaking changes that impact your ability to upgrade and downgrade. For example, you cannot downgrade from InfluxDB 1.3 or later to an earlier version. Please review the applicable version of release notes to check for compatibility issues between releases. -## Upgrade InfluxDB Enterprise clusters +## Upgrade to InfluxDB Enterprise -See [Upgrading InfluxDB Enterprise clusters](/enterprise_influxdb/v1/administration/upgrading/). +To upgrade from InfluxDB OSS to InfluxDB Enterprise, [contact InfluxData Sales](https://www.influxdata.com/contact-sales/). From 3aa4c0eae1c4ff0b7038bb58e1d1c2d6604babb9 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 21 Aug 2025 14:50:44 -0500 Subject: [PATCH 4/5] Update content/influxdb/v1/administration/upgrading.md --- content/influxdb/v1/administration/upgrading.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/content/influxdb/v1/administration/upgrading.md b/content/influxdb/v1/administration/upgrading.md index 33de0ea92..cff4beca5 100644 --- a/content/influxdb/v1/administration/upgrading.md +++ b/content/influxdb/v1/administration/upgrading.md @@ -27,14 +27,15 @@ Upgrade to the latest version of InfluxDB OSS v1. > - **In-memory index (inmem)** - Default option that maintains compatibility with earlier versions but has RAM limitations. > > **When to use TSI:** -> - High-cardinality datasets (many unique tag combinations) -> - Experiencing high memory usage or out-of-memory errors -> - Large production deployments -> +> - General purpose production instances. +> - Especially recommended for: +> - High-cardinality datasets (many unique tag combinations) +> - Experiencing high memory usage or out-of-memory errors +> - Large production deployments +> > **When to use inmem:** -> - Small datasets where memory is not a constraint -> - Development or testing environments -> - Maintaining compatibility with existing tooling +> - Small datasets when memory is not a constraint +> - Ephemeral deployments such as development or testing environments > > To learn more about TSI, see [Time Series Index overview](/influxdb/v1/concepts/time-series-index/) and [TSI details](/influxdb/v1/concepts/tsi-details/). From e7e59322acf12111ace325589c845c35d89a44f2 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 21 Aug 2025 14:57:22 -0500 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/influxdb/v1/administration/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/v1/administration/upgrading.md b/content/influxdb/v1/administration/upgrading.md index cff4beca5..de12b4046 100644 --- a/content/influxdb/v1/administration/upgrading.md +++ b/content/influxdb/v1/administration/upgrading.md @@ -24,7 +24,7 @@ Upgrade to the latest version of InfluxDB OSS v1. > InfluxDB 1.11.x supports two index types: > > - **Time Series Index (TSI)** - Recommended for most users. Removes RAM-based limits on series cardinality and provides better performance for high-cardinality datasets. -> - **In-memory index (inmem)** - Default option that maintains compatibility with earlier versions but has RAM limitations. +> - **In-memory index (inmem)** - Default option that maintains compatibility with earlier versions but is limited by available system RAM (series cardinality is limited by available RAM). > > **When to use TSI:** > - General purpose production instances.