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] Correct document for dashboards assistant #8733

Closed
1 of 4 tasks
yuye-aws opened this issue Nov 12, 2024 · 2 comments · Fixed by #8762
Closed
1 of 4 tasks

[DOC] Correct document for dashboards assistant #8733

yuye-aws opened this issue Nov 12, 2024 · 2 comments · Fixed by #8762
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress.

Comments

@yuye-aws
Copy link
Member

yuye-aws commented Nov 12, 2024

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.

Some part document of the dashboard assistant is not correct in this PR #8622. To be specific, the API in the following two files should not be POST /_plugins/_ml/agents/_register, but POST /_plugins/_flow_framework/workflow instead.

  1. _dashboards/dashboards-assistant/suggest-anomaly-detector.md
  2. _dashboards/dashboards-assistant/data-summary.md

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
2.18

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

@yuye-aws
Copy link
Member Author

Also, the following request mentioned here is directly writing into the system index .plugins-ml-config. This system index cannot be updated when security plugin is enabled.

POST /.plugins-ml-config/_doc/os_insight
{
  "type": "os_root_agent",
  "configuration": {
    "agent_id": "<ALERT_INSIGHTS_AGENT_ID>"
  }
}

@yuye-aws
Copy link
Member Author

@kolchfa-aws Can I get assigned to this issue? I'll create a PR to update the current doc.

@kolchfa-aws kolchfa-aws added 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants