Deploy a Local Development Cluster with kind or minikube

Deploy a local Redpanda cluster with Redpanda Console using the Helm chart. Explore the essentials of how Redpanda works in Kubernetes and what components are deployed by default. Then, use rpk both as an internal client and an external client to interact with your Redpanda cluster from the command line.

Only for development and testing

Do not use kind or minikube for production workloads. Instead, try one of the following environments:

Prerequisites

Before you begin, make sure that you have the correct software for your Kubernetes platform:

All platforms
kind
minikube

kubectl. Minimum required Kubernetes version: 1.21
```
kubectl version --short --client
```
Helm. Minimum required Helm version: 3.6.0
```
helm version
```

kind
Docker

minikube

Create a Kubernetes cluster

In this step, you create one master and three worker nodes (one worker node for each Redpanda broker).

kind
minikube

Define a cluster in the kind.yaml configuration file:

cat <<EOF >kind.yaml
---
apiVersion: kind.x-k8s.io/v1alpha4
kind: Cluster
nodes:
  - role: control-plane
  - role: worker
  - role: worker
  - role: worker
EOF

Create the Kubernetes cluster from the configuration file:
```
kind create cluster --config kind.yaml
```

Create the Kubernetes cluster:

minikube start --namespace redpanda --nodes 4

Prevent applications from being scheduled on the Kubernetes control plane node:

kubectl taint node \
  -l node-role.kubernetes.io/control-plane="" \
    node-role.kubernetes.io/control-plane=:NoSchedule

Deploy Redpanda and Redpanda Console

In this step, you deploy Redpanda with self-signed TLS certificates. Redpanda Console is included as a subchart in the Redpanda Helm chart.

Helm + Operator
Helm

Make sure that you have permission to install custom resource definitions (CRDs):
```
kubectl auth can-i create CustomResourceDefinition --all-namespaces
```
You should see yes in the output.

You need these cluster-level permissions to install cert-manager and Redpanda Operator CRDs in the next steps.

Install cert-manager using Helm:

helm repo add jetstack https://charts.jetstack.io
helm repo update
helm install cert-manager jetstack/cert-manager --set installCRDs=true --namespace cert-manager --create-namespace

TLS is enabled by default. The Redpanda Helm chart uses cert-manager to manage TLS certificates by default.

Install the Redpanda Operator custom resource definitions (CRDs):

kubectl kustomize https://github.com/redpanda-data/redpanda//src/go/k8s/config/crd | kubectl apply -f -

Deploy the Redpanda Operator:

helm repo add redpanda https://charts.redpanda.com
helm upgrade --install redpanda-controller redpanda/operator \
  --namespace <namespace> \
  --set image.repository=docker.redpanda.com/redpandadata/redpanda-operator \
  --set image.tag=v23.2.9 \
  --create-namespace

Ensure that the Deployment is successfully rolled out:

kubectl --namespace <namespace> rollout status --watch deployment/redpanda-controller-operator

deployment "redpanda-controller-operator" successfully rolled out

Install a Redpanda custom resource with SASL enabled:

redpanda-cluster.yaml

apiVersion: cluster.redpanda.com/v1alpha1
kind: Redpanda
metadata:
  name: redpanda
spec:
  chartRef: {}
  clusterSpec:
    external:
      domain: customredpandadomain.local
    statefulset:
      initContainers:
        setDataDirOwnership:
          enabled: true

kubectl apply -f redpanda-cluster.yaml --namespace <namespace>

Wait for the Redpanda Operator to deploy Redpanda using the Helm chart:
```
kubectl get redpanda --namespace <namespace> --watch
```
```
NAME       READY   STATUS
redpanda   True    Redpanda reconciliation succeeded
```
This step may take a few minutes. You can watch for new Pods to make sure that the deployment is progressing:
```
kubectl get pod --namespace <namespace>
```
If it’s taking too long, see Troubleshoot.

Add the Redpanda Helm chart repository and install cert-manager using Helm:

helm repo add redpanda https://charts.redpanda.com
helm repo add jetstack https://charts.jetstack.io
helm repo update
helm install cert-manager jetstack/cert-manager  --set installCRDs=true --namespace cert-manager  --create-namespace

The Redpanda Helm chart uses cert-manager to manage TLS certificates.

Install Redpanda using Helm:

export DOMAIN=customredpandadomain.local && \
helm repo add redpanda https://charts.redpanda.com/
helm repo update
helm install redpanda redpanda/redpanda \
  --namespace <namespace> \
  --create-namespace \
  --set external.domain=${DOMAIN} \
  --set statefulset.initContainers.setDataDirOwnership.enabled=true

The installation displays some tips for getting started.

