# Docs ## Superstream external - [Superstream](https://docs.superstream.ai/readme.md): Superstream automates Kafka optimization so you can focus on building, not babysitting brokers and clients. - [Step 1: Agent Deployment](https://docs.superstream.ai/getting-started/step-1-agent-deployment.md) - [Step 2: Create a Kafka User](https://docs.superstream.ai/getting-started/step-2-create-a-kafka-user.md) - [Step 3: Connect a Cluster](https://docs.superstream.ai/getting-started/step-3-connect-a-cluster.md) - [Step 4: What's next](https://docs.superstream.ai/getting-started/step-4-whats-next.md) - [Additional resources](https://docs.superstream.ai/getting-started/additional-resources.md) - [Agent (Engine) deployment](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related.md) - [Supertstream Agent (Engine) Deployment using existing secrets](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related/supertstream-engine-deployment-using-existing-secrets.md) - [How to deploy and manage Superstream using ArgoCD](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related/how-to-deploy-and-manage-superstream-using-argocd.md) - [Superstream Agent deployment for environments with a local container registry](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related/superstream-engine-deployment-for-environments-with-a-local-container-registry.md): How to deploy a Superstream Agent in a fully air-gapped environment with a private container registry. - [Supertstream Agent Deployment using custom resource limits](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related/supertstream-engine-deployment-using-custom-resource-limits.md) - [Superstream Platform deployment for Air-Gapped environments](https://docs.superstream.ai/getting-started/additional-resources/engine-deployment-related/superstream-platform-deployment-for-air-gapped-environments.md): This guide provides instructions for deploying the Superstream Platform for air-gapped environments. - [Agent (Engine) upgrade](https://docs.superstream.ai/getting-started/additional-resources/engine-upgrade-related.md) - [Upgrading From Helmfile based Deployment to Superstream Helm Chart](https://docs.superstream.ai/getting-started/additional-resources/engine-upgrade-related/upgrading-from-helmfile-based-deployment-to-superstream-helm-chart.md): This upgrade requires manual steps due to transitioning from a Helmfile-based deployment to the new Superstream Helm Chart. - [Kafka-related](https://docs.superstream.ai/getting-started/additional-resources/kafka-related.md) - [Required JMX rules](https://docs.superstream.ai/getting-started/additional-resources/kafka-related/required-jmx-rules.md) - [Datadog Integration: JMX Requirements for Kafka](https://docs.superstream.ai/getting-started/additional-resources/kafka-related/datadog-integration-jmx-requirements-for-kafka.md): To successfully integrate Datadog with Apache Kafka for metrics collection and monitoring, JMX (Java Management Extensions) must be enabled. - [Superstream MCP](https://docs.superstream.ai/getting-started/superstream-mcp.md) - [Kafka Cluster Optimization](https://docs.superstream.ai/products/kafka-cluster-optimization.md) - [Kafka Clients Optimization](https://docs.superstream.ai/products/kafka-clients-optimization.md) - [Getting started - Java](https://docs.superstream.ai/products/kafka-clients-optimization/getting-started-java.md) - [Getting started - Python](https://docs.superstream.ai/products/kafka-clients-optimization/getting-started-python.md) - [Getting started - Kafka Connect](https://docs.superstream.ai/products/kafka-clients-optimization/getting-started-kafka-connect.md): This guide shows how to integrate superstream-client into Kafka Connect so your connectors. - [Schema Registry Optimization](https://docs.superstream.ai/products/schema-registry-optimization.md) - [Setting up Slack Notifications](https://docs.superstream.ai/settings/notifications.md) - [Processed data](https://docs.superstream.ai/security-and-legal/processed-data.md): This page describes the processed data and metadata by Superstream engine - [Compliance](https://docs.superstream.ai/security-and-legal/compliance.md): Superstream maintains a robust compliance posture, adhering to internationally recognized standards and regulations - [Firewall rules](https://docs.superstream.ai/security-and-legal/firewall-rules.md): This page overviews the Superstream required networking - [Authentication](https://docs.superstream.ai/security-and-legal/authentication.md) - [Legal](https://docs.superstream.ai/security-and-legal/legal.md) - [Terms and Conditions](https://docs.superstream.ai/security-and-legal/legal/terms-and-conditions.md) - [Privacy Policy](https://docs.superstream.ai/security-and-legal/legal/privacy-policy.md) - [Executive Summary](https://docs.superstream.ai/solution-briefs/executive-summary.md): Superstream automates Kafka optimization so you can focus on building, not babysitting brokers and clients. - [Changelog](https://docs.superstream.ai/release-notes/changelog.md) - [Jun 26, 2025](https://docs.superstream.ai/release-notes/changelog/jun-26-2025.md) - [Feb 2, 2025](https://docs.superstream.ai/release-notes/changelog/feb-2-2025.md) - [Jan 11, 2025](https://docs.superstream.ai/release-notes/changelog/jan-11-2025.md) - [Dec 5, 2024](https://docs.superstream.ai/release-notes/changelog/dec-5-2024.md) - [Nov 1, 2024](https://docs.superstream.ai/release-notes/changelog/nov-1-2024.md) - [Oct 14, 2024](https://docs.superstream.ai/release-notes/changelog/oct-14-2024.md) - [Sep 24, 2024](https://docs.superstream.ai/release-notes/changelog/sep-24-2024.md) - [Sep 10, 2024](https://docs.superstream.ai/release-notes/changelog/sep-10-2024.md) - [August 26, 2024](https://docs.superstream.ai/release-notes/changelog/august-26-2024.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.superstream.ai/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.