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

add script for exporting dashboard #439

Open
mmguero opened this issue Mar 13, 2024 · 0 comments
Open

add script for exporting dashboard #439

mmguero opened this issue Mar 13, 2024 · 0 comments
Labels
dashboards Relating to Malcolm's OpenSearch Dashboards interface doc Relating to Malcolm documentation enhancement New feature or request
Milestone

Comments

@mmguero
Copy link
Collaborator

mmguero commented Mar 13, 2024

The contributor's guide gives instructions for exporting a newly created dashboard for inclusion in ./dashboards/dashboards in the Malcolm source repository, but this would be better to be at least a script. I think ideally the script would live inside the dashboards-helper container and could be executed using docker compose and avoid having to have dependencies outside the container.

The script would need to:

  1. call the /dashboards/api/opensearch-dashboards/dashboards/export API to get the dashboard by ID (perhaps it could be looked up by name, but ID is surer)
  2. remove the arkime_sessions3-* index pattern definition section completely
  3. replace the string arkime_sessions3-* with MALCOLM_NETWORK_INDEX_PATTERN_REPLACER and malcolm_beats_* with MALCOLM_OTHER_INDEX_PATTERN_REPLACER
  4. in my opinion, set any instances of highlightAll in the JSON to false
  5. return the exported/scrubbed dashboard JSON file
@mmguero mmguero added doc Relating to Malcolm documentation enhancement New feature or request dashboards Relating to Malcolm's OpenSearch Dashboards interface labels Mar 13, 2024
@mmguero mmguero added this to the z.staging milestone Mar 13, 2024
@mmguero mmguero modified the milestones: z.staging, v24.05.0 Mar 27, 2024
@mmguero mmguero modified the milestones: v24.05.0, v24.06.0 May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dashboards Relating to Malcolm's OpenSearch Dashboards interface doc Relating to Malcolm documentation enhancement New feature or request
Projects
Status: Todo (develop)
Development

No branches or pull requests

1 participant