Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add documentation about how to export/import OpenSearch Dashboards saved objects #3799

Open
1 of 4 tasks
joshuarrrr opened this issue Apr 17, 2023 · 3 comments
Open
1 of 4 tasks
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started Sev2 High-medium priority. Upcoming release or incorrect information.

Comments

@joshuarrrr
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

Example user question:

Hey folks! Is there a way to export an existing dashboard from one opensearch instance to another? The index being visualized is identical on both instances

Example response:

Yeah, there are a couple ways. Through the UI, go to /app/management/opensearch-dashboards/objects. Then you can select which saved objects you want to export. For a dashboard, you’ll want all the associated visualizations as well, so you’ll want to make sure “Include related objects” remains checked. Then you can import from the same UI on the other instance.

Ideally the documentation should cover no just exporting/importing from the UI, as described above, but also via the Saved Object API.

User provided usage example: opensearch-project/OpenSearch-Dashboards#987 (comment)

Additional examples and background info about the Saved Object system index: opensearch-project/OpenSearch-Dashboards#1647

Many more user-provided API examples: opensearch-project/OpenSearch-Dashboards#1723

We should also provide a section with caveats and limitations, such as the file size limit: opensearch-project/OpenSearch-Dashboards#1166

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

On the OpenSearch Dashboards side, we need to do some work to ensure that the UI and API make cross-compatible file formats: opensearch-project/OpenSearch-Dashboards#1526

@joshuarrrr
Copy link
Member Author

Another related forum question: https://forum.opensearch.org/t/how-to-create-index-pattern-through-dashboards-api/13928/2

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started Sev2 High-medium priority. Upcoming release or incorrect information. and removed untriaged labels May 1, 2023
@vagimeli
Copy link
Contributor

vagimeli commented Sep 6, 2023

@kolchfa-aws See https://github.com/opensearch-project/documentation-website/pull/4876/files, as the UI has changed and Saved Objects documentation should be under the new structure.

@Alwinius
Copy link

Alwinius commented Oct 2, 2023

I found out that the parameters from Kibana seem to work when using the Saved Objects API: https://www.elastic.co/guide/en/kibana/current/saved-objects-api-import.html This could and should also be part of the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started Sev2 High-medium priority. Upcoming release or incorrect information.
Projects
None yet
Development

No branches or pull requests

5 participants