Skip to content

Commit 80dd887

Browse files
authored
Merge pull request #553 from ByteInternet/opensearch-version-warning
Add warning that changing the OpenSearch version deletes all search indexes
2 parents 809c9b0 + 474d3cc commit 80dd887

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

‎docs/hypernode-platform/tools/how-to-use-elasticsearch-on-hypernode.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ In our release note you'll find a [more detailed description of Elasticsearch.](
2626

2727
## How to Enable Elasticsearch on Hypernode
2828

29-
**Please note that when you change versions all Elasticsearch data will be deleted.**
29+
```{warning}
30+
When you change versions all Elasticsearch data will be deleted.
31+
```
3032

3133
Elasticsearch can be enabled on all Hypernodes. To enable Elasticsearch, you can [talk to the API](https://community.hypernode.io/#/Documentation/hypernode-api/settings/README) or use the [hypernode-systemctl command-line tool](../tools/how-to-use-the-hypernode-systemctl-cli-tool.md). First configure the Elasticsearch version you wish to use. You can see the available versions of Elasticsearch which you can use on your Hypernode when running hypernode-systemctl settings. This will show the following:
3234

@@ -105,7 +107,11 @@ ssh -L 9200:localhost:9200 app@yourhypernodename.hypernode.io
105107

106108
```
107109

108-
If you ever need to switch between `6.x` to `7.x` or back after you have already been using it, note that **when you change versions all Elasticsearch data will be deleted**. When you are using the default Magento implementation that should be OK since you can just re-index the data.
110+
```{warning}
111+
If you ever need to switch between `6.x` and `7.x` or back after you have already been using it: when you change versions, all Elasticsearch data will be deleted.
112+
```
113+
114+
When you are using the default Magento implementation that should be OK since you can just re-index the data.
109115

110116
## How to Configure Magento to Use Elasticsearch
111117

‎docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To see which values you can set and which values they are allowed to have take a
5858
| **nodejs_version**<br/><sub>Change the Node version</sub> | 22 | 6, 10, 16, 18, 20, 22, 24, 26 |
5959
| **opensearch_auto_create_index**<br/><sub></sub> | True | True, False |
6060
| **opensearch_enabled**<br/><sub>Enable OpenSearch</sub> | True | True, False |
61-
| **opensearch_version**<br/><sub>Change the OpenSearch version</sub> | 2.12 | 1.x, 2.6, 2.12, 2.19, 3.3 |
61+
| **opensearch_version**<br/><sub>Change the OpenSearch version (note: changing the<br />version deletes all search indexes)</sub> | 2.12 | 1.x, 2.6, 2.12, 2.19, 3.3 |
6262
| **openvpn_enabled**<br/><sub>Enables OpenVPN for secure database connections</sub> | False | True, False |
6363
| **password_auth**<br/><sub>Indicates whether password authentication for the Hypernode is<br />allowed instead of only SSH keys</sub> | True | True, False |
6464
| **permissive_memory_management**<br/><sub>Configure memory management policy (OOM kills)</sub> | False | True, False |
@@ -139,6 +139,10 @@ Indicates whether `use_index_extensions` and `mrr` are turned off. If turned off
139139
- `opensearch_version`: Change the OpenSearch version
140140
- `opensearch_auto_create_index`: Indicates whether OpenSearch is allowed to automatically create an index when a document is indexed into a non-existing index.
141141

142+
```{warning}
143+
Changing the OpenSearch version will delete all search indexes. You will have to reindex the data from your application afterwards.
144+
```
145+
142146
### Enabled IonCube
143147

144148
This options allows you to enable IonCube if needed. Note: IonCube is a huge performance killer, so only enable it if you really need it!

0 commit comments

Comments
 (0)