diff --git a/docs/integrations/integration-catalog.md b/docs/integrations/integration-catalog.md new file mode 100644 index 0000000..4e897fd --- /dev/null +++ b/docs/integrations/integration-catalog.md @@ -0,0 +1,55 @@ +# Integration Catalog + +The Integration catalog is a concept that focuses on grouping similar integration together to allow a meaningful way of introducing a common group into the user's working space. + +## Overview + +The catalog includes integrations for various systems and provides valuable insights into their behavior. + +The [catalog.json](https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/catalog.json) file describes the catalog metadata & content so that it can be presented and reviewed the user. + +> The **[OpenSearch Observability Integrations Catalog](https://github.com/opensearch-project/opensearch-catalog/integrations/observability)** is a collection of observability integrations that capture events and activities occurring in a system. + +### Version +Each catalog has a version which combines all the integration into one specific revision. +> Observability catalog is currently `Version: 1.0` + +### Description +Each catalog has a description that helps the user understand its relevant usage and context: +> Observability integrations capture information such as user actions, system responses, errors, and other contextual data. +> They can be used to visualize and troubleshoot performance issues, detect anomalies, and optimize system performance. + +## License +The Catalog overall licensing schema +> For example: Apache-2.0 + +## Author +The Catalog author (organization or a github user) +> OpenSearch + +### Integrations List +Each catalog has a list of components that each catalog is composed of, they are mostly commonly related to one another according to some general notion such as domain. + +**Example Component Structure** + +The Nginx Integration if part of the Observability Catalog: + +### Nginx Integration +- **Description**: NGINX is open-source software for web serving, reverse proxying, caching, load balancing, media streaming, and more. +- **Version**: 1.0 +- **URL**: [Nginx Integration on GitHub](https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/nginx) +- **Tags**: `log`, `http`, `communication` +- **Logo**: <_logo image url_> +- **Gallery**: + - **Dashboard**: <_dashboard image url_> + +--- + +### Observability Integration Catalog +Observability Integration Catalog is the default catalog which is bundled with OpenSearch release. + +_Here is the catalog summarization page that was auto generated as an html page to be published reviewed:_ + +[Integration Observability Catalog](https://htmlpreview.github.io/?https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/catalog.html) + +![](https://user-images.githubusercontent.com/48943349/262477858-e06e21b5-aa10-431d-93cc-81498ac39cf1.png) \ No newline at end of file