@eventcatalog/core 3.35.0 → 3.36.1

package/dist/docs/plugins/backstage/02-api.md

@@ -0,0 +1,51 @@
+---
+sidebar_position: 1
+keywords:
+  - backstage
+sidebar_label: Backstage configuration
+title: Backstage configuration
+description: Getting started with Backstage and EventCatalog plugin
+---
+
+## Overview {#overview}
+
+Add the following to your `app-config.yaml` file.
+
+```yaml title="app-config.yaml"
+# Backstage configrations...
+
+# eventcatalog plugin configuration
+eventcatalog:
+  # URL of your catalog (has to be public, if private please raise and issue and we can fix this)
+  URL: "https://demo.eventcatalog.dev"
+```
+
+### Mapping your resources
+
+You can use backstage `annotations` to map your resources to EventCatalog resources.
+
+```yaml title="example-service.yaml"
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: example-service
+  annotations:
+    # The id of the resource in EventCatalog
+    eventcatalog.dev/id: "example-service"
+    # The version of the resource in EventCatalog (optional, latest is used if not provided)
+    eventcatalog.dev/version: "1.0.0" 
+    # The collection of the resource in EventCatalog (optional, uses the entity kind if not provided)
+    eventcatalog.dev/collection: "services"
+```
+
+| Annotation | Required | Default | Description |
+|------------|----------|---------|-------------|
+| `eventcatalog.dev/id` | Yes | - | The id of the resource in EventCatalog |
+| `eventcatalog.dev/version` | No | `latest` | The version of the resource in EventCatalog |
+| `eventcatalog.dev/collection` | No | Uses the entity kind | The collection of the resource in EventCatalog. Options include `services`, `domains`, `queries`, `commands`, `events` |
+
+
+
+
+Looking for more mappings? Let us know! Raise an issue on [GitHub](https://github.com/event-catalog/backstage-plugin-eventcatalog).
+

package/dist/docs/plugins/backstage/03-examples.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 1
+keywords:
+- components
+sidebar_label: Examples
+title: Examples
+description: Examples of using the AsyncAPI plugin
+---
+
+You can find an example of how to use Backstage and EventCatalog in the [EventCatalog Backstage Demo repository](https://github.com/event-catalog/backstage-eventcatalog-demo).
+
+Or you can watch a video tutorial on [how to setup Backstage and EventCatalog](https://www.youtube.com/watch?v=mjf7qwoSAC4).

package/dist/docs/plugins/backstage/_category_.json

@@ -0,0 +1,11 @@
+{
+  "label": "Backstage Plugin",
+  "collapsible": true,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "slug": "backstage",
+    "title": "Backstage",
+    "description": "Backstage integration with EventCatalog"
+  }
+}

package/dist/docs/plugins/confluent-schema-registry/00-intro.md

@@ -0,0 +1,90 @@
+---
+sidebar_position: 1
+keywords:
+- components
+sidebar_label: Introduction
+title: Introduction
+description: Getting started with AsyncAPI plugin
+---
+
+
+<!-- import PluginLicense from '@site/src/components/MDX/PluginLicense'; -->
+
+<!-- <PluginLicense url="#commercial-use" /> -->
+
+<iframe width="100%" height="515" src="https://www.youtube.com/embed/NMZKnPKx-L0?si=og1Nvnr3FfPfAqn4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+---
+
+Many folks building event-driven architecture are using [Apache Kafka](https://kafka.apache.org/) as their broker of choice. 
+
+[Confluent](https://www.confluent.io/) is a popular provider for Kafka and has a [Schema Registry](https://docs.confluent.io/platform/current/schema-registry/index.html) that can be used to store and manage your schemas.
+
+We believe schema registries can only go so far, and there is a lot of value adding semantic meaning to your schemas, assigning them owners, topics, services and domains.
+
+The [EventCatalog Confluent Schema Registry plugin](https://github.com/event-catalog/generators/tree/main/packages/generator-confluent-schema-registry) allows you to import your schemas into EventCatalog and keep them in sync along side your documentation. You can visualize your architecture and unlock value from your schema registries.
+
+:::info
+**What is Confluent Schema Registry?**: A schema registry for Apache Kafka. Use this to store and manage your schemas. You can read more about it on the [Confluent website](https://docs.confluent.io/platform/current/schema-registry/index.html).
+:::
+
+### Core Features of the Confluent Schema Registry plugin
+
+The EventCatalog Confluent Schema Registry plugin can provide you with many features:
+
+- ⭐️ Import your schemas from your Confluent Schema Registry into EventCatalog
+- ⭐️ Keep schemas in sync with your architecture documentation
+- ⭐️ Automatic versioning, as your schemas change they are versioned in EventCatalog along side your documentation
+- ⭐️ Add semantic meaning (markdown) to your schemas. Provide business context to your schemas and added value.
+- ⭐️ Use custom filters (prefix, suffix, includes) to select which schemas to import
+- ⭐️ Assign schemas to topics, services, domains and owners
+- ⭐️ Document your schemas as commands or events.
+- ⭐️ Visualize your kafka architecture with the [EventCatalog Visualizer](/features/visualization)
+- ⭐️ Download and view schemas in EventCatalog (AVRO, JSON, Protobuf)
+- ⭐️ Talk to your schemas, topics, producers and consumers with the [EventCatalog Chat](/features/ai-assistant)
+- ⭐️ and more....
+
+### How it works
+
+1. Install the Confluent Schema Registry plugin
+1. Configure the plugin (example; schemas, topics, commands, events,services, domains)
+1. Run the plugin to import your schemas into EventCatalog
+1. View and deploy your catalog
+
+![Example](/img/integrations/confluent-schema-registry/confluent.png)
+
+**What are generators?**
+
+EventCatalog supports [generators](/docs/plugins/generators). These are scripts or plugins that can be run to integrate with any external API, system or specification files. EventCatalog also provides an [SDK](/docs/sdk) to give developers easier access to their catalogs through custom scripts or generators.
+
+The EventCatalog Confluent Schema Registry plugin is a generator. It will import your schemas from your Confluent Schema Registry into EventCatalog.
+
+## Commercial and License
+
+This plugin requires a license key to be used. 
+
+You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
+
+After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization based on where you are in your governance and documentation journey.
+
+See [pricing](/pricing) for more information.
+
+_Have any questions? You can email us at `hello@eventcatalog.dev`._
+
+## Need a demo?
+
+If you would like a demo of the plugin, please feel free to reach out to us and book a time to chat at hello@eventcatalog.dev.
+
+## License FAQ
+
+### What is the license key for?
+The license key is required to use the Confluent Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
+
+### How do I get a license key?
+You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 14-day free trial.
+
+### Terms
+- **Trial Period**: 14 days free trial no credit card required
+- **Support**: Discord community support (extra for priority support)
+
+After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.

package/dist/docs/plugins/confluent-schema-registry/01-installation.md

@@ -0,0 +1,223 @@
+---
+sidebar_position: 1
+keywords:
+- EventCatalog Confluent Schema Registry
+sidebar_label: Installation
+title: Installation
+description: Installation of the EventCatalog Confluent Schema Registry plugin
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+import PluginLicense from '@site/src/components/MDX/PluginLicense';
+import Beta from '@site/src/components/MDX/Beta';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<PluginLicense url="#commercial-use" />
+
+The Confluent Schema Registry plugin is used to generate a catalog from a Confluent Schema Registry and import your schemas into EventCatalog.
+
+You can map your schemas from your Confluent Schema Registry to commands, events in your catalog, and assign these to services and domains.
+
+## Installation
+
+Run the command below to install the EventCatalog Confluent Schema Registry plugin.
+
+:::tip "Don't have an EventCatalog project yet?"
+If you don't have an EventCatalog project yet, you can follow the instructions in the [Getting Started](/docs/development/getting-started/installation) guide.
+:::
+
+<Tabs>
+  <TabItem value="apple" label="Install on existing catalog" default>
+    ```bash
+npm i @eventcatalog/generator-confluent-schema-registry
+```
+  </TabItem>
+  <TabItem value="orange" label="Create new catalog with Confluent Schema Registry plugin">
+     ```bash
+npx @eventcatalog/create-eventcatalog@latest my-catalog --template confluent-schema-registry
+```
+  </TabItem>
+</Tabs>
+
+## Configuration
+
+To use the plugin you need to configure it in your `eventcatalog.config.js` file.
+
+Add the plugin to the `generators` array.
+
+<Tabs>
+  <TabItem value="apple" label="Import all schemas" default>
+
+  In this example we import all schemas from a Confluent Schema Registry.
+
+  You can also create topics, and assign schemas to producers/consumers and domains. [(see examples)](/docs/plugins/confluent-schema-registry/plugin-configuration#example-configurations).
+
+
+  
+    ```js title="eventcatalog.config.js"
+    // ...
+    generators: [
+      // 1. Import all schemas from a Confluent Schema Registry
+      [
+        '@eventcatalog/generator-confluent-schema-registry',
+        {
+          // The URL of your Confluent Schema Registry
+          schemaRegistryUrl: 'http://localhost:8081',
+          // Do you want to include all versions of a schema? (default: false)
+          includeAllVersions: true
+        },
+      ],
+    ];
+    ```
+  </TabItem>
+  <TabItem value="orange" label="Import schemas, assign them to topics, services and domains">
+
+In this example we document topics from kafka, assign schemas to them, and schemas to producers/consumers (services).
+We create two domains, the `retail-domain` and the `communications-domain`.
+
+:::info "Why do we configure the plugin twice?"
+The generator can be configured as many times as you want.
+In this example we configure the plugin twice, the first time we import and create the `retail-domain` and the second time we assign the schemas to the `communications-domain`.
+:::
+
+```js title="eventcatalog.config.js"
+// ...
+ [
+  '@eventcatalog/generator-confluent-schema-registry',
+      {
+        // The URL of your Confluent Schema Registry
+        schemaRegistryUrl: 'http://localhost:8081',
+        // The topics (channels) to assign schemas to (optional)
+        topics: [{
+          id: 'orders-topic',
+          name: 'Orders Topic',
+          address: 'kafka-cluster-bootstrap:9092',
+        }, {
+          id: 'inventory-topic',
+          name: 'Inventory Topic',
+          address: 'kafka-cluster-bootstrap:9092',
+        }],
+        // The producers and consumers (services) to assign schemas to (optional)
+        services: [
+          {
+            id: 'Orders Service',
+            version: '1.0.0',
+            // the messages this service sends, this example sends events with a prefix of 'order-' to the 'orders-topic'
+            sends: [{ events: { prefix: 'order-' }, topic: 'orders-topic' }],
+            // the messages this service receives, this example receives events with a prefix of 'analytics-' from the 'inventory-topic'
+            receives: [{ events: { prefix: 'analytics-' }, topic: 'inventory-topic' }],
+          },
+          {
+            id: 'Inventory Service',
+            version: '1.0.0',
+            // the messages this service sends, this example sends events with a prefix of 'inventory-' to the 'inventory-topic'
+            sends: [{ events: { prefix: 'inventory-' }, topic: 'inventory-topic' }],
+            // the messages this service receives, this example receives events with a prefix of 'order-' from the 'orders-topic'
+            receives: [{ events: { prefix: 'order-' }, topic: 'orders-topic' }],
+          },
+        ],
+        domain: {
+          id: 'retail-domain',
+          name: 'Retail Domain',
+          version: '1.0.0',
+        }
+      },
+    ],
+  [
+    '@eventcatalog/generator-confluent-schema-registry',
+      {
+        // The URL of your Confluent Schema Registry
+        schemaRegistryUrl: 'http://localhost:8081',
+        // The topics (channels) to assign schemas to (optional)
+        topics: [{
+          id: 'users-topic',
+          name: 'Users Topic',
+          address: 'kafka-cluster-bootstrap:9092',
+        }, {
+          id: 'shipments-topic',
+          name: 'Shipments Topic',
+          address: 'kafka-cluster-bootstrap:9092',
+        }],
+        // The producers and consumers (services) to assign schemas to (optional)
+        services: [
+          {
+            id: 'Notifications Service',
+            version: '1.0.0',
+            receives: [
+              // the messages this service receives, this example receives events with a prefix of 'user-registered' from the 'users-topic'
+              { events: ['user-registered'], topic: 'users-topic' },
+              // the messages this service receives, this example receives events with a prefix of 'shipment-created' from the 'shipments-topic'
+              { events: ['shipment-created'], topic: 'shipments-topic' },
+              // the messages this service receives, this example receives events with a prefix of 'payment-received' from the 'payments-topic'
+              { events: ['payment-received'] }
+            ],
+          },
+        ],
+        domain: {
+          id: 'communications-domain',
+          name: 'Communications Domain',
+          version: '1.0.0',
+        }
+      },
+  ],
+```  
+  </TabItem>
+</Tabs>
+
+### Configure API keys
+
+The EventCatalog Confluent Schema Registry plugin requires API keys in your environment variables.
+
+1. A license key for the Confluent Schema Registry plugin (14 days trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
+2. Confluent Schema Registry API keys (found in the [Confluent Cloud](https://confluent.cloud) console)
+
+Create a `.env` file in the root, and add your keys to the project.
+
+```bash title=".env"
+# EventCatalog license key
+EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=your-license-key
+
+# Confluent Schema Registry API Keys
+CONFLUENT_SCHEMA_REGISTRY_KEY=your-confluent-schema-registry-key
+CONFLUENT_SCHEMA_REGISTRY_SECRET=your-confluent-schema-registry-key-secret
+```
+
+#### White listing EventCatalog domains
+
+If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
+
+#### Run the plugin
+
+Run the plugin to import your schemas into EventCatalog.
+
+_This command will run the generators in your eventcatalog.config.js file._
+
+```
+npm run generate
+```
+
+#### View your catalog
+
+Run your catalog locally to see the changes
+
+```
+npm run dev
+```
+
+#### Build your catalog for production
+
+```
+npm run build
+```
+
+
+
+## Any questions or need help?
+
+If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).
+
+You can also find some examples of the plugin in action in our examples repository: [eventcatalog/examples](https://github.com/event-catalog/generators/tree/main/examples/generator-confluent-schema-registry).
+
+
+