Skip to content

Commit

Permalink
docs: update Elasticsearch page sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuruyia committed Oct 8, 2024
1 parent d996a7e commit 8238fd6
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions doc/2/guides/elasticsearch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
code: false
type: branch
order: 400
title: Develop on Kuzzle | Guide | Core
title: Elasticsearch | Guide | Core
meta:
- name: description
content: Write custom backend code for Kuzzle
content: Explore how Kuzzle works with Elasticsearch
- name: keywords
content: Kuzzle, Documentation, kuzzle write pluggins, General purpose backend, opensource, Develop on Kuzzle
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
code: false
type: page
order: 50
title: Elasticsearch 8 | Develop on Kuzzle | Guide | Core
title: Migrate to Elasticsearch 8 | Elasticsearch | Guide | Core
meta:
- name: description
content: Extend Kuzzle API with controllers and actions
content: Migrate your Kuzzle project from Elasticsearch 7 to Elasticsearch 8
- name: keywords
content: Kuzzle, Documentation, kuzzle write pluggins, General purpose backend, iot, backend, opensource, API Controllers
---
Expand All @@ -26,12 +26,12 @@ The default major version of Elasticsearch will be 7 until the next major versio

## How to setup your project to use Elasticsearch 8

### Setup Kuzzle to use Elasticsearch 8
### Setup Kuzzle to use Elasticsearch 8

#### Upgrade the npm package
First you need to upgrade you Kuzzle package to version `>= 2.30.0-es8` in the `package.json` file. Then run `npm install` to upgrade the packages for you application.

### Configure Kuzzle
### Configure Kuzzle
A new configuration key `majorVersion` has been introduced ine the `storageEngine` section to allow the selection of the Eleasticsearch version you want to support for your project.

When not specified, it will be considered to be version 7, specify 8 if you want to switch Kuzzle to support Elasticasearch 8.
Expand All @@ -53,7 +53,7 @@ You can not set the `majorVersion` key to 8 if you are using a version of Kuzzle
:::

:::info
Kuzzle cannot connect to both Elasticsearch 7 and Elasticsearch 8 at the same time.
Kuzzle cannot connect to both Elasticsearch 7 and Elasticsearch 8 at the same time.
:::

Once the version is set to 8, Kuzzle will use the Elasticsearch 8 API to communicate with the database.
Expand Down
12 changes: 6 additions & 6 deletions doc/2/guides/elasticsearch/v8/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
code: false
type: page
order: 100
title: Elasticsearch 8 | Develop on Kuzzle | Guide | Core
title: Elasticsearch 8 | Elasticsearch | Guide | Core
meta:
- name: description
content: Extend Kuzzle API with controllers and actions
content: Configure Kuzzle to use Elasticsearch 8
- name: keywords
content: Kuzzle, Documentation, kuzzle write pluggins, General purpose backend, iot, backend, opensource, API Controllers
---
Expand All @@ -22,13 +22,13 @@ Kuzzle exposes the [Elasticsearch Query Language](/core/2/guides/main-concepts/q

The support of Elasticsearch 8 has been introduced in Kuzzle 2.30.0.

The choice has been made to keep Kuzzle compatible to avoid breaking changes around the support of ES8.
The choice has been made to keep Kuzzle compatible to avoid breaking changes around the support of ES8.

We wanted to allow the user to **opt-in** for this feature, so no modification is needed on your behalf if you want to keep using Elasticsearch 7.

The default major version of Elasticsearch will be 7 until Kuzzle v3.

The new configuration key to change the version supported is available under:
The new configuration key to change the version supported is available under:

```json
{
Expand All @@ -41,11 +41,11 @@ The new configuration key to change the version supported is available under:
```

:::warning
You can not set the `majorVersion` key to 8 if you are using a version of Kuzzle that does not support it.
You can not set the `majorVersion` key to 8 if you are using a version of Kuzzle that does not support it.
:::

:::info
Kuzzle cannot connect to both Elasticsearch 7 and Elasticsearch 8 at the same time.
Kuzzle cannot connect to both Elasticsearch 7 and Elasticsearch 8 at the same time.
:::

Once the version is set to 8, Kuzzle will use the Elasticsearch 8 API to communicate with the database.
Expand Down

0 comments on commit 8238fd6

Please sign in to comment.