Skip to content

Commit 20bbf48

Browse files
vishaangelovacolleenmcginnis
authored andcommitted
[Docs] Document enabling automatic installation for content packages (elastic#15701)
* Document enabling auto-install for content packages * Update docs/extend/auto-install-content-packages.md Co-authored-by: Colleen McGinnis <[email protected]> --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent 0506368 commit 20bbf48

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
description: Enable automatic installation for your content package if data with a matching dataset is ingested in Elasticsearch.
3+
---
4+
5+
# Enable automatic installation for content packages [auto-install-content-packages]
6+
7+
As of version 9.2.0, {{kib}} can automatically install content packages when it detects matching data in {{es}}. This feature uses the `data_stream.dataset` attribute to identify relevant content and install assets such as dashboards and alerts without requiring user intervention.
8+
9+
When data is ingested with a specific `data_stream.dataset` value, {{kib}} checks the {{package-registry}} for content packages that have at least one matching dataset defined in their `discovery.datasets` field. If there is a matching content package, {{kib}} automatically installs it.
10+
11+
## Requirements [auto-install-content-packages-requirements]
12+
13+
- {{kib}} version 9.2.0 or later
14+
- The `format_version` in the content package's `manifest.yml` must specify `3.4.1` or later.
15+
16+
## Configuration [auto-install-content-packages-configuration]
17+
18+
To enable automatic installation for your content package, add the `discovery.datasets` property to your package's `manifest.yml` file. This property should be defined as an array of objects, each with a `name` field specifying a dataset. For example:
19+
20+
```yml
21+
# my_content_package/manifest.yml
22+
23+
format_version: 3.4.1
24+
name: my_content_package
25+
version: 1.0.0
26+
type: content
27+
28+
# ...
29+
30+
discovery:
31+
fields: []
32+
datasets:
33+
- name: my.dataset
34+
- name: other.dataset
35+
```
36+
37+
If you publish a content package with this configuration, {{kib}} will automatically install the package when data with `data_stream.dataset: "my.dataset"` or `data_stream.dataset: "other.dataset"` is ingested in {{es}}.

docs/extend/build-new-integration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Ready to monitor, ingest, and visualize something? Let’s get started. You’ll
1515
* [Edit ingest pipelines](/extend/edit-ingest-pipeline.md): Customize ingest pipelines to parse, enrich, and transform incoming data before it’s indexed.
1616
* [Edit field mappings](/extend/add-mapping.md): Specify and adjust field mappings to define the structure and types of your indexed data.
1717
* [Create and export dashboards](/extend/create-dashboards.md): Build {{kib}} dashboards and visualizations to explore and analyze the ingested data.
18+
* [Enable automatic installation for content packages](/extend/auto-install-content-packages.md): Enable automatic installation for your content package if data with a matching dataset is ingested in {{es}}.
1819
* [Testing and validation](/extend/testing-validation.md): Run tests and validate your integration to ensure it works as expected and meets quality standards.
1920
* [Finishing touches](/extend/finishing-touches.md): Finalize documentation, metadata, and package details to prepare your integration for release.
2021
* [Tips for building integrations](/extend/tips-for-building.md): Explore best practices and helpful advice to streamline your integration development process.

docs/extend/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ toc:
1414
- file: edit-ingest-pipeline.md
1515
- file: add-mapping.md
1616
- file: create-dashboards.md
17+
- file: auto-install-content-packages.md
1718
- file: build-it.md
1819
- file: testing-validation.md
1920
- file: finishing-touches.md

0 commit comments

Comments
 (0)