Skip to content

Add warning that changing the OpenSearch version deletes all search indexes #553

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.

Sign up for GitHub

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
poespas merged 1 commit into from
Nov 12, 2026
Merged

Add warning that changing the OpenSearch version deletes all search indexes #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions docs/hypernode-platform/tools/how-to-use-elasticsearch-on-hypernode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ In our release note you'll find a [more detailed description of Elasticsearch.](

## How to Enable Elasticsearch on Hypernode

**Please note that when you change versions all Elasticsearch data will be deleted.**
```{warning}
When you change versions all Elasticsearch data will be deleted.
```

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:

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

```

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.
```{warning}
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.
```

When you are using the default Magento implementation that should be OK since you can just re-index the data.

## How to Configure Magento to Use Elasticsearch

Expand Down
6 changes: 5 additions & 1 deletion docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To see which values you can set and which values they are allowed to have take a
| **nodejs_version**<br/><sub>Change the Node version</sub> | 22 | 6, 10, 16, 18, 20, 22, 24, 26 |
| **opensearch_auto_create_index**<br/><sub></sub> | True | True, False |
| **opensearch_enabled**<br/><sub>Enable OpenSearch</sub> | True | True, False |
| **opensearch_version**<br/><sub>Change the OpenSearch version</sub> | 2.12 | 1.x, 2.6, 2.12, 2.19, 3.3 |
| **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 |
| **openvpn_enabled**<br/><sub>Enables OpenVPN for secure database connections</sub> | False | True, False |
| **password_auth**<br/><sub>Indicates whether password authentication for the Hypernode is<br />allowed instead of only SSH keys</sub> | True | True, False |
| **permissive_memory_management**<br/><sub>Configure memory management policy (OOM kills)</sub> | False | True, False |
Expand Down Expand Up @@ -139,6 +139,10 @@ Indicates whether `use_index_extensions` and `mrr` are turned off. If turned off
- `opensearch_version`: Change the OpenSearch version
- `opensearch_auto_create_index`: Indicates whether OpenSearch is allowed to automatically create an index when a document is indexed into a non-existing index.

```{warning}
Changing the OpenSearch version will delete all search indexes. You will have to reindex the data from your application afterwards.
```

### Enabled IonCube

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!
Expand Down
Loading