Skip to content

[REQUEST]: Document auto-install content packs feature for integration authors #1857

@kpollich

Description

@kpollich

Description

With elastic/kibana#226523 we now support automatically installing relevant content packs based on the discovery.datasets property in the content pack's manifest.yml file.

This feature is available without a feature flag in 9.2 as of elastic/kibana#232668.

We want to document the process of enabling auto-installation for content packs using these discovery fields. An example of this process is demonstrated in this PR for the system_otel content pack: elastic/integrations#14770

These docs should be available in https://www.elastic.co/docs/extend/integrations/build-new-integration.

Draft content below

Automatic Content Pack Installation

Kibana can automatically install content packs when it detects matching data in Elasticsearch. This feature uses the data_stream.dataset attribute to identify relevant content and install assets like dashboards without requiring user intervention.

How it works

When data is ingested with a specific data_stream.dataset value, Kibana checks for content packs that have declared an interest in that dataset. If a matching content pack is found, Kibana automatically installs it.

Configuration

To enable automatic installation for your content pack, add a discovery.datasets property to your manifest.yml:

# my_content_pack/manifest.yml

format_version: 3.4.1
name: my_content_pack
version: 1.0.0
type: content

# ...

discovery:
  datasets:
    - name: my.dataset

Once you publish a content pack with this configuration, Kibana will automatically install it when data arrives in Elasticsearch with data_stream.dataset: "my.dataset".

Requirements

  • Kibana 9.2.0
  • format_version 3.4.1 in content pack manifest

Resources

Collaboration

The product team will provide the initial content.

Point of contact.

Main contact: @kpollich

Stakeholders: @elastic/ecosystem

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions