Getting Started
Create your first data flow
A complete customer walkthrough from tenant creation to a working topic
This walkthrough creates a simple orders data flow. Substitute names that match your organization.
1. Create the tenant
Open Tenant Manager and complete Create a tenant.
| Field | Example input | Guidance |
|---|---|---|
| Display name | Acme Streaming | A readable name shown throughout SQIP |
| Slug | acme-streaming | A permanent lowercase identifier using letters, numbers, and dashes |
Select Create tenant. The new tenant should appear with active status.
Warning
Choose the slug carefully. It identifies the tenant in resource names and sign-in links. Avoid names tied to a temporary project or employee.
2. Attach managed capacity
Open Pulsar Clusters.
- In Tenant, select
Acme Streaming. - Select Attach shared cluster.
- Wait for the cluster status to change to ready.
The first attachment may take longer than later ones. You can inspect Build logs if the status does not progress.
3. Create a namespace
Open Namespace and complete Create namespace.
| Field | Example input | Guidance |
|---|---|---|
| Tenant | Acme Streaming | The tenant that owns the data |
| Ready cluster | Select the available ready cluster | Only ready clusters can accept namespaces |
| Namespace name | orders-prod | A boundary for related topics, access, and storage |
| Hard storage quota (GiB) | 10 | A positive whole number based on expected retained data |
Select Create Pulsar namespace. The namespace should appear under Managed namespaces.
4. Create a topic
Open Topics and complete Create a topic.
| Field | Example input | Guidance |
|---|---|---|
| Tenant | Acme Streaming | Must match the namespace owner |
| Ready cluster | Select the same ready cluster | Topics are created inside the selected cluster |
| Topic name | orders.created | Letters, numbers, dots, dashes, and underscores are supported |
| Managed Pulsar namespace | orders-prod | The namespace created in the previous step |
| Partitions | 1 | Start with one unless you need parallel processing |
Select Create topic. The topic should appear with managed status.
5. Add a schema when your records have a contract
Open Schema Registry, choose orders.created, and upload an Avro .avsc, Protobuf .proto, or JSON .json schema file.
For a first setup, keep these policy values:
| Field | Recommended input |
|---|---|
| Compatibility mode | Full |
| Maximum versions | 100 |
| Maximum schema size (KiB) | 512 |
You can skip this step when the application or connector sends raw bytes and your team does not yet require a schema contract.
6. Create an API key
Open Access and RBAC, select Pulsar API keys, and complete Create a Pulsar API key.
| Field | Example input | Guidance |
|---|---|---|
| Tenant | Acme Streaming | The key cannot access other tenants |
| Managed namespace | orders-prod | The key is limited to this namespace |
| Cluster | Select the ready cluster | Must contain the selected namespace |
| Key name | Orders producer | Describe the application and purpose |
| Valid through | Select your approved expiry date | Keys can be issued for up to one year |
| Pulsar permissions | produce | Add consume only if the application also reads messages |
Select Generate Pulsar API key. Copy the credential and connection details immediately.
Warning
The API key is displayed once. Store it in your organization's approved secret manager before closing the dialog. If it is lost, revoke it and create a replacement.
7. Send or ingest data
Choose one approach:
- Configure your application with the generated API key and service URL.
- Install a source connector from the connector marketplace.
When data begins moving, open Usage Metering and confirm that messages produced increases. Use Audit Logs to confirm who created the resources.
Your first SQIP data flow is ready when the tenant is active, the cluster is ready, the namespace and topic are managed, and your application or connector can publish records.