diff --git a/docs/kafka/connect/images/connect-cluster-detail.png b/docs/kafka/connect/images/connect-cluster-detail.png new file mode 100644 index 000000000..8022fd1f8 Binary files /dev/null and b/docs/kafka/connect/images/connect-cluster-detail.png differ diff --git a/docs/kafka/connect/images/connect-connector-detail.png b/docs/kafka/connect/images/connect-connector-detail.png new file mode 100644 index 000000000..ddec96b3b Binary files /dev/null and b/docs/kafka/connect/images/connect-connector-detail.png differ diff --git a/docs/kafka/connect/images/connect-create-connector.png b/docs/kafka/connect/images/connect-create-connector.png new file mode 100644 index 000000000..dc8735b6e Binary files /dev/null and b/docs/kafka/connect/images/connect-create-connector.png differ diff --git a/docs/kafka/connect/images/connect-overview.png b/docs/kafka/connect/images/connect-overview.png new file mode 100644 index 000000000..f71044e8f Binary files /dev/null and b/docs/kafka/connect/images/connect-overview.png differ diff --git a/docs/kafka/connect/images/connect-plugins.png b/docs/kafka/connect/images/connect-plugins.png new file mode 100644 index 000000000..c988aa9c3 Binary files /dev/null and b/docs/kafka/connect/images/connect-plugins.png differ diff --git a/docs/kafka/connect/overview.md b/docs/kafka/connect/overview.md index dcfb0be61..fafa893e5 100644 --- a/docs/kafka/connect/overview.md +++ b/docs/kafka/connect/overview.md @@ -20,13 +20,69 @@ Common uses: ## Kafka Connect in AxonOps -AxonOps integrates with your Kafka Connect REST endpoints through the agent. -Once configured, you can: -- Discover Connect clusters and their versions. -- List connectors and view per-connector status. -- Create and update connector configurations. -- Pause, resume, stop, and restart connectors. -- Restart individual connector tasks. +AxonOps integrates with your Kafka Connect REST endpoints through the agent. +Once configured, you can manage your entire Connect deployment from the AxonOps UI. + +### Connect overview + +The Connect overview page provides a summary of all your Connect clusters at a glance. Summary cards show the total number of **Clusters**, **Connectors**, **Failed Connectors**, and **Failed Tasks** across your deployment. + +Below the summary cards, a table lists each Connect cluster with its connector and task counts. You can filter clusters by name and sort by any column. Click on a cluster row to drill into its details. + +![Connect overview](./images/connect-overview.png) + +### Cluster detail + +Clicking a cluster opens the cluster detail view. Summary cards show the cluster-level **Connectors** count, **Failed Connectors**, **Failed Tasks**, and the Connect **Version**. + +The view has two tabs: + +**Connectors** — Lists all connectors deployed to the cluster. Each row shows the connector name, class, type (source or sink), running tasks ratio and current state. You can filter by state and sort by any column. Click a connector row to view its full details. + +![Cluster detail — Connectors tab](./images/connect-cluster-detail.png) + +**Plugins** — Lists all connector plugins available on the cluster, showing the fully-qualified class name, version, and type (source or sink). + +![Cluster detail — Plugins tab](./images/connect-plugins.png) + +### Connector detail + +Selecting a connector opens the connector detail view. The header displays the connector name and its current state (e.g. **RUNNING**). + +![Connector detail](./images/connect-connector-detail.png) + +The page is divided into three sections: + +**Configuration** — A JSON editor showing the connector's current configuration. Click the **Edit** icon in the toolbar to modify and save changes. + +**Tasks** — A table listing each task with its ID, assigned worker address, current status, and a **Restart** button to restart individual tasks. + +### Connector lifecycle actions + +The connector toolbar provides the following actions: + +| Icon | Action | Description | +|------|--------|-------------| +| :material-pencil: | **Edit** | Open the configuration editor to update the connector | +| :material-refresh: | **Restart** | Restart the connector and all its tasks | +| :material-pause: | **Pause** | Pause the connector — tasks stop processing but are not removed | +| :material-stop: | **Stop** | Stop the connector — tasks are shut down | +| :material-delete: | **Delete** | Permanently remove the connector from the cluster | + +Individual tasks can be restarted from the **Tasks** table using the per-task **Restart** button. + +### Creating a connector + +Click the **Create Connector** button on the cluster detail page to open the creation dialog. + +![Create connector dialog](./images/connect-create-connector.png) + +Provide: + +1. **Connector Name** (mandatory) — A unique name for the connector. +2. **Configuration** — A JSON payload specifying the connector class and its settings. The editor is pre-populated with a template. + +Click **Create Connector** to deploy it to the cluster. ## Configure Kafka Connect access @@ -55,6 +111,7 @@ kafka: ``` Notes: + - `clusters` is a list; `name` is used to target a specific Connect cluster. - `username` and `password` enable HTTP basic auth. - `token` is supported in config files if your Connect endpoint uses token auth. @@ -82,28 +139,9 @@ CONNECT_CLIENT_CLUSTER_TLS_KEYFILEPATH=/etc/ssl/private/client.key CONNECT_CLIENT_CLUSTER_TLS_VERIFY_ENABLED=false ``` -Note on TLS verification: `CONNECT_CLIENT_CLUSTER_TLS_VERIFY_ENABLED` maps to the `insecureSkipTlsVerify` field. +Note on TLS verification: `CONNECT_CLIENT_CLUSTER_TLS_VERIFY_ENABLED` maps to the `insecureSkipTlsVerify` field. When set to `true`, certificate verification is skipped. -## Cluster discovery and status - -Once enabled, AxonOps can fetch: -- Cluster version, commit, and Kafka cluster ID. -- Available connector plugins. -- Connector list and status per cluster. - -## Connector lifecycle actions - -AxonOps supports the following connector operations: -- Create connector with a full configuration payload. -- Update connector configuration. -- Pause / Resume connector execution. -- Stop connector. -- Restart connector (optionally include tasks or only failed tasks). -- Restart individual connector tasks. - -These actions are executed against the Connect REST API through the agent. - ## Troubleshooting If you see no clusters or connectors: diff --git a/docs/kafka/schema-registry/images/schema-registry-create-subject.png b/docs/kafka/schema-registry/images/schema-registry-create-subject.png new file mode 100644 index 000000000..5e4737a93 Binary files /dev/null and b/docs/kafka/schema-registry/images/schema-registry-create-subject.png differ diff --git a/docs/kafka/schema-registry/images/schema-registry-overview.png b/docs/kafka/schema-registry/images/schema-registry-overview.png new file mode 100644 index 000000000..14739ceff Binary files /dev/null and b/docs/kafka/schema-registry/images/schema-registry-overview.png differ diff --git a/docs/kafka/schema-registry/images/schema-registry-subject-detail.png b/docs/kafka/schema-registry/images/schema-registry-subject-detail.png new file mode 100644 index 000000000..14287a21d Binary files /dev/null and b/docs/kafka/schema-registry/images/schema-registry-subject-detail.png differ diff --git a/docs/kafka/schema-registry/overview.md b/docs/kafka/schema-registry/overview.md index d4dbe1c2e..9ae0f3e15 100644 --- a/docs/kafka/schema-registry/overview.md +++ b/docs/kafka/schema-registry/overview.md @@ -32,6 +32,35 @@ AxonOps connects to your existing Kafka Schema Registry so you can browse schema - View Kafka store operations (consumer lag, flush times). - Collect Schema Registry logs. +### Subjects overview + +The Schema Registry page shows summary cards for the total number of **Subjects** and the global **Compatibility** level. Below the summary, a table lists all registered subjects with their latest version number, schema type (AVRO, JSON, or PROTOBUF), compatibility setting, and health status. + +You can filter subjects by name and sort by any column. Click a subject row to view its schema details. + +![Schema Registry overview](./images/schema-registry-overview.png) + +### Creating a new subject + +Click the **Create New Subject** button to open the creation dialog. Provide: + +1. **Subject** — The subject name (typically follows the `-key` or `-value` convention). +2. **Schema Type** — Select AVRO, JSON, or PROTOBUF from the dropdown. +3. **Schema** — Enter the schema definition in the editor. + +Click **Save schema** to register the new subject. + +![Create New Subject dialog](./images/schema-registry-create-subject.png) + +### Subject detail + +Selecting a subject opens the detail view. Summary cards show the current **Version**, **Type**, and **Compatibility** level for the subject. + +The schema definition is displayed in a syntax-highlighted JSON editor, allowing you to inspect the full structure of the schema including field names, types, and defaults. + +![Subject detail](./images/schema-registry-subject-detail.png) + + ## Prerequisites - A running Kafka Schema Registry service (AxonOps, Confluent, or compatible). @@ -93,12 +122,11 @@ After saving the file, restart axon-agent so it can connect. ## Use Schema Registry in AxonOps -1. Open **Kafka** in the AxonOps UI. -2. Select **Schema Registry**. -3. Choose the registry/cluster connection. -4. Monitor **metrics** and **logs** for the registry service. -5. Browse **subjects** and open a subject to view schema **versions** and details. -6. Use **Add schema** to register new schema versions. +1. Open your Kafka cluster in the AxonOps UI. +2. Select **Schema Registry** from the left navigation. +3. Browse the subjects table to find the schema you need. +4. Click a subject to view its schema definition and version history. +5. Use **Create New Subject** to register new schemas. Depending on your registry implementation and permissions, AxonOps may allow additional actions (such as changing compatibility or deleting versions). If your registry is read-only, AxonOps will still provide visibility into metrics, logs, subjects, and versions. diff --git a/mkdocs.yml b/mkdocs.yml index 1ad527302..288f039a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -272,6 +272,8 @@ nav: - Schema Registry: kafka/schema-registry/overview.md + - Connect: kafka/connect/overview.md + - Notification Integrations: - Overview : 'integrations/overview.md' - PagerDuty: 'integrations/pagerduty-integration.md'