Wait for the Redpanda cluster to be ready:
```
kubectl --namespace <namespace> rollout status statefulset redpanda --watch
```
When the Redpanda cluster is ready, the output should look similar to the following:
```
statefulset rolling update complete 3 pods at revision redpanda-8654f645b4...
```
If your cluster remains in a pending state, see Troubleshoot.

Start streaming

Each Redpanda broker comes with rpk, which is a CLI tool for connecting to and interacting with Redpanda brokers. You can use rpk inside one of the Redpanda broker’s Docker containers to create a topic, produce messages to it, and consume messages from it.

Create an alias to simplify the rpk commands:

alias rpk-topic="kubectl --namespace <namespace> exec -i -t redpanda-0 -c redpanda -- rpk topic -X brokers=redpanda-0.redpanda.<namespace>.svc.cluster.local.:9093,redpanda-1.redpanda.<namespace>.svc.cluster.local.:9093,redpanda-2.redpanda.<namespace>.svc.cluster.local.:9093 --tls-truststore /etc/tls/certs/default/ca.crt --tls-enabled"

Create a topic called twitch_chat:

rpk-topic create twitch_chat

Example output:

  TOPIC       STATUS
  twitch_chat  OK

Describe the topic:

rpk-topic describe twitch_chat

Expected output:

SUMMARY
=======
NAME        twitch_chat
PARTITIONS  1
REPLICAS    1

CONFIGS
=======
KEY                     VALUE                          SOURCE
cleanup.policy          delete                         DYNAMIC_TOPIC_CONFIG
compression.type        producer                       DEFAULT_CONFIG
message.timestamp.type  CreateTime                     DEFAULT_CONFIG
partition_count         1                              DYNAMIC_TOPIC_CONFIG
redpanda.datapolicy     function_name:  script_name:   DEFAULT_CONFIG
redpanda.remote.read    false                          DEFAULT_CONFIG
redpanda.remote.write   false                          DEFAULT_CONFIG
replication_factor      1                              DYNAMIC_TOPIC_CONFIG
retention.bytes         -1                             DEFAULT_CONFIG
retention.ms            604800000                      DEFAULT_CONFIG
segment.bytes           1073741824                     DEFAULT_CONFIG

Produce a message to the topic:
```
rpk-topic produce twitch_chat
```

Type a message, then press Enter:

Pandas are fabulous!

Example output:

Produced to partition 0 at offset 0 with timestamp 1663282629789.

Press Ctrl+C to finish producing messages to the topic.

Consume one message from the topic:

rpk-topic consume twitch_chat --num 1

Expected 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 Console

Redpanda Console is a developer-friendly web UI for managing and debugging your Redpanda cluster and your applications.

In this step, you use port-forwarding to access Redpanda Console on your local network.

Because you’re using the Community Edition of Redpanda Console, you should not expose Redpanda Console outside your local network. The Community Edition of Redpanda Console does not provide authentication, and it connects to the Redpanda cluster as superuser. To use the Enterprise Edition, you need a license key, see Redpanda Licensing.

Expose Redpanda Console to your localhost:
```
kubectl -n redpanda port-forward svc/redpanda-console 8080:8080
```
The kubectl port-forward command actively runs in the command-line window. To execute other commands while the command is running, open another command-line window.
Open Redpanda Console on http://localhost:8080.

All your Redpanda brokers are listed along with their IP addresses and IDs.
Go to Topics > twitch_chat.

The message that you produced to the topic is displayed along with some other details about the topic.
Press Ctrl+C in the command-line to stop the port-forwarding process.

Configure external access to Redpanda

If you want to connect to the Redpanda cluster with external clients, Redpanda brokers must advertise an externally accessible address that external clients can connect to. External clients are common in Internet of Things (IoT) environments, or if you use external services that do not implement VPC peering in your network.

When you created the cluster, you set the external.domain configuration to customredpandadomain.local, which means that your Redpanda brokers are advertising the following addresses:

redpanda-0.customredpandadomain.local
redpanda-1.customredpandadomain.local
redpanda-2.customredpandadomain.local

To access your Redpanda brokers externally, you can map your worker nodes' IP addresses to these domains.

IP addresses can change. If the IP addresses of your worker nodes change, you must update your /etc/hosts file with the new mappings.

In a production environment, it’s best practice to use ExternalDNS to manage DNS records for your brokers. See Use ExternalDNS for external access.

Add mappings in your /etc/hosts file between your worker nodes' IP addresses and their custom domain names:

