diff --git a/README.md b/README.md index a364c5e..1db9da4 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,39 @@ ## OpenSearch Catalog -The OpenSearch Catalog is designed to make it easier for developers and community to contribute, search and install artifacts like plugins, visualization dashboards, ingestion to visualization content packs (data pipeline configurations, normalization, ingestion, dashboards). The OpenSearch Catalog does this by providing a searchable catalog of community contributed OpenSearch artifacts and [projects](https://opensearch.org/community_projects) that users can browse, rate and download from the project website, OpenSearch CLI, and OpenSearch Dashboards. Users can install and update artifacts with a single click from OpenSearch Dashboards or by running an install/update command from OpenSearch CLI. When the artifacts have updates, they are highlighted in OpenSearch Dashboards to help users discover the latest versions of artifacts. +_For deeper dive into the catalog repository - please check our [main catalog documentation page ](docs/README.md)_ -We are requesting comments on our [RFC](https://github.com/opensearch-project/opensearch-catalog/issues/1). +The OpenSearch Catalog is designed to make it easier for developers and community to contribute, search and install artifacts like: + +### Integrations + - [Integrations](https://opensearch.org/docs/latest/integrations/) + - [Integrations Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/integrations/README.md) + [Integration Observability Catalog](https://htmlpreview.github.io/?https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/catalog.html) + +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. + + +### Visualization +- [Visualizations](https://opensearch.org/docs/latest/visualization/) +- [Visualizations Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/visualization/README.md) +- [Visualizations catalog](https://htmlpreview.github.io/?https://github.com/opensearch-project/opensearch-catalog/blob/main/visualization/observability/catalog.html) + +The Visualization Catalog is a central repository for organizing and sharing visualizations used in integrations developed using the standard simple schema mapping ( structure aware visual components). +This catalog aims to extend the usage of different data-visualization component for the benefit of delivering fast, configurable and context aware user experience. + + +### Schema +- [Schema Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/README.md) +- [Schema Instantiation](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/initiation.md) +- [Observability Schema ](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/observability/README.md) + +The Schema catalog for OpenSearch brings the concept of organized and structured catalog data. +A catalog of schemas is a comprehensive collection of all the possible data schemas or structures that can be used to represent information. + +--- +### Community +- [Community Forums](https://forum.opensearch.org/) +The Catalog is also about community involvement and contribution to the making of OpenSearch into a true content driven project. ## Security diff --git a/cli/catalog-web-builder.py b/cli/catalog-web-builder.py new file mode 100644 index 0000000..be13df1 --- /dev/null +++ b/cli/catalog-web-builder.py @@ -0,0 +1,109 @@ +import json + +# Read JSON data +with open('../integrations/observability/catalog.json', 'r') as file: + data = json.load(file) + +# Define a list of background colors with fade effect +background_colors = ["#f8f9fa", "#e9ecef", "#dee2e6", "#ced4da", "#adb5bd"] # Example light shades for fade effect + +# Start HTML content +html_content = f""" + + + + + + OpenSearch Observability Integrations Catalog + + + + + + + + + +
+ +

{data.get('displayName', '')}

+

Version: {data.get('version', '')}

+

URL: {data.get('url', '')}

+

Description: {data.get('description', '')}

+

License: {data.get('license', '')}

+

Labels: {", ".join(data.get('labels', []))}

+

Author: {data.get('author', '')}

+

Integrations

+""" + +# Start the grid layout with custom styles +html_content += """ + +
+
+""" + +# Iterate over components to create grid cells with borders and padding +for i, component in enumerate(data.get('components', [])): + if i % 6 == 0 and i != 0: + html_content += '
' # Start a new row after every 5 integrations + + html_content += f""" +
+ {component.get('component', '')} Logo +

{component.get('component', '')}

+
+ """ + + # Modal with integration details + html_content += f""" + + """ +html_content += """ +
+
+""" + +# ... write HTML content to file ... + + +# Write HTML content to file +with open('../integrations/observability/catalog.html', 'w') as file: + file.write(html_content) + +print("HTML file created successfully.") diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..a43d81f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ + + +## OpenSearch Catalog + +The OpenSearch Catalog is designed to make it easier for developers and community to contribute, search and install artifacts like: + +### Integrations +- [Integrations](https://opensearch.org/docs/latest/integrations/) +- [Integrations Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/integrations/README.md) +- [Integrations Creation](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/integrations/Integration-creation.md) + [Integration Observability Catalog](https://htmlpreview.github.io/?https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/catalog.html) + + +![](img/)![integrations-observability-catalog.png](img%2Fintegrations-observability-catalog.png) +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. + + +### Visualization +- [Visualizations](https://opensearch.org/docs/latest/visualization/) +- [Visualizations Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/visualization/README.md) +- [Visualizations Catalog](https://htmlpreview.github.io/?https://github.com/opensearch-project/opensearch-catalog/blob/main/visualization/observability/catalog.html) + +The Visualization Catalog is a central repository for organizing and sharing visualizations used in integrations developed using the standard simple schema mapping ( structure aware visual components). +This catalog aims to extend the usage of different data-visualization component for the benefit of delivering fast, configurable and context aware user experience. + +![service-duration.png](img%2Fvisualization%2Fservice-duration.png) + +### Schema +- [Schema Readme](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/README.md) +- [Schema Instantiation](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/initiation.md) +- [Observability Schema](https://github.com/opensearch-project/opensearch-catalog/blob/main/docs/schema/observability/README.md) + - [Observability Logs Schema](https://github.com/opensearch-project/opensearch-catalog/tree/main/docs/schema/observability/logs#readme) + - [Observability Traces Schema](https://github.com/opensearch-project/opensearch-catalog/tree/main/docs/schema/observability/traces#readme) + - [Observability Metrics Schema](https://github.com/opensearch-project/opensearch-catalog/tree/main/docs/schema/observability/metrics#readme) + + +The Schema catalog for OpenSearch brings the concept of organized and structured catalog data. +A catalog of schemas is a comprehensive collection of all the possible data schemas or structures that can be used to represent information. + +--- + diff --git a/docs/img/visualization/data_volume.png b/docs/img/visualization/data_volume.png new file mode 100644 index 0000000..c478e22 Binary files /dev/null and b/docs/img/visualization/data_volume.png differ diff --git a/docs/img/visualization/errors_over_time.png b/docs/img/visualization/errors_over_time.png new file mode 100644 index 0000000..2310226 Binary files /dev/null and b/docs/img/visualization/errors_over_time.png differ diff --git a/docs/img/visualization/http-network-graph.png b/docs/img/visualization/http-network-graph.png new file mode 100644 index 0000000..0294b0d Binary files /dev/null and b/docs/img/visualization/http-network-graph.png differ diff --git a/docs/img/visualization/service-duration.png b/docs/img/visualization/service-duration.png new file mode 100644 index 0000000..f91af40 Binary files /dev/null and b/docs/img/visualization/service-duration.png differ diff --git a/docs/img/visualization/service-map.png b/docs/img/visualization/service-map.png new file mode 100644 index 0000000..497290c Binary files /dev/null and b/docs/img/visualization/service-map.png differ diff --git a/docs/img/visualization/status_codes_over_time.png b/docs/img/visualization/status_codes_over_time.png new file mode 100644 index 0000000..fccc1ae Binary files /dev/null and b/docs/img/visualization/status_codes_over_time.png differ diff --git a/integrations/observability/aws_vpc_flow/static/logo.png b/integrations/observability/aws_vpc_flow/static/logo.png new file mode 100644 index 0000000..460d4ff Binary files /dev/null and b/integrations/observability/aws_vpc_flow/static/logo.png differ diff --git a/integrations/observability/catalog.html b/integrations/observability/catalog.html index 2a6e12b..4fdb11c 100644 --- a/integrations/observability/catalog.html +++ b/integrations/observability/catalog.html @@ -5,15 +5,22 @@ OpenSearch Observability Integrations Catalog + + + + + +
- Logo +

OpenSearch Observability Integrations Catalog

Version: 1.0

URL: https://github.com/opensearch-project/opensearch-catalog/integrations/observability

@@ -23,167 +30,299 @@

OpenSearch Observability Integrations Catalog

Author: OpenSearch

Integrations

-
-

Apache Integration

- Apache Integration Logo -

Description: Apache is an open source web server software for modern operating systems including UNIX and Windows.

-

Version: 1.0

-

URL: https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/apache

-

Tags: log, communication, http

-