6a569398ac
## Summary Allows one to export and import content packs in archive format. The format follows the integration content package's format so it becomes possible to import existing integration packages. Content packs only support dashboard assets at the moment. A pattern replacement logic has been implemented for dashboards and referenced data views: - at export time, any pattern matching the source stream will be replaced with a placeholder. Other patterns will remain as-is unless user explicitly ask to replace them - at import time, the placeholders are replaced with the target stream pattern For example, if a dashboard is first exported from stream `logs.nodejs` and reads data from patterns `logs.nodejs` and `logs.nodejs.prod`, the patterns will be updated to `logs.ruby` and `logs.ruby.prod` when imported into `logs.ruby` stream. The relevant UI components are hidden behind a feature flag, set the following in `kibana.dev.yml` to enable them: `feature_flags.overrides.featureFlagsStreams.contentPackUIEnabled: true` https://github.com/user-attachments/assets/9fb07daf-9fb9-4c62-9f5b-387e1833eaf0 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: tommyers-elastic <106530686+tommyers-elastic@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| examples | ||
| linters | ||
| output | ||
| overlays | ||
| scripts | ||
| bundle.json | ||
| bundle.serverless.json | ||
| kibana.info.serverless.yaml | ||
| kibana.info.yaml | ||
| makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
Kibana API reference documentation
Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted stateful and serverless docs.
Workflow
The final goal of this workflow is to produce an OpenAPI bundle containing all Kibana's public APIs.
Step 0
OAS from Kibana's APIs are continuously extracted and captured in bundle.json and bundle.serverless.json as fully formed OAS documentation. See node scripts/capture_oas_snapshot --help for more info.
These bundles form the basis of our OpenAPI bundles to which we append and layer extra information before publishing.
Step 1
Append pre-existing bundles not extracted from code using kbn-openapi-bundler to produce the final resulting bundles.
To add more files into the final bundle, edit the appropriate oas_docs/scripts/merge*.js files.
Step 2
Apply any final overalys to the document that might include examples or final tweaks (see the "Scripts" section for more details).
Scripts
The oas_docs/scripts folder contains scripts that point to the source domain-specific OpenAPI bundles and specify additional parameters for producing the final output bundle. Currently, there are the following scripts:
-
merge_ess_oas.jsscript produces production an output bundle for ESS -
merge_serverless_oas.jsscript produces production an output bundle for Serverless
Output Kibana OpenAPI bundles
The oas_docs/output folder contains the final resulting Kibana OpenAPI bundles
kibana.yamlproduction ready ESS OpenAPI bundlekibana.serverless.yamlproduction ready Serverless OpenAPI bundle
Bundling commands
Besides the scripts in the oas_docs/scripts folder, there is an oas_docs/makefile to simplify the workflow. Use make help to see available commands.