Skip to content

Migrate from deprecated Kibana dashboard import API to general Saved Objects import API #20672

@joshdover

Description

@joshdover

In Kibana 7.0, the /api/kibana/dashboards/import endpoint was deprecated and replaced with the new general Saved Objects import API.

Today Beats still uses the legacy API here:

var importAPI = "/api/kibana/dashboards/import"

The legacy API will be removed in Kibana 8.0 and all Beats from 7.last+ will need to be using the new API. If you have any questions, feel free to reach out to @elastic/kibana-platform for assistance.

In order to implement this change we need to:

  1. Change the setup command to use the new API
  2. Convert all the dashboards in the beats codebase from the current format to saved objects.
  3. Change the module to packages importer so that it does not use the new code.

Regarding (2) a similar conversion is currently performed as part of the code that creates packages from modules so we could use some of that code, removing the transformations that are needed as part of the transition from modules to packages.

For (3) we would need to change the current migration to just performing the transformations in the saved object format.

TODO

  • use new importer endpoint in setup
  • use new exporter endpoint in export command
  • check documentation for Filebeat modules if the legacy endpoint is used
  • write script for converting dashboards
  • convert legacy dashboards to new format

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions