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""" + + +
+ + +Version: {data.get('version', '')}
+ +Description: {data.get('description', '')}
+License: {data.get('license', '')}
+Labels: {", ".join(data.get('labels', []))}
+Author: {data.get('author', '')}
+{component.get('component', '')}
+Version: 1.0
URL: https://github.com/opensearch-project/opensearch-catalog/integrations/observability
@@ -23,167 +30,299 @@Author: OpenSearch
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
-Apache Integration
+Description: Amazon CloudFront is a fast content delivery network (CDN) service that securely delivers data, videos, applications, and APIs to customers globally with low latency and high transfer speeds. CloudFront is integrated with other Amazon Web Services products to give developers and businesses an easy way to distribute content to end-users with low latency and high data transfer speeds.
-Version: 1.0
- -Tags: log, aws, s3, cloud, cloudfront
-Amazon CloudFront Integration
+Description: AWS CloudTrail is a service that enables governance, compliance, operational auditing, and risk auditing of your AWS account. With CloudTrail, you can log, continuously monitor, and retain account activity related to actions across your AWS infrastructure.
-Version: 1.0
- -Tags: log, aws, s3, cloud, cloudtrail
-Amazon CloudTrail Integration
+Description: ELB Access Logs is a feature that allows you to capture information about requests sent to your load balancer.
-Version: 1.0
- -Tags: log, aws, communication, http, cloud, elb, url
-Amazon ELB Integration
+Description: AWS RDS (Relational Database Service) is a managed service that makes it easy to set up, operate, and scale a relational database in the cloud.
-Version: 1.0
- -Tags: log, aws, s3, cloud, rds
-Amazon RDS Integration
+Description: Amazon S3 (Simple Storage Service) is an object storage service that offers industry-leading scalability, data availability, security, and performance. It is designed to make web-scale computing easier for developers.
-Version: 1.0
-URL: https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/aws_s3
-Tags: log, aws, s3, cloud
-Amazon S3 Integration
+Amazon VPC Flow Integration
+Description: AWS VPC Flow Logs is a feature that enables you to capture information about the IP traffic going to and from network interfaces in your VPC.
-Version: 1.0
- -Tags: log, aws, s3, cloud, communication, vpc
-Description: AWS WAF (Web Application Firewall) is a web application firewall service that helps protect your web applications from common web exploits that could affect application availability, compromise security, or consume excessive resources. AWS WAF provides firewall rules to filter and monitor HTTP/HTTPS requests based on specific conditions.
-Version: 1.0
- -Tags: log, aws, s3, cloud, waf
-Amazon WAF Integration
+Description: Kubernetes is an open-source container orchestration platform that automates the deployment, scaling, and management of containerized applications. It provides a robust and scalable infrastructure for running applications in a cloud-native environment. -/HTTPS requests based on specific conditions.
-Version: 1.0
-URL: https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/k8s
-Tags: log, k8s, cloud, container
-Kubernetes Integration
+Description: NGINX is open source software for web serving, reverse proxying, caching, load balancing, media streaming, and more./HTTPS requests based on specific conditions.
-Version: 1.0
-URL: https://github.com/opensearch-project/opensearch-catalog/blob/main/integrations/observability/nginx
-Tags: log, http, communication
-Nginx Integration
+