sudo true && kubectl -n redpanda get endpoints,node -A -o go-template='{{ range $_ := .items }}{{ if and (eq .kind "Endpoints") (eq .metadata.name "redpanda-external") }}{{ range $_ := (index .subsets 0).addresses }}{{ $nodeName := .nodeName }}{{ $podName := .targetRef.name }}{{ range $node := $.items }}{{ if and (eq .kind "Node") (eq .metadata.name $nodeName) }}{{ range $_ := .status.addresses }}{{ if eq .type "InternalIP" }}{{ .address }} {{ $podName }}.${DOMAIN}{{ "\n" }}{{ end }}{{ end }}{{ end }}{{ end }}{{ end }}{{ end }}{{ end }}' | envsubst | sudo tee -a /etc/hosts

/etc/hosts

203.0.113.3 redpanda-0.customredpandadomain.local
203.0.113.5 redpanda-1.customredpandadomain.local
203.0.113.7 redpanda-2.customredpandadomain.local

Save the root certificate authority (CA) to your local file system outside Kubernetes:

kubectl -n redpanda get secret redpanda-default-root-certificate -o go-template='{{ index .data "ca.crt" | base64decode }}' > ca.crt

Install rpk on your local machine, not on a Pod:
- Linux
- macOS
Download the rpk archive for Linux, and make sure the version matches your Redpanda version.

To download the latest version of rpk:

curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip

To download a version other than the latest:

curl -LO https://github.com/redpanda-data/redpanda/releases/download/v<version>/rpk-linux-amd64.zip

Ensure that you have the folder ~/.local/bin:

mkdir -p ~/.local/bin

Add it to your $PATH:

export PATH="~/.local/bin:$PATH"

Unzip the rpk files to your ~/.local/bin/ directory:

unzip rpk-linux-amd64.zip -d ~/.local/bin/

Run rpk version to display the version of the rpk binary:

rpk version

23.2.9 (rev 045d510)
If you don’t have Homebrew installed, install it.

Install rpk:

brew install redpanda-data/tap/redpanda

Run rpk version to display the version of the rpk binary:

rpk version

23.2.9 (rev 045d510)

This method installs the latest version of rpk, which is supported only with the latest version of Redpanda.
Set the REDPANDA_BROKERS environment variable to the custom domains of your Redpanda brokers:
```
export REDPANDA_BROKERS=redpanda-0.customredpandadomain.local:31092,redpanda-1.customredpandadomain.local:31092,redpanda-2.customredpandadomain.local:31092
```
31092 is the Kafka API port that’s exposed by the default NodePort Service.

Describe the topic:

rpk topic describe twitch_chat --tls-enabled --tls-truststore=ca.crt

Example output:

SUMMARY
=======
NAME        twitch_chat
PARTITIONS  1
REPLICAS    1
CONFIGS
=======
KEY                     VALUE                          SOURCE
cleanup.policy          delete                         DYNAMIC_TOPIC_CONFIG
compression.type        producer                       DEFAULT_CONFIG
message.timestamp.type  CreateTime                     DEFAULT_CONFIG
partition_count         1                              DYNAMIC_TOPIC_CONFIG
redpanda.datapolicy     function_name:  script_name:   DEFAULT_CONFIG
redpanda.remote.read    false                          DEFAULT_CONFIG
redpanda.remote.write   false                          DEFAULT_CONFIG
replication_factor      1                              DYNAMIC_TOPIC_CONFIG
retention.bytes         -1                             DEFAULT_CONFIG
retention.ms            604800000                      DEFAULT_CONFIG
segment.bytes           1073741824                     DEFAULT_CONFIG

Explore the default Kubernetes components

By default, the Redpanda Helm chart deploys the following Kubernetes components:

A StatefulSet with three Pods.
One PersistentVolumeClaim for each Pod, each with a capacity of 20Gi.
A headless ClusterIP Service and a NodePort Service for each Kubernetes node that runs a Redpanda broker.
Self-Signed TLS Certificates.

StatefulSet

Redpanda is a stateful application. Each Redpanda broker needs to store its own state (topic partitions) in its own storage volume. As a result, the Helm chart deploys a StatefulSet to manage the Pods in which the Redpanda brokers are running.

kubectl get statefulset -n redpanda

Example output:

NAME       READY   AGE
redpanda   3/3     3m11s

StatefulSets ensure that the state associated with a particular Pod replica is always the same, no matter how often the Pod is recreated. Each Pod is also given a unique ordinal number in its name such as redpanda-0. A Pod with a particular ordinal number is always associated with a PersistentVolumeClaim with the same number. When a Pod in the StatefulSet is deleted and recreated, it is given the same ordinal number and so it mounts the same storage volume as the deleted Pod that it replaced.

kubectl get pod -n redpanda

Expected output:

NAME                              READY   STATUS      RESTARTS        AGE
redpanda-0                        1/1     Running     0               6m9s
redpanda-1                        1/1     Running     0               6m9s
redpanda-2                        1/1     Running     0               6m9s
redpanda-console-5ff45cdb9b-6z2vs 1/1     Running     0               5m
redpanda-configuration-smqv7      0/1     Completed   0               6m9s

