Skip to main content

Getting Started

Create Account

You can sign up to Upstash using your Amazon, Github or Google accounts. Alternatively you can sign up using email/password registration if you don't want to use these auth providers, or you want to sign up using a corporate email address.

note

We do not access your information other than:

  • Your email
  • Your name
  • Your profile picture and we never share your information with third parties.

Create a Kafka Cluster

Once you logged in, you can create a Kafka cluster by clicking on the "Create Cluster" button.

Name: Type a name for the Kafka cluster.

Region: Select the region where your cluster will be deployed. For best performance, choose the Region which your applications are closer to. We are planning to support other regions and cloud providers. Please send your requests to feedback@upstash.com to expedite it.

Type: Select to the cluster type. Currently there are only two options, choose single zone for testing/development, multi zone for production use cases:

  • Single Zone: Topics created in the single zone cluster will have single replica only.
  • Multi Zone: Topics created in the multi zone cluster will have three replicas.

Once you click on Create button, you should see your cluster list as below:

When you click the one of the clusters in the list, you will see the cluster details page, which shows the cluster bootstrap endpoint, username and password.

Create a Topic

To create a new topic, switch to the "Topics" tab in cluster details page, and click the "Create topic" button:

Type a name for your topic and pick a partition count according to your application's needs.

caution

Note that Kafka topic names can contain only alphanumerics, underscore (_), hyphen (-) and dot (.) characters.

You can also change some advanced properties such as Retention Time, Retention Size and Cleanup Policy using "Advanced" section.

Once you created the topic, you will see a topics list, where you can see the topic configuration and usage details. Also you can change the topic configuration and delete the topic here.

Connect to Cluster

You can connect to the cluster using any Kafka clients. In the cluster details section, you will see some code snippets for a few popular Kafka clients.

Normally username and password will be shown as {{ UPSTASH_KAFKA_USERNAME }} and {{ UPSTASH_KAFKA_PASSWORD }}. By turning on "Show secrets" toggle, these secrets will be replaced with the actual values of your cluster. For more info about using Kafka clients see Kafka API section.

Alternatively you can use the REST API to connect the cluster. For more info about using the REST API see Kafka REST API.