# StreamNative Documentation: StreamNative Cloud ## StreamNative Cloud - [StreamNative Cloud / Pulsar (392 pages)](https://docs.streamnative.io/_llms/stream-native-cloud/pulsar.md): Documentation for StreamNative Cloud / Pulsar. - [StreamNative Cloud / Kafka (162 pages)](https://docs.streamnative.io/_llms/stream-native-cloud/kafka.md): Documentation for StreamNative Cloud / Kafka. - [StreamNative Cloud / Resources (146 pages)](https://docs.streamnative.io/_llms/stream-native-cloud/resources.md): Documentation for StreamNative Cloud / Resources. ### Welcome - [Start building with StreamNative](https://docs.streamnative.io/home.md): Stream with Apache Pulsar and Apache Kafka, build agents on the Agent Engine. Run it all on StreamNative Cloud. ### Concepts #### Overview - [Welcome to StreamNative Cloud](https://docs.streamnative.io/cloud/overview/cloud-overview.md) - [StreamNative Cloud Concepts](https://docs.streamnative.io/cloud/overview/concepts-overview.md) - [Data Streaming Engine](https://docs.streamnative.io/cloud/overview/data-streaming-engine.md) - [Lakestream Architecture](https://docs.streamnative.io/cloud/overview/lakestream-overview.md): Lakestream is the cloud-native architecture that unifies streaming and lakehouse storage. It powers both StreamNative Kafka Service and Pulsar Service. - [Choose Kafka or Pulsar](https://docs.streamnative.io/cloud/overview/choose-kafka-or-pulsar.md): Choose the right protocol for your workload. Kafka for event streaming, Pulsar for messaging and multi-protocol workloads. - [Kafka and Pulsar Concepts Map](https://docs.streamnative.io/cloud/overview/kafka-pulsar-concepts.md): Map concepts between Apache Kafka and Apache Pulsar. Understand how topics, consumer groups, and partitions translate between protocols. #### Clusters - [StreamNative Cloud Clusters Overview](https://docs.streamnative.io/cloud/clusters/streamnative-cluster-overview.md) - [Cluster Profiles Overview](https://docs.streamnative.io/cloud/clusters/cluster-profiles-overview.md) - [Cluster Types & Regions in StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/cluster-types.md) #### Reference - [Glossary of Terms & Concepts](https://docs.streamnative.io/cloud/references/glossary.md) - [Understanding StreamNative Cloud objects](https://docs.streamnative.io/cloud/references/cloud-object.md) ### SQL #### Overview - [SQL Workspaces Architecture (Private Preview)](https://docs.streamnative.io/sql/overview/architecture.md): Understand how SQL Workspaces, SQL Catalogs, SQL Studio, and PostgreSQL clients work together. - [SQL Workspace](https://docs.streamnative.io/sql/overview/sqlworkspace.md): Understand the SQL Workspace resource, engine model, lifecycle, and query endpoints. ##### SQL Catalog - [SQL Catalog](https://docs.streamnative.io/sql/overview/sqlcatalog.md): Understand how SQL Catalog connects Pulsar and Kafka clusters to a SQL Workspace. - [SQL Workspaces Source Discovery](https://docs.streamnative.io/sql/overview/source-discovery.md): Understand how eligible Pulsar and Kafka topics become managed sources in a SQL Workspace. - [SQL Catalog Schema Support](https://docs.streamnative.io/sql/overview/schema-support.md): Review the topic schemas supported by SQL Catalog source discovery during Private Preview. - [SQL Workspaces Naming Rules](https://docs.streamnative.io/sql/overview/naming-rules.md): Understand how SQL Catalog databases, schemas, and managed topic sources are named. #### Get Started - [Get Started with SQL Workspaces (Private Preview)](https://docs.streamnative.io/sql/get-started/get-started.md): Choose a StreamNative Cloud Console or query workflow for SQL Workspaces. - [Cloud CLI](https://docs.streamnative.io/sql/get-started/cli/cloud-cli.md): Understand StreamNative Cloud CLI support for SQL Workspace and SQL Catalog resources. ##### Cloud Console - [Create a SQL Workspace in the Cloud Console](https://docs.streamnative.io/sql/get-started/console/create-sqlworkspace.md): Create a SQL Workspace and select its engine in the StreamNative Cloud Console. - [Add a SQL Catalog in the Cloud Console](https://docs.streamnative.io/sql/get-started/console/add-sqlcatalog.md): Connect a StreamNative Pulsar or Kafka cluster to a SQL Workspace as a SQL Catalog. - [Query with SQL Studio](https://docs.streamnative.io/sql/get-started/console/query-sql-studio.md): Browse managed topic sources and run SQL in the StreamNative Cloud Console. - [Connect with a PostgreSQL Client](https://docs.streamnative.io/sql/get-started/console/connect-postgresql-client.md): Connect a PostgreSQL-compatible client to a SQL Workspace native endpoint. #### Operations - [Manage SQL Workspaces](https://docs.streamnative.io/sql/operations/manage-sqlworkspaces.md): Inspect and delete SQL Workspace resources in the StreamNative Cloud Console. - [Manage SQL Catalogs](https://docs.streamnative.io/sql/operations/manage-sqlcatalogs.md): Inspect, add, and remove SQL Catalog databases in a SQL Workspace. - [Data Retention](https://docs.streamnative.io/sql/operations/data-retention.md): Understand what happens to SQL Workspace and SQL Catalog data when you delete a resource. #### Access Control - [SQL Workspaces Access Control](https://docs.streamnative.io/sql/access-control/access-control-overview.md): Understand the cloud resource and SQL Workspace engine permission layers for SQL Workspaces. - [Cloud Resource Access](https://docs.streamnative.io/sql/access-control/cloud-resource-access.md): Understand how StreamNative Cloud roles govern SQL Workspace and SQL Catalog resources. ##### SQL Workspace Engine Access - [SQL Workspace Engine Access](https://docs.streamnative.io/sql/access-control/sql-engine-access.md): Understand the cloud-user and machine-to-machine identity models for a SQL Workspace engine. - [Cloud User Access](https://docs.streamnative.io/sql/access-control/cloud-user-access.md): Understand how StreamNative Cloud users become SQL Workspace engine administrators. - [Machine-to-Machine Access](https://docs.streamnative.io/sql/access-control/machine-to-machine-access.md): Create a dedicated SQL Workspace engine identity for an application or automated workload. ### Agent Engine #### Overview - [StreamNative Orca Agent Platform (Private Preview)](https://docs.streamnative.io/agent-engine/agents-overview.md): Deploy and manage AI agents processing real-time data at scale with the StreamNative Orca Agent Platform private preview. #### Get Started - [Set Up Your Environment](https://docs.streamnative.io/agent-engine/agents-setup.md): Prepare StreamNative Cloud accounts and permissions to deploy Orca Agents. #### Develop Agents - [Develop ADK Agents](https://docs.streamnative.io/agent-engine/develop-agents/agents-develop-adk.md): Build and package Google ADK agents for Orca Engine and deploy them with snctl. - [Develop OpenAI Agents](https://docs.streamnative.io/agent-engine/develop-agents/agents-develop-openai.md): Build and package OpenAI Agents SDK projects for Orca Engine and deploy them with snctl. #### Operations - [Manage Agents](https://docs.streamnative.io/agent-engine/agents-manage.md): Use snctl to update, control, and inspect Orca Agents running on StreamNative Cloud. - [Configure Model Access](https://docs.streamnative.io/agent-engine/agents-model.md): Manage large language model (LLM) provider credentials with StreamNative cloud Secrets and bind them to Orca Engine agents. - [Monitor and Troubleshoot Agents](https://docs.streamnative.io/agent-engine/agents-monitoring.md): Learn how to inspect Orca agent health, review logs, and stream diagnostics to messaging topics. #### Integrations - [Agent Context Reference](https://docs.streamnative.io/agent-engine/agents-context.md): Understand the Orca Engine AgentContext APIs for accessing runtime data, state, and session controls. - [Managed Agent Tools](https://docs.streamnative.io/agent-engine/agents-tools.md): Learn how Orca Engine discovers agent tools, integrates Model Context Protocol servers, and keeps tool sets current at runtime. #### MCP - [StreamNative MCP Server](https://docs.streamnative.io/agent-engine/mcp/mcp-overview.md): Connect AI agents and IDEs to StreamNative Cloud clusters using the Model Context Protocol (MCP). - [Local MCP Server](https://docs.streamnative.io/agent-engine/mcp/local-mcp-server.md): Install and run the open-source StreamNative MCP Server on your machine to connect AI agents to StreamNative Cloud, Kafka, or Pulsar clusters. ##### Remote MCP Server - [Remote StreamNative MCP Server](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-overview.md): Understand the managed StreamNative MCP Server and how it extends Orca Engine tooling. - [Access the Remote MCP Server](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-access.md): Learn how to authenticate and connect to the managed StreamNative MCP Server from IDEs and agent runtimes. - [Remote MCP Headers and Feature Selection](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-features.md): Configure headers and feature selection when connecting to the Remote StreamNative MCP Server. - [Governance & Permissions](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-governance.md): Configure organization and cluster access modes, allowed tools, and authentication for the Remote StreamNative MCP Server. - [Use Root and Organization-Level MCP Tools](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-organization-tools.md): Use root and organization Remote MCP sessions to inspect and manage StreamNative Cloud resources. - [MCP Tools Reference](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-tools-reference.md): Reference for available MCP tool groups for StreamNative Cloud, Pulsar, and Kafka. - [Expose Orca Agents as MCP Tools](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-agents-as-tools.md): Publish Orca agents through the Remote StreamNative MCP Server so other clients can invoke them. - [Use Pulsar Functions as MCP Tools](https://docs.streamnative.io/agent-engine/sn-remote-mcp/remote-mcp-functions-as-tools.md): Publish Pulsar Functions through the Remote StreamNative MCP Server so other clients can invoke them. ### Admin #### BYOC - [StreamNative BYOC Overview](https://docs.streamnative.io/cloud/clusters/byoc/byoc-overview.md) - [Manage Cloud Connections on StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/byoc/create-cloud-connection.md) - [Manage Cloud Environments on StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/byoc/create-cloud-environment.md) ##### Grant Vendor Access ###### BYOC On AWS - [Set up Account Access for BYOC on AWS](https://docs.streamnative.io/cloud/clusters/byoc/grant-vendor-access/byoc-on-aws/byoc-aws-access.md) - [Set up Custom Domain for BYOC on AWS](https://docs.streamnative.io/cloud/clusters/byoc/grant-vendor-access/byoc-on-aws/byoc-aws-dns-domain.md) ###### BYOC On Azure - [Set up Account Access for BYOC on Azure](https://docs.streamnative.io/cloud/clusters/byoc/grant-vendor-access/byoc-on-azure/byoc-azure-access.md) ###### BYOC On GCP - [Set up Project Access for BYOC on Google Cloud](https://docs.streamnative.io/cloud/clusters/byoc/grant-vendor-access/byoc-on-gcp/byoc-gcp-access.md) ###### BYOC On Alibaba Cloud - [Set up Account Access for BYOC on Alibaba Cloud](https://docs.streamnative.io/cloud/clusters/byoc/grant-vendor-access/byoc-on-alibaba/byoc-alibaba-cloud-access.md) #### Manage Instances - [Manage StreamNative Instances](https://docs.streamnative.io/cloud/clusters/manage-instances/instance.md) - [Manage Serverless Instances on StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/manage-instances/manage-serverless-instances.md) - [Manage Dedicated Instances on StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/manage-instances/manage-dedicated-instances.md) - [Manage BYOC Instances on StreamNative Cloud](https://docs.streamnative.io/cloud/clusters/manage-instances/manage-byoc-instances.md) #### Security - [Manage Security in StreamNative Cloud](https://docs.streamnative.io/cloud/security/security-overview.md) - [Work with Secrets](https://docs.streamnative.io/cloud/security/secret.md) ##### Authentication - [Manage Authentication on StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/authentication-overview.md) - [User accounts for StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/user-accounts.md) ###### Service Accounts - [Service Accounts for StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/service-accounts/service-accounts.md) - [Manage Service Accounts for StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/service-accounts/manage-service-accounts.md) ###### Use Api Keys - [Use API Keys to Authenticate to StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-api-keys/api-keys-overview.md) - [Best Practices for Using API Keys in StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-api-keys/api-keys-best-practices.md) ###### Use Oauth - [Use OAuth to Authenticate to StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-oauth/oauth-overview.md) - [Access Cloud Clusters using Pulsar Clients with OAuth 2.0](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-oauth/configure-pulsar-clients-with-oauth-20.md) - [Access Cloud API using OAuth 2.0](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-oauth/access-cloud-api-oauth.md) - [Access Cloud Clusters using Kafka Clients with OAuth 2.0](https://docs.streamnative.io/cloud/security/authentication/service-accounts/use-oauth/configure-kafka-clients-with-oauth-20.md) ###### Oidc Identity Providers - [Use OAuth/OIDC to Authenticate to StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/oidc-identity-providers/oidc-federation-overview.md) - [Manage OAuth/OIDC Identity Providers on StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/oidc-identity-providers/manage-oidc-identity-providers.md) - [Manage Identity Pools on StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/oidc-identity-providers/manage-oidc-identity-pools.md) - [Configure OAuth Clients](https://docs.streamnative.io/cloud/security/authentication/oidc-identity-providers/configure-oauth-clients.md) - [Best Practices for OAuth/OIDC Identity Providers](https://docs.streamnative.io/cloud/security/authentication/oidc-identity-providers/best-practices-for-oidc-identity-providers.md) ###### Mtls Identity Providers - [Use Mutual TLS (mTLS) to Authenticate to StreamNative Cloud](https://docs.streamnative.io/cloud/security/authentication/mtls-identity-providers/mtls-overview.md) ##### Access - [Control Access to StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/access-control-overview.md) ###### Resource Hierarchy - [Resources on StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/resource-hierarchy/resources-overview.md) - [Organizations in StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/resource-hierarchy/organizations.md) ###### RBAC - [Role-Based Access Control (RBAC) on StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/rbac/rbac-overview.md) - [Predefined Roles on StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/rbac/manage-rbac-roles.md) - [Manage Role Bindings on StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/rbac/manage-rbac-role-bindings.md) - [Use Pulsar ACLs with RBAC on StreamNative Cloud](https://docs.streamnative.io/cloud/security/access/rbac/use-pulsar-acls-with-rbac.md) - [Role-Based Access Control (V1) (Deprecated)](https://docs.streamnative.io/cloud/security/access/rbac/cloud-rbac.md) ###### Access Control Lists - [Manage Pulsar ACLs](https://docs.streamnative.io/cloud/security/access/access-control-lists/authorization-and-acls.md) - [Managed Kafka ACLs](https://docs.streamnative.io/cloud/security/access/access-control-lists/kafka-acls.md) ##### Encrypt And Protect Data - [Encrypt and Protect Data on StreamNative Cloud](https://docs.streamnative.io/cloud/security/encrypt-and-protect-data/encryption-overview.md) ##### Monitor Activity - [Audit log](https://docs.streamnative.io/cloud/security/monitor-activity/cloud-audit-log.md) #### Networking - [Networking in StreamNative Cloud](https://docs.streamnative.io/cloud/networking/networking.md) - [Static Egress IP](https://docs.streamnative.io/cloud/networking/static-egress-ip.md): Configure static egress IP addresses for outbound traffic from StreamNative Cloud - [Test Connectivity to StreamNative Cloud](https://docs.streamnative.io/cloud/networking/networking-testing.md) ##### Networking On AWS - [AWS Networking Overview on StreamNative Cloud](https://docs.streamnative.io/cloud/networking/networking-on-aws/aws-networking-overview.md) - [Use Public Connectivity for StreamNative Cloud Clusters on AWS](https://docs.streamnative.io/cloud/networking/networking-on-aws/aws-public-networking.md) ###### AWS Privatelink - [AWS PrivateLink Overview in StreamNative Cloud](https://docs.streamnative.io/cloud/networking/networking-on-aws/aws-privatelink/aws-privatelink-overview.md) - [Use AWS Inbound PrivateLink with StreamNative BYOC Clusters](https://docs.streamnative.io/cloud/networking/networking-on-aws/aws-privatelink/aws-inbound-privatelink-byoc.md) #### Logging & Monitoring - [Cluster Metrics](https://docs.streamnative.io/cloud/log-and-monitor/cloud-metrics-api.md) - [Advanced Observability Integration](https://docs.streamnative.io/cloud/log-and-monitor/advanced-observability.md) - [Scrape Metrics from the Local Metrics Endpoint](https://docs.streamnative.io/cloud/log-and-monitor/local-metrics-endpoint.md) - [Manage Notifications](https://docs.streamnative.io/cloud/log-and-monitor/manage-notifications.md) - [Log Console](https://docs.streamnative.io/cloud/log-and-monitor/log-conosole.md) - [Grafana Dashboards and Alerting rules](https://docs.streamnative.io/cloud/log-and-monitor/grafana-dashboards.md) #### Billing - [StreamNative Cloud Billing](https://docs.streamnative.io/cloud/billing/billing-overview.md) - [Manage billing using StreamNative Cloud Console](https://docs.streamnative.io/cloud/billing/billing.md) - [View your usage using StreamNative Cloud Console](https://docs.streamnative.io/cloud/billing/view-usage-console.md) - [Stop charges for your cluster](https://docs.streamnative.io/cloud/billing/stop-charges.md) - [View Credits and Discounts](https://docs.streamnative.io/cloud/billing/discounts.md) - [Billing FAQ](https://docs.streamnative.io/cloud/billing/billing-faq.md) ##### Marketplaces - [Get started with StreamNative Cloud on AWS Marketplace with Pay-As-You-Go](https://docs.streamnative.io/cloud/billing/billing-aws.md) - [Get started with StreamNative Cloud on AWS Marketplace with commitments](https://docs.streamnative.io/cloud/billing/billing-aws-commitments.md) - [Get started with StreamNative Cloud on Google Cloud Marketplace with Pay-As-You-Go](https://docs.streamnative.io/cloud/billing/billing-gcp.md) - [Get started with StreamNative Cloud on Google Cloud Marketplace with commitments](https://docs.streamnative.io/cloud/billing/billing-gcp-commitments.md) - [Get started with StreamNative Cloud on Azure Cloud Marketplace with Pay-As-You-Go](https://docs.streamnative.io/cloud/billing/billing-azure.md) - [Get started with StreamNative Cloud on Azure Cloud Marketplace with commitments](https://docs.streamnative.io/cloud/billing/billing-azure-commitments.md) - [Get started with StreamNative Cloud on Alibaba Cloud Marketplace with Pay-As-You-Go](https://docs.streamnative.io/cloud/billing/billing-alibaba.md) #### Tools - [StreamNative CLI Overview](https://docs.streamnative.io/tools/cli/streamnative-cli-overview.md) - [StreamNative CLI Tutorial](https://docs.streamnative.io/tools/cli/streamnative-cli-tutorial.md) ##### snctl - [StreamNative CLI (snctl)](https://docs.streamnative.io/tools/cli/snctl/snctl-overview.md) - [snctl Quick Reference](https://docs.streamnative.io/tools/cli/snctl/snctl-quick-reference.md) - [snctl Usage Conventions](https://docs.streamnative.io/tools/cli/snctl/snctl-usage-conventions.md) - [Tutorials: Manage StreamNative Cloud resources using snctl](https://docs.streamnative.io/tools/cli/snctl/snctl-tutorials.md) - [snctl Command References](https://docs.streamnative.io/tools/cli/snctl/snctl-command-references.md) #### Terraform - [StreamNative Terraform Provider Overview](https://docs.streamnative.io/tools/terraform/terraform-provider-overview.md) - [StreamNative Terraform Tutorial](https://docs.streamnative.io/tools/terraform/terraform-provider-tutorial.md) ##### Configure - [Configure StreamNative Terraform Provider](https://docs.streamnative.io/tools/terraform/configure/configure-streamnative-provider.md) - [Configure Pulsar Terraform Provider](https://docs.streamnative.io/tools/terraform/configure/configure-pulsar-provider.md) #### References - [Generate a HAR file for Troubleshooting](https://docs.streamnative.io/cloud/references/generate-har-file.md)