You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/setup.md
+4-7
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# SOP - OpenSearch Integration Setup
2
2
3
-
**Date:**Jan 01, 2024
3
+
**Date:**Apr 16, 2024
4
4
5
5
## Introduction
6
6
@@ -473,9 +473,9 @@ This feature allows users to bypass manual configuration by reusing pre-configur
473
473
- During import, resolve conflicts by mapping the `.ndjson` index pattern to an existing one.
474
474
- Ensure that required index patterns are created before importing visualizations.
475
475
476
-
## Publish to OpenSearch Catalog Repository
476
+
## Publish to OpenSearch Dashboards Observability Repository
477
477
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.
479
479
480
480
Preparing for Publication
481
481
@@ -484,7 +484,7 @@ Preparing for Publication
484
484
- Ensure all relevant files are properly structured and clearly named, including:
485
485
- Materialized View Queries: Save queries in a .sql file for easy reference.
486
486
- .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).
488
488
489
489
**2. Include Metadata:**
490
490
@@ -497,11 +497,8 @@ Preparing for Publication
497
497
498
498
- Test the integration end-to-end to confirm all components (e.g., dashboards, queries, indices) work as expected.
499
499
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
-
502
500
## Reference
503
501
504
502
- Creating Dashboards in OpenSearch: https://opensearch.org/docs/latest/dashboards/dashboard/index/
505
503
- Flint Assets in OpenSearch Spark: https://github.com/opensearch-project/opensearch-spark/blob/main/docs/index.md
506
504
- 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