The redpanda-configuration job updates the Redpanda runtime configuration.

PersistentVolumeClaim

Redpanda brokers must be able to store their data on disk. By default, the Helm chart uses the default StorageClass in the Kubernetes cluster to create a PersistentVolumeClaim for each Pod. The default StorageClass in your Kubernetes cluster depends on the Kubernetes platform that you are using.

kubectl get persistentvolumeclaims -n redpanda

Expected output:

NAME                 STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
datadir-redpanda-0   Bound    pvc-3311ade3-de84-4027-80c6-3d8347302962   20Gi       RWO            standard       75s
datadir-redpanda-1   Bound    pvc-4ea8bc03-89a6-41e4-b985-99f074995f08   20Gi       RWO            standard       75s
datadir-redpanda-2   Bound    pvc-45c3555f-43bc-48c2-b209-c284c8091c45   20Gi       RWO            standard       75s

Service

The clients writing to or reading from a given partition have to connect directly to the leader broker that hosts the partition. As a result, clients needs to be able to connect directly to each Pod. To allow internal and external clients to connect to each Pod that hosts a Redpanda broker, the Helm chart configures two Services:

Internal using the Headless ClusterIP
External using the NodePort

kubectl get service -n redpanda

Expected output:

NAME                TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                                                       AGE
redpanda            ClusterIP   None            <none>        <none>                                                        5m37s
redpanda-console    ClusterIP   10.0.251.204    <none>        8080                                                          5m
redpanda-external   NodePort    10.96.137.220   <none>        9644:31644/TCP,9094:31092/TCP,8083:30082/TCP,8080:30081/TCP   5m37s

Headless ClusterIP Service

The headless Service associated with a StatefulSet gives the Pods their network identity in the form of a fully qualified domain name (FQDN). Both Redpanda brokers in the same Redpanda cluster and clients within the same Kubernetes cluster use this FQDN to communicate with each other.

An important requirement of distributed applications such as Redpanda is peer discovery: The ability for each broker to find other brokers in the same cluster. When each Pod is rolled out, its seed_servers field is updated with the FQDN of each Pod in the cluster so that they can discover each other.

kubectl -n redpanda exec redpanda-0 -c redpanda -- cat etc/redpanda/redpanda.yaml

redpanda:
  data_directory: /var/lib/redpanda/data
  empty_seed_starts_cluster: false
  seed_servers:
  - host:
      address: redpanda-0.redpanda.<namespace>.svc.cluster.local.
      port: 33145
  - host:
      address: redpanda-1.redpanda.<namespace>.svc.cluster.local.
      port: 33145
  - host:
      address: redpanda-2.redpanda.<namespace>.svc.cluster.local.
      port: 33145

NodePort Service

External access is made available by a NodePort service that opens the following ports by default for the listeners:

Node port	Pod port	Listener
30081	8081	Schema Registry
30082	8083	HTTP Proxy
31092	9094	Kafka API
31644	9644	Admin API

To learn more, see Networking and Connectivity in Kubernetes.

TLS Certificates

By default, TLS is enabled in the Redpanda Helm chart. The Helm chart uses cert-manager to generate two Certificate resources that provide Redpanda with self-signed certificates:

The redpanda-default-cert Certificate is the TLS certificate that is used by all listeners.
The redpanda-default-root-certificate Certificate is the root certificate authority for the TLS certificates.

kubectl get certificate -n redpanda

NAME                                 READY   SECRET                               AGE
redpanda-default-cert                True    redpanda-default-cert                10m
redpanda-default-root-certificate    True    redpanda-default-root-certificate    10m

Troubleshoot

Before troubleshooting your cluster, make sure that you have all the prerequisites.

For troubleshooting steps, see Troubleshoot Redpanda in Kubernetes.

Next steps

When you’re ready to use a registered domain, make sure to remove your entries from the /etc/hosts file, and see Configure External Access through a NodePort Service

What do you like about this doc?

Let us know what we do well:

Let us contact you about your feedback:

What did you not like about this doc?

Let us know what we can improve:

Let us contact you about your feedback:

Deploy a Local Development Cluster with kind or minikube

Prerequisites

Create a Kubernetes cluster

Deploy Redpanda and Redpanda Console

Start streaming

Explore your topic in Redpanda Console

Configure external access to Redpanda

Explore the default Kubernetes components

StatefulSet

PersistentVolumeClaim

Service

Headless ClusterIP Service

NodePort Service

TLS Certificates

Troubleshoot

Next steps

Suggested reading

Simple online edits

Contribution guide