diff --git a/docs/extend/auto-install-content-packages.md b/docs/extend/auto-install-content-packages.md new file mode 100644 index 00000000000..fae349c0fbf --- /dev/null +++ b/docs/extend/auto-install-content-packages.md @@ -0,0 +1,37 @@ +--- +description: Enable automatic installation for your content package if data with a matching dataset is ingested in Elasticsearch. +--- + +# Enable automatic installation for content packages [auto-install-content-packages] + +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. + +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. + +## Requirements [auto-install-content-packages-requirements] + +- {{kib}} version 9.2.0 or later +- The `format_version` in the content package's `manifest.yml` must specify `3.4.1` or later. + +## Configuration [auto-install-content-packages-configuration] + +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: + +```yml +# my_content_package/manifest.yml + +format_version: 3.4.1 +name: my_content_package +version: 1.0.0 +type: content + +# ... + +discovery: + fields: [] + datasets: + - name: my.dataset + - name: other.dataset +``` + +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}}. \ No newline at end of file diff --git a/docs/extend/build-new-integration.md b/docs/extend/build-new-integration.md index 7d0b9db4c3e..b57284ff0d0 100644 --- a/docs/extend/build-new-integration.md +++ b/docs/extend/build-new-integration.md @@ -15,6 +15,7 @@ Ready to monitor, ingest, and visualize something? Let’s get started. You’ll * [Edit ingest pipelines](/extend/edit-ingest-pipeline.md): Customize ingest pipelines to parse, enrich, and transform incoming data before it’s indexed. * [Edit field mappings](/extend/add-mapping.md): Specify and adjust field mappings to define the structure and types of your indexed data. * [Create and export dashboards](/extend/create-dashboards.md): Build {{kib}} dashboards and visualizations to explore and analyze the ingested data. +* [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}}. * [Testing and validation](/extend/testing-validation.md): Run tests and validate your integration to ensure it works as expected and meets quality standards. * [Finishing touches](/extend/finishing-touches.md): Finalize documentation, metadata, and package details to prepare your integration for release. * [Tips for building integrations](/extend/tips-for-building.md): Explore best practices and helpful advice to streamline your integration development process. diff --git a/docs/extend/toc.yml b/docs/extend/toc.yml index d0318bb0624..a2feec4d4fa 100644 --- a/docs/extend/toc.yml +++ b/docs/extend/toc.yml @@ -14,6 +14,7 @@ toc: - file: edit-ingest-pipeline.md - file: add-mapping.md - file: create-dashboards.md + - file: auto-install-content-packages.md - file: build-it.md - file: testing-validation.md - file: finishing-touches.md