Skip to main content
Version: 22.3

Redpanda Quickstart

Spin up a Redpanda cluster, create a basic streaming application, and explore your cluster in Redpanda Console.

Choose one of the following options:

  • Redpanda Cloud - Dedicated: Use a fully managed Redpanda cluster hosted on dedicated resources and configurable instance types in Redpanda Cloud.
  • Docker (self-hosted): Evaluate Redpanda on your Linux, macOS, or Windows machine.
    important

    Redpanda in Docker is supported only for development and testing. To deploy self-hosted Redpanda in production, use one of the following environments:

Prerequisites

Sign up for a trial of Redpanda Cloud - Dedicated Clusters.

Deploy Redpanda

To deploy a Redpanda cluster in the Dedicated cloud, create a namespace, then follow the steps for creating a Dedicated cluster.

To create a namespace:

  1. Go to Redpanda Cloud and click Log in.

  2. Enter your organization name and click Continue.

  3. Click Add namespace.

    Namespaces help you organize clusters by owner, team, or project for example.

  4. Enter a name for your namespace.

To create a cluster:

  1. Click Add Cluster.

  2. Click Create Dedicated cluster, and enter the following values:

    • Cluster name:

      redpandaquickstart
    • Throughput: 1 MBps

    • Version: Choose the latest available version

  3. Click Next to see the Cloud settings options, and enter the following values:

    • Provider: AWS

    • Region: Any region that's closest to you

    • Availability: Single AZ

    • Select a zone: Choose any zone

  4. Click Next to see the Networking options, and enter the following values:

    • Connection Type: Public Network
  5. Click Create.

  6. Wait for both your network and your cluster to be created.

Start streaming

To start building a basic streaming application, you can use rpk to create a topic, produce messages to it, and consume messages from it. rpk is a CLI tool for connecting to and interacting with Redpanda brokers.

  1. Install rpk on your local machine:

    note

    The rpk binary is not supported on Windows.

    1. Download the rpk archive for Linux:

      curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip
    2. Ensure that you have the folder ~/.local/bin:

      mkdir -p ~/.local/bin
    3. Add it to your $PATH:

      export PATH="~/.local/bin:$PATH"
    4. Unzip the rpk files to your ~/.local/bin/ directory:

      unzip rpk-linux-amd64.zip -d ~/.local/bin/
    5. Run rpk version to display the rpk binary version:

      rpk version
      Example output
      v22.3.11 (rev 9eefb907c)
  2. On the Overview page of Redpanda Cloud, copy your bootstrap server address and set it as an environment variable on your local machine:

    export REDPANDA_BROKERS="<bootstrap-server-address>"
  3. In Redpanda Cloud, go to Security and create a user called redpanda-twitch-account.

  4. Copy the password, and mechanism, and set the following environment variables on your local machine:

    export REDPANDA_SASL_USERNAME="redpanda-twitch-account"
    export REDPANDA_SASL_PASSWORD="<password>"
    export REDPANDA_SASL_MECHANISM="<mechanism>"
  5. In Redpanda Cloud, click the name of your user and add the following permissions to the ACL (access control list):

    • Host: *

    • Topic name:

      twitch_chat
    • Operations: All

  6. Use rpk on your local machine to authenticate to Redpanda as the redpanda-twitch-account user and get information about the cluster:

    rpk cluster info --tls-enabled
    Example output
    CLUSTER
    =======
    redpanda.rp-example-cluster-id

    BROKERS
    =======
    ID HOST PORT RACK
    0* 0-example.fmc.prd.cloud.redpanda.com 30092 euw1-az1
    1 1-example.fmc.prd.cloud.redpanda.com 30092 euw1-az1
    2 2-example.fmc.prd.cloud.redpanda.com 30092 euw1-az1
  7. Create a topic called twitch_chat.

    You granted permissions to the redpanda-twitch-account user to access only this topic.

    rpk topic create twitch_chat --tls-enabled
    Example output
    TOPIC       STATUS
    twitch_chat OK
  8. Produce a message to the topic:

    rpk topic produce twitch_chat --tls-enabled
  9. Enter a message, then press Enter:

    Pandas are fabulous!
    Example output
    Produced to partition 0 at offset 0 with timestamp 1663282629789.
  10. Press Ctrl+C to finish producing messages to the topic.

  11. Consume one message from the topic:

    rpk topic consume twitch_chat --num 1 --tls-enabled
    Example output

    Your message is displayed along with its metadata,:

    {
    "topic": "twitch_chat",
    "value": "Pandas are fabulous!",
    "timestamp": 1663282629789,
    "partition": 0,
    "offset": 0
    }

Explore your topic

In Redpanda Cloud, go to Topics > twitch_chat.

The message that you produced to the topic is displayed along with some other details about the topic.

Clean up

When you're finished with the cluster, you can delete it.

Go to Cluster settings and click Delete cluster.

Next steps

Suggested reading

Explore the rpk commands that you used in this quickstart:

What do you like about this doc?




Optional: Share your email address if we can contact you about your feedback.

Let us know what we do well: