Skip to content

Commit 11a04c6

Browse files
opensearch-trigger-bot[bot]github-actions[bot]TackAdamRyanL1997
authored
[Doc] Update the integraiton SOP to reference to dashbaords observability only (#2412) (#2419)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Adam Tackett <[email protected]> Co-authored-by: Jialiang Liang <[email protected]>
1 parent 14877ae commit 11a04c6

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

docs/integrations/setup.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SOP - OpenSearch Integration Setup
22

3-
**Date:** Jan 01, 2024
3+
**Date:** Apr 16, 2024
44

55
## Introduction
66

@@ -473,9 +473,9 @@ This feature allows users to bypass manual configuration by reusing pre-configur
473473
- During import, resolve conflicts by mapping the `.ndjson` index pattern to an existing one.
474474
- Ensure that required index patterns are created before importing visualizations.
475475

476-
## Publish to OpenSearch Catalog Repository
476+
## Publish to OpenSearch Dashboards Observability Repository
477477

478-
Once the integration has been validated and confirmed to function correctly, the final step is to share your work with a broader audience or make it accessible for reuse within your organization or community. Publishing your integration involves uploading the associated files and documentation to the OpenSearch Catalog GitHub repository, ensuring that other developers or teams can benefit from your efforts. This section provides a high-level guide to preparing, uploading, and publishing your integration.
478+
Once the integration has been validated and confirmed to function correctly, the final step is to share your work with a broader audience or make it accessible for reuse within your organization or community. Publishing your integration involves uploading the associated files and documentation to the OpenSearch Dashboards Observability GitHub repository, ensuring that other developers or teams can benefit from your efforts. This section provides a high-level guide to preparing, uploading, and publishing your integration.
479479

480480
Preparing for Publication
481481

@@ -484,7 +484,7 @@ Preparing for Publication
484484
- Ensure all relevant files are properly structured and clearly named, including:
485485
- Materialized View Queries: Save queries in a .sql file for easy reference.
486486
- .ndjson Files: Include all visualization and dashboard files.
487-
- Integration Documentation: Provide a README describing the integration setup, use case, and troubleshooting tips. Here is an example for an existing version of [Amazon CloudFront Integration’s README.md in OpenSearch Catalog Repo](https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/amazon_cloudfront/README.md).
487+
- Integration Documentation: Provide a `README.md` describing the integration setup, use case, and troubleshooting tips. Here is an example for an existing version of [AWS Network Firewall Integration’s README.md in OpenSearch Dashboards Observability Repo](https://github.com/opensearch-project/dashboards-observability/blob/main/server/adaptors/integrations/__data__/repository/amazon_networkfirewall/info/README.md).
488488

489489
**2. Include Metadata:**
490490

@@ -497,11 +497,8 @@ Preparing for Publication
497497

498498
- Test the integration end-to-end to confirm all components (e.g., dashboards, queries, indices) work as expected.
499499

500-
For detailed instructions on how to upload and manage integrations in the OpenSearch Catalog, please refer to the [OpenSearch Catalog Integration Documentation](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/integrations/README.md).
501-
502500
## Reference
503501

504502
- Creating Dashboards in OpenSearch: https://opensearch.org/docs/latest/dashboards/dashboard/index/
505503
- Flint Assets in OpenSearch Spark: https://github.com/opensearch-project/opensearch-spark/blob/main/docs/index.md
506504
- Documentation of Integrations in OpenSearch Dashboards: https://opensearch.org/docs/latest/integrations/
507-
- Guidance of Publish OpenSearch Integration Assets: https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/integrations/README.md

0 commit comments

Comments
 (0)