-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(configuration): allow to specify Elasticsearch index settings (#337
) * Add missing settings fields in plugin configuration and use it during indices creation * Use correct spelling and adapt collection creation arguments to match recent changes * Update Docker Compose stack to use kuzzleio/kuzzle-runner:20 * Add documentation about the plugin configuration * Remove plural on assets to avoid breaking change on the configuration format * Remove plural on devices engine collection property to avoid breaking change
- Loading branch information
1 parent
865ae6d
commit 6d22fa9
Showing
5 changed files
with
255 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| --- | ||
| code: false | ||
| type: page | ||
| title: Configuration | ||
| description: Plugin configuration | ||
| --- | ||
|
|
||
| # Configuration | ||
|
|
||
| You can customize the behavior of the Device Manager plugin by providing a configuration object in the `plugins` section using the Kuzzle configuration file ([`kuzzlerc`](https://docs.kuzzle.io/core/2/guides/advanced/configuration/)). | ||
|
|
||
|
|
||
| ```js | ||
| { | ||
| "plugins": { | ||
| "device-manager": { | ||
| // Configuration options | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| # Options | ||
|
|
||
| ## Global | ||
|
|
||
| The following global options are available: | ||
|
|
||
| | Name | Type | Default | Description | | ||
| | --------------------- | ------- | ---------------- | -------------------------------------------------------------------------------------------------- | | ||
| | `ignoreStartupErrors` | boolean | `false` | If `true`, the plugin will not throw an error if the engine is not reachable at startup. | | ||
| | `engine.autoUpdate` | boolean | `true` | If `true`, the plugin will automatically update the engine collections when the plugin is started. | | ||
| | `adminIndex` | string | `device-manager` | The index name where the plugin stores its configuration and devices. | | ||
|
|
||
| ## Collections | ||
|
|
||
| In order to customize the collections used by the plugin, you can provide a configuration object for each collection. All of these support the following properties: | ||
|
|
||
| - `name`: The name of the collection. | ||
| - `mappings`: The mappings of the collection (according to the [Elasticsearch mapping specification](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)). | ||
| - `settings`: The settings of the collection (according to the [Elasticsearch settings specification](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html)). This property is optional but can be useful to define the number of shards and replicas of the Elasticsearch index or use custom analyzers. | ||
|
|
||
| ### Admin collections | ||
|
|
||
| The following collections are used by the plugin. They're automatically created when the plugin is started and shared accross all the engines. | ||
|
|
||
| - `devices`: The collection that stores the devices. | ||
| - `config`: The collection that stores the plugin configuration. | ||
| - `payloads`: The collection that stores the raw payloads before they are processed and decoded by the plugin. | ||
|
|
||
| ### Engine collections | ||
|
|
||
| The following collections are used by the plugin. They're automatically created when the plugin is started and are specific to each engine: | ||
|
|
||
| - `config`: The collection that stores the engine configuration. | ||
| - `device`: The collection that stores the devices. | ||
| - `measures`: The collection that stores the measures once extracted by the decoders. | ||
| - `asset`: The collection that stores the assets. | ||
| - `assetGroups`: The collection that stores the assets groups. | ||
| - `assetHistory`: The collection that stores the assets history. | ||
|
|
||
| # Example | ||
|
|
||
| ```js | ||
| { | ||
| "plugins": { | ||
| "device-manager": { | ||
| "ignoreStartupErrors": false, | ||
| "engine": { | ||
| "autoUpdate": true | ||
| }, | ||
| "adminIndex": "device-manager", | ||
| "adminCollections": { | ||
| "devices": { | ||
| "name": "devices", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "description": { "type": "text" }, | ||
| "type": { "type": "keyword" }, | ||
| "status": { "type": "keyword" }, | ||
| "lastSeen": { "type": "date" } | ||
| } | ||
| }, | ||
| "settings": { | ||
| "index": { | ||
| "number_of_shards": 1, | ||
| "number_of_replicas": 1 | ||
| } | ||
| } | ||
| }, | ||
| "config": { | ||
| "name": "config", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "value": { "type": "text" } | ||
| } | ||
| }, | ||
| "settings": { | ||
| "index": { | ||
| "number_of_shards": 1, | ||
| "number_of_replicas": 1 | ||
| } | ||
| } | ||
| }, | ||
| "payloads": { | ||
| "name": "payloads", | ||
| "mappings": { | ||
| "properties": { | ||
| "payload": { "type": "text" } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "engineCollections": { | ||
| "config": { | ||
| "name": "config", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "value": { "type": "text" } | ||
| } | ||
| } | ||
| }, | ||
| "devices": { | ||
| "name": "devices", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "description": { "type": "text" }, | ||
| "type": { "type": "keyword" }, | ||
| "status": { "type": "keyword" }, | ||
| "lastSeen": { "type": "date" } | ||
| } | ||
| } | ||
| }, | ||
| "measures": { | ||
| "name": "measures", | ||
| "mappings": { | ||
| "properties": { | ||
| "deviceId": { "type": "keyword" }, | ||
| "timestamp": { "type": "date" }, | ||
| "measures": { "type": "object" } | ||
| } | ||
| } | ||
| }, | ||
| "asset": { | ||
| "name": "assets", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "description": { | ||
| "type": "text", | ||
| "analyzer": "description" | ||
| }, | ||
| "type": { "type": "keyword" }, | ||
| "status": { "type": "keyword" } | ||
| } | ||
| }, | ||
| "settings": { | ||
| // Custom analyzer definition | ||
| "analysis": { | ||
| "analyzer": { | ||
| "description": { | ||
| "type": "custom", | ||
| "tokenizer": "whitespace" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "assetGroups": { | ||
| "name": "assetGroups", | ||
| "mappings": { | ||
| "properties": { | ||
| "name": { "type": "keyword" }, | ||
| "description": { "type": "text" }, | ||
| "type": { "type": "keyword" }, | ||
| "status": { "type": "keyword" } | ||
| } | ||
| } | ||
| }, | ||
| "assetHistory": { | ||
| "name": "assetHistory", | ||
| "mappings": { | ||
| "properties": { | ||
| "assetId": { "type": "keyword" }, | ||
| "timestamp": { "type": "date" }, | ||
| "status": { "type": "keyword" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.