Apache Pulsar

https://pulsar.apache.org/docs/2.6.3
Admin
Apache Pulsar is an open-source, distributed messaging and streaming platform built for the cloud....
Tokens:1,201,160
Snippets:8,307
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Output: Kubernetes Service Status

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

An example of the expected output when checking the status of Kubernetes services for the installed Pulsar cluster, detailing network configurations for various components.

```text
NAME                         TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)                       AGE
pulsar-mini-bookie           ClusterIP      None             <none>        3181/TCP,8000/TCP             11m
pulsar-mini-broker           ClusterIP      None             <none>        8080/TCP,6650/TCP             11m
pulsar-mini-grafana          LoadBalancer   10.106.141.246   <pending>     3000:31905/TCP                11m
pulsar-mini-prometheus       ClusterIP      None             <none>        9090/TCP                      11m
pulsar-mini-proxy            LoadBalancer   10.97.240.109    <pending>     80:32305/TCP,6650:31816/TCP   11m
pulsar-mini-pulsar-manager   LoadBalancer   10.103.192.175   <pending>     9527:30190/TCP                11m
pulsar-mini-toolset          ClusterIP      None             <none>        <none>                        11m
pulsar-mini-zookeeper        ClusterIP      None             <none>        2888/TCP,3888/TCP,2181/TCP    11m
```

--------------------------------

### Example Output: Kubernetes Pod Status

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

An example of the expected output when checking the status of Kubernetes pods for the installed Pulsar cluster, showing various components in 'Running' or 'Completed' states.

```text
NAME                                         READY   STATUS      RESTARTS   AGE
pulsar-mini-bookie-0                         1/1     Running     0          9m27s
pulsar-mini-bookie-init-5gphs                0/1     Completed   0          9m27s
pulsar-mini-broker-0                         1/1     Running     0          9m27s
pulsar-mini-grafana-6b7bcc64c7-4tkxd         1/1     Running     0          9m27s
pulsar-mini-prometheus-5fcf5dd84c-w8mgz      1/1     Running     0          9m27s
pulsar-mini-proxy-0                          1/1     Running     0          9m27s
pulsar-mini-pulsar-init-t7cqt                0/1     Completed   0          9m27s
pulsar-mini-pulsar-manager-9bcbb4d9f-htpcs   1/1     Running     0          9m27s
pulsar-mini-toolset-0                        1/1     Running     0          9m27s
pulsar-mini-zookeeper-0                      1/1     Running     0          9m27s
```

--------------------------------

### Pulsar Client Service URL Examples

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Examples of `webServiceUrl` and `brokerServiceUrl` obtained from Minikube, used to configure the Pulsar client for HTTP and binary protocol connections respectively.

```bash
webServiceUrl=http://127.0.0.1:61853/
brokerServiceUrl=pulsar://127.0.0.1:61854/
```

--------------------------------

### Example Output: Minikube Service URLs (Tunnel Active)

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Subsequent output from `minikube service` after starting the tunnel, showing the local loopback URLs `http://127.0.0.1:61853` and `http://127.0.0.1:61854` for connecting to the Pulsar proxy.

```bash
🏃  Starting tunnel for service pulsar-mini-proxy.
|-----------|-------------------|-------------|-------------------------|
| NAMESPACE |       NAME        | TARGET PORT |          URL            |
|-----------|-------------------|-------------|-------------------------|
| pulsar    | pulsar-mini-proxy |             | http://127.0.0.1:61853  |
|           |                   |             | http://127.0.0.1:61854  |
|-----------|-------------------|-------------|-------------------------|
```

--------------------------------

### Start Pulsar Consumer with pulsar-perf

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This command starts a Pulsar consumer using the `pulsar-perf` client tool. It creates a subscription on the specified topic and waits for incoming messages, useful for verifying message reception.

```shell
bin/pulsar-perf consume persistent://test-tenant/ns1/my-topic
```

--------------------------------

### Publish Message to Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command-line example using `pulsar-client` to publish a single message 'Hello Pulsar' to a specified topic.

```Shell
$ bin/pulsar-client produce \
  persistent://public/default/test \
  -n 1 \
  -m "Hello Pulsar"
```

--------------------------------

### Construct Pulsar Client Service URLs

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Example commands to define environment variables for Pulsar's web and broker service URLs, using the Minikube IP and exposed ports.

```bash
webServiceUrl=http://$(minikube ip):<exposed-http-port>/
brokerServiceUrl=pulsar://$(minikube ip):<exposed-binary-port>/
```

--------------------------------

### Verify Pulsar Standalone Startup Log Messages

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/getting-started-docker

Example log messages displayed after successfully starting a Pulsar standalone instance. These messages confirm that the HTTP and messaging services are ready and indicate the listening ports and cluster details.

```log
08:18:30.970 [main] INFO  org.apache.pulsar.broker.web.WebService - HTTP Service started at http://0.0.0.0:8080
...
07:53:37.322 [main] INFO  org.apache.pulsar.broker.PulsarService - messaging service is ready, bootstrap service port = 8080, broker url= pulsar://localhost:6650, cluster=standalone, configs=org.apache.pulsar.broker.ServiceConfiguration@98b63c1
...
```

--------------------------------

### Pulsar Consumer Message Output

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Example output from the Pulsar client consumer, showing the received messages from the subscribed topic.

```text
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
----- got message -----
---------hello apache pulsar-------
```

--------------------------------

### Pulsar Producer Success Output

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Example output from the Pulsar client producer, confirming that messages were successfully sent to the topic.

```text
18:15:15.489 [main] INFO  org.apache.pulsar.client.cli.PulsarClientTool - 10 messages successfully produced
```

--------------------------------

### Example Output: Pulsar Proxy Service Status

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

An example output showing the `pulsar-mini-proxy` service as a `LoadBalancer` with its internal IP, pending external IP, and mapped TCP ports (HTTP 80:32305, Binary 6650:31816).

```bash
pulsar-mini-proxy            LoadBalancer   10.97.240.109    <pending>     80:32305/TCP,6650:31816/TCP   28m
```

--------------------------------

### Install Apache Pulsar Cluster using Helm

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Installs an Apache Pulsar cluster into Kubernetes using the specified Helm chart and values. The `--set initialize=true` flag is crucial for the initial installation to set up the cluster.

```bash
helm install \
    --values examples/values-minikube.yaml \
    --set initialize=true \
    --namespace pulsar \
    pulsar-mini apache/pulsar
```

--------------------------------

### Decompress Apache Pulsar Tarball

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Command to extract the contents of the downloaded Apache Pulsar tarball, preparing it for installation and configuration.

```bash
tar -xf <file-name>.tar.gz
```

--------------------------------

### Consume Messages from Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command-line example using `pulsar-client` to subscribe to a topic and consume up to 100 messages with a specific subscription name and type.

```Shell
$ bin/pulsar-client consume \
  persistent://public/default/test \
  -n 100 \
  -s "consumer-test" \
  -t "Exclusive"
```

--------------------------------

### Start Pulsar Configuration Store Service

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

This command starts the Pulsar configuration store service using the `pulsar-daemon` utility. It should be executed after the ZooKeeper configuration for the configuration store is properly set up.

```shell
bin/pulsar-daemon start configuration-store
```

--------------------------------

### Start Local ZooKeeper Cluster

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This command starts the local ZooKeeper cluster using the `pulsar-daemon` CLI tool. It should be executed on each ZooKeeper host after configuration and `myid` setup to bring the ensemble online.

```Shell
bin/pulsar-daemon start zookeeper
```

--------------------------------

### Example Output: Minikube Service URLs (Initial)

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Initial output from `minikube service` showing the `pulsar-mini-proxy` service's target ports and URLs, including `http://172.17.0.4:32305` for HTTP and `http://172.17.0.4:31816` for Pulsar binary protocol.

```bash
|-----------|-------------------|-------------|-------------------------|
| NAMESPACE |       NAME        | TARGET PORT |           URL           |
|-----------|-------------------|-------------|-------------------------|
| pulsar    | pulsar-mini-proxy | http/80     | http://172.17.0.4:32305 |
|           |                   | pulsar/6650 | http://172.17.0.4:31816 |
|-----------|-------------------|-------------|-------------------------|
```

--------------------------------

### List Partitioned Pulsar Topics

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Lists all partitioned topics within the 'apache/pulsar' namespace to verify the creation of 'test-topic' and shows the expected output, confirming the topic's full path.

```bash
bin/pulsar-admin topics list-partitioned-topics apache/pulsar
```

```text
"persistent://apache/pulsar/test-topic"
```

--------------------------------

### Start ZooKeeper Daemon Using Pulsar CLI Tool

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

This command initiates the ZooKeeper service on a host using the `pulsar-daemon` CLI tool. Running `bin/pulsar-daemon start zookeeper` starts the service in the background, making it ready to serve the Pulsar cluster. Ensure `zookeeper.conf` and `myid` are correctly configured beforehand.

```Shell
$ bin/pulsar-daemon start zookeeper
```

--------------------------------

### Start Pulsar Configuration Store Service

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This command starts the Pulsar configuration store service using the `pulsar-daemon` utility. It should be executed after the ZooKeeper configuration for the store is in place.

```Shell
bin/pulsar-daemon start configuration-store
```

--------------------------------

### Launch Minikube Kubernetes Dashboard

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

This command opens the Kubernetes Dashboard in your default web browser, providing a graphical user interface for managing and monitoring your Minikube cluster.

```bash
minikube dashboard
```

--------------------------------

### Set up Go module for Pulsar client

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/client-libraries-go-setup

This snippet outlines the process of setting up a new Go module for your project to integrate the Pulsar Go client library. It includes commands for creating a directory, initializing the module, managing dependencies, and building/running a sample script.

```Go
mkdir test_dir && cd test_dir
```

```Go
go mod init test_dir
go mod tidy && go mod download
go build test_example.go
./test_example
```

--------------------------------

### Start Apache Pulsar Bookie as Background Daemon

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This command starts a Pulsar BookKeeper bookie process in the background using the `pulsar-daemon` CLI tool, allowing it to run independently.

```Shell
bin/pulsar-daemon start bookie
```

--------------------------------

### Produce and Consume Messages with String Schema

Source: https://pulsar.apache.org/docs/2.6.3/next/schema-get-started

This example demonstrates how to construct a string schema using language-specific clients and use it to produce and consume messages in Apache Pulsar.

```Java
Producer<String> producer = client.newProducer(Schema.STRING).create();
producer.newMessage().value("Hello Pulsar!").send();

Consumer<String> consumer = client.newConsumer(Schema.STRING).subscribe();
Message<String> message = consumer.receive();

```

```C++
SchemaInfo schemaInfo = SchemaInfo(SchemaType::STRING, "String", "");
Producer producer;
client.createProducer("topic-string", ProducerConfiguration().setSchema(schemaInfo), producer);
producer.send(MessageBuilder().setContent("message").build());

Consumer consumer;
client.subscribe("topic-string", "my-sub", ConsumerConfiguration().setSchema(schemaInfo), consumer);
Message msg;
consumer.receive(msg, 3000);

```

```Python
producer = client.create_producer(
      'string-schema-topic',
      schema=StringSchema())
producer.send("Hello")

consumer = client.subscribe(
		'string-schema-topic',
		'sub',
		schema=StringSchema())
msg = consumer.receive()
str = msg.value()

```

```Go
producer, err := client.CreateProducer(pulsar.ProducerOptions{
    Topic:  "my-topic",
    Schema: pulsar.NewStringSchema(nil),
})
id, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
    Value: "message",
})

consumer, err := client.Subscribe(pulsar.ConsumerOptions{
    Topic:            "my-topic",
    Schema:           pulsar.NewStringSchema(nil),
    SubscriptionName: "my-sub",
    Type:             pulsar.Exclusive,
})
msg, err := consumer.Receive(context.Background())

```

--------------------------------

### Pulsar Broker Command Example: Starting Broker with Custom Configuration

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/reference-cli-tools

An example demonstrating how to start a Pulsar broker using a custom configuration file.

```Shell
$ PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker
```

--------------------------------

### Produce Messages to Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Use the `pulsar-client` command-line tool to produce 10 messages with the specified content to the `apache/pulsar/test-topic`.

```bash
bin/pulsar-client produce apache/pulsar/test-topic  -m "---------hello apache pulsar-------" -n 10
```

--------------------------------

### Start Pulsar Broker in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

Starts the Apache Pulsar broker service in the foreground using the `pulsar` CLI tool. This is useful for development or debugging, as it displays logs directly in the terminal.

```bash
bin/pulsar broker
```

--------------------------------

### Create Pulsar Consumer Subscription

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Use the `pulsar-client` command-line tool to create a subscription named `sub` and start consuming messages from the `apache/pulsar/test-topic`.

```bash
bin/pulsar-client consume -s sub apache/pulsar/test-topic  -n 0
```

--------------------------------

### Create Pulsar Consumer with Protobuf Schema in C++

Source: https://pulsar.apache.org/docs/2.6.3/next/schema-get-started

This C++ example demonstrates how to create a Pulsar consumer using a pre-defined `SchemaInfo` for Protobuf. It shows how to set the schema in the `ConsumerConfiguration` and then receive a message.

```C++
Consumer consumer;
client.subscribe("my-topic", "my-sub", ConsumerConfiguration().setSchema(schemaInfo),   consumer);
Message msg;
consumer.receive(msg);
```

--------------------------------

### Example Output: Successful Tenant Creation and Listing

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/tutorials-tenant

This output demonstrates the confirmation message after creating the 'apache' tenant and the subsequent list of tenants, including 'apache', 'public', and 'pulsar'.

```bash
The tenant apache has been successfully created.
"apache"
"public"
"pulsar"
```

--------------------------------

### Start Pulsar Broker in Background

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

Starts the Apache Pulsar broker service in the background using the `pulsar-daemon` CLI tool. This method is suitable for production environments where the broker needs to run persistently without occupying the terminal.

```bash
bin/pulsar-daemon start broker
```

--------------------------------

### Example Apache Pulsar Broker Configuration

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This configuration example illustrates essential parameters for a Pulsar broker. It includes settings for local ZooKeeper servers, the configuration store quorum, the cluster name, and various service ports for both broker data and web services, with and without TLS enabled.

```Configuration
# Local ZooKeeper servers
metadataStoreUrl=zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181

# Configuration store quorum connection string.
configurationMetadataStoreUrl=zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184

clusterName=us-west

# Broker data port
brokerServicePort=6650

# Broker data port for TLS
brokerServicePortTls=6651

# Port to use to server HTTP request
webServicePort=8080

# Port to use to server HTTPS request
webServicePortTls=8443
```

--------------------------------

### Start Pulsar Producer with pulsar-perf

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This command initiates a Pulsar producer using the `pulsar-perf` client tool. The producer publishes messages to the specified topic at a fixed rate and reports performance statistics every 10 seconds.

```shell
bin/pulsar-perf produce persistent://test-tenant/ns1/my-topic
```

--------------------------------

### Download Pulsar Binary Release using wget

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-standalone

Demonstrates how to download the Apache Pulsar binary tarball using the `wget` command-line utility from an Apache mirror. This is the first step to get started with a local Pulsar installation.

```Shell
wget https://archive.apache.org/dist/pulsar/pulsar-2.10.6/apache-pulsar-2.10.6-bin.tar.gz
```

--------------------------------

### Example Pulsar Topic Name Format

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This snippet shows the standard format for a persistent topic name in Apache Pulsar, including the tenant, namespace, and topic identifier. Topics are automatically created upon first use.

```text
persistent://test-tenant/ns1/my-topic
```

--------------------------------

### Produce and Consume Messages with String Schema in Apache Pulsar

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/schema-get-started

This example demonstrates how to construct a string schema using language-specific clients and use it to produce and consume messages in Apache Pulsar.

```Java
Producer<String> producer = client.newProducer(Schema.STRING).create();
producer.newMessage().value("Hello Pulsar!").send();

Consumer<String> consumer = client.newConsumer(Schema.STRING).subscribe();
Message<String> message = consumer.receive();
```

```C++
SchemaInfo schemaInfo = SchemaInfo(SchemaType::STRING, "String", "");
Producer producer;
client.createProducer("topic-string", ProducerConfiguration().setSchema(schemaInfo), producer);
producer.send(MessageBuilder().setContent("message").build());

Consumer consumer;
client.subscribe("topic-string", "my-sub", ConsumerConfiguration().setSchema(schemaInfo), consumer);
Message msg;
consumer.receive(msg, 3000);
```

```Python
producer = client.create_producer(
      'string-schema-topic',
      schema=StringSchema())
producer.send("Hello")

consumer = client.subscribe(
		'string-schema-topic',
		'sub',
		schema=StringSchema())
msg = consumer.receive()
str = msg.value()
```

```Go
producer, err := client.CreateProducer(pulsar.ProducerOptions{
    Topic:  "my-topic",
    Schema: pulsar.NewStringSchema(nil),
})
id, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
    Value: "message",
})

consumer, err := client.Subscribe(pulsar.ConsumerOptions{
    Topic:            "my-topic",
    Schema:           pulsar.NewStringSchema(nil),
    SubscriptionName: "my-sub",
    Type:             pulsar.Exclusive,
})
msg, err := consumer.Receive(context.Background())
```

--------------------------------

### Extract and Navigate to Apache Pulsar Directory

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

These commands extract the downloaded Apache Pulsar tarball and then change the current directory into the newly created Pulsar installation directory, preparing for further setup.

```Shell
tar xvfz apache-pulsar-4.0.5-bin.tar.gz
cd apache-pulsar-4.0.5
```

--------------------------------

### Access Kubernetes Dashboard via Minikube

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

This command launches the Kubernetes Dashboard in your default web browser, providing a web-based UI to manage your Minikube Kubernetes cluster.

```bash
minikube dashboard
```

--------------------------------

### Add and Update Apache Pulsar Helm Chart Repository

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Adds the official Apache Pulsar Helm chart repository to your Helm configuration and then updates the local cache to ensure the latest chart versions are available for installation.

```bash
helm repo add apache https://pulsar.apache.org/charts
```

```bash
helm repo update
```

--------------------------------

### Start Pulsar Broker in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command to start a Pulsar broker process in the foreground, useful for debugging or direct observation.

```Shell
$ bin/pulsar broker
```

--------------------------------

### Start Pulsar Broker in Background

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command to start a Pulsar broker process in the background using the `pulsar-daemon` tool, suitable for production environments.

```Shell
$ bin/pulsar-daemon start broker
```

--------------------------------

### List Pulsar Tenants

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Lists all existing tenants in the Pulsar instance, allowing verification of tenant creation. The output should be similar to: "apache"\n"public"\n"pulsar".

```bash
bin/pulsar-admin tenants list
```

--------------------------------

### Configure Pulsar Broker Metadata Store URLs

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

Example configuration for `metadataStoreUrl` and `configurationMetadataStoreUrl` in `conf/broker.conf`. These parameters ensure Pulsar brokers can connect to the ZooKeeper cluster for metadata storage. For a single cluster setup, both URLs typically point to the same ZooKeeper instances.

```properties
metadataStoreUrl=zk:zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181
configurationMetadataStoreUrl=zk:zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181
```

--------------------------------

### Initialize and build Go module

Source: https://pulsar.apache.org/docs/2.6.3/next/client-libraries-go-setup

Initializes a new Go module within the current directory, tidies up dependencies, downloads required modules, builds a Go executable from a sample script, and then runs it. This sequence demonstrates a typical Go module workflow.

```Go
go mod init test_dir
go mod tidy && go mod download
go build test_example.go
./test_example
```

--------------------------------

### List Namespaces for a Pulsar Tenant

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Lists all namespaces belonging to the `apache` tenant, verifying the successful creation of the `apache/pulsar` namespace. The output should be similar to: "apache/pulsar".

```bash
bin/pulsar-admin namespaces list apache
```

--------------------------------

### Start BookKeeper Bookie in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command to start a BookKeeper bookie process in the foreground. This is useful for debugging or when the process needs to be directly managed from the terminal.

```Shell
$ bin/pulsar bookie
```

--------------------------------

### Publish Message to Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

Use the `pulsar-client produce` command to send messages to a Pulsar topic. This example publishes a single message 'Hello Pulsar' to the `persistent://public/default/test` topic.

```Shell
bin/pulsar-client produce \
    persistent://public/default/test \
    -n 1 \
    -m "Hello Pulsar"
```

--------------------------------

### Produce Messages to Pulsar Topic via Java Client API

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/admin-api-get-started

Demonstrates how to create a Pulsar client and producer in Java to send messages to a specified topic. It includes client and producer setup and a message sending loop.

```java
PulsarClient client = PulsarClient.builder()
    .serviceUrl("pulsar://localhost:6650")
    .build();

Producer<String> producer = client.newProducer(Schema.STRING)
    .topic("test-topic-1")
    .blockIfQueueFull(true)
    .create();

for (int i = 0; i < 100; ++i) {
    producer.newMessage().value("test").send();
}
producer.close();
client.close();
```

--------------------------------

### Start Apache Pulsar BookKeeper Bookie in Background

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal-multi-cluster

Demonstrates how to start a BookKeeper bookie as a background daemon using the `pulsar-daemon` CLI tool.

```shell
$ bin/pulsar-daemon start bookie
```

--------------------------------

### Open Pulsar Manager UI in Minikube

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Command to open the Pulsar Manager web-based GUI in the browser, exposed via a Kubernetes LoadBalancer service in Minikube.

```bash
minikube service -n pulsar pulsar-mini-pulsar-manager
```

--------------------------------

### Install Pulsar Go client with go get

Source: https://pulsar.apache.org/docs/2.6.3/next/client-libraries-go-setup

Installs the Apache Pulsar Go client library into your Go environment using the `go get` command, updating if already present. This command fetches the latest version of the library from its GitHub repository.

```Go
go get -u "github.com/apache/pulsar-client-go/pulsar"
```

--------------------------------

### Constructing and Using Bytes Schema for Apache Pulsar Messages

Source: https://pulsar.apache.org/docs/2.6.3/next/schema-get-started

This example demonstrates how to initialize producers and consumers with a bytes schema in Apache Pulsar. It shows how to send and receive messages as byte arrays using various client libraries, illustrating the basic setup for handling raw binary data.

```Java
Producer<byte[]> producer = pulsarClient.newProducer(Schema.BYTES)
       .topic("my-topic")
       .create();
Consumer<byte[]> consumer = pulsarClient.newConsumer(Schema.BYTES)
       .topic("my-topic")
       .subscriptionName("my-sub")
       .subscribe();

producer.newMessage().value("message".getBytes()).send();

Message<byte[]> message = consumer.receive(5, TimeUnit.SECONDS);
```

```C++
SchemaInfo schemaInfo = SchemaInfo(SchemaType::BYTES, "Bytes", "");
Producer producer;
client.createProducer("topic-bytes", ProducerConfiguration().setSchema(schemaInfo), producer);
std::array<char, 1024> buffer;
producer.send(MessageBuilder().setContent(buffer.data(), buffer.size()).build());
Consumer consumer;
res = client.subscribe("topic-bytes", "my-sub", ConsumerConfiguration().setSchema(schemaInfo), consumer);
Message msg;
consumer.receive(msg, 3000);
```

```Python
producer = client.create_producer(
   'bytes-schema-topic',
   schema=BytesSchema())
producer.send(b"Hello")

consumer = client.subscribe(
   'bytes-schema-topic',
	'sub',
	schema=BytesSchema())
msg = consumer.receive()
data = msg.value()
```

```Go
producer, err := client.CreateProducer(pulsar.ProducerOptions{
    Topic:  "my-topic",
    Schema: pulsar.NewBytesSchema(nil),
})
id, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
    Value: []byte("message"),
})

consumer, err := client.Subscribe(pulsar.ConsumerOptions{
    Topic:            "my-topic",
    Schema:           pulsar.NewBytesSchema(nil),
    SubscriptionName: "my-sub",
    Type:             pulsar.Exclusive,
})
```

--------------------------------

### Start BookKeeper Bookie in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

Command to start a BookKeeper bookie process in the foreground, useful for debugging or when the terminal session is maintained.

```shell
bin/pulsar bookie
```

--------------------------------

### List Partitioned Topics in Pulsar Namespace

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Lists all partitioned topics within the `apache/pulsar` namespace, confirming the creation of `test-topic`. The output should be similar to: "persistent://apache/pulsar/test-topic".

```bash
bin/pulsar-admin topics list-partitioned-topics apache/pulsar
```

--------------------------------

### Install Go client library using go get

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/client-libraries-go-setup

This snippet demonstrates how to download the Apache Pulsar Go client library using the `go get` command and then import it into your Go project. This method is suitable for quickly adding the library to an existing Go environment.

```Go
go get -u "github.com/apache/pulsar-client-go/pulsar"
```

```Go
import "github.com/apache/pulsar-client-go/pulsar"
```

--------------------------------

### Go Reader Start from Specific Message ID (Inclusive/Exclusive)

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/client-libraries-go

This comprehensive Go example demonstrates how to create a Pulsar producer to send messages and then use a reader to start consuming from a specific message ID. It illustrates both exclusive (starting *after* the specified ID) and inclusive (starting *from* the specified ID) consumption using `StartMessageID` and `StartMessageIDInclusive` options. The example includes client setup, message production, and reader configuration.

```Go
client, err := NewClient(pulsar.ClientOptions{
	URL: lookupURL,
})

if err != nil {
	log.Fatal(err)
}
defer client.Close()

topic := "topic-1"
ctx := context.Background()

// create producer
producer, err := client.CreateProducer(pulsar.ProducerOptions{
	Topic:           topic,
	DisableBatching: true,
})
if err != nil {
	log.Fatal(err)
}
defer producer.Close()

// send 10 messages
msgIDs := [10]MessageID{}
for i := 0; i < 10; i++ {
	msgID, err := producer.Send(ctx, &pulsar.ProducerMessage{
		Payload: []byte(fmt.Sprintf("hello-%d", i)),
	})
	assert.NoError(t, err)
	assert.NotNil(t, msgID)
	msgIDs[i] = msgID
}

// create reader on 5th message (not included)
reader, err := client.CreateReader(pulsar.ReaderOptions{
	Topic:          topic,
	StartMessageID: msgIDs[4],
})

if err != nil {
	log.Fatal(err)
}
defer reader.Close()

// receive the remaining 5 messages
for i := 5; i < 10; i++ {
	msg, err := reader.Next(context.Background())
	if err != nil {
	log.Fatal(err)
}

// create reader on 5th message (included)
readerInclusive, err := client.CreateReader(pulsar.ReaderOptions{
	Topic:                   topic,
	StartMessageID:          msgIDs[4],
	StartMessageIDInclusive: true,
})

if err != nil {
	log.Fatal(err)
}
defer readerInclusive.Close()
```

--------------------------------

### Create a Partitioned Pulsar Topic using pulsar-admin CLI

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/admin-api-get-started

This command creates a new persistent partitioned topic named 'test-topic-1' in the 'public/default' namespace with 6 partitions. This is the initial step for setting up a scalable topic.

```bash
bin/pulsar-admin topics create-partitioned-topic \
persistent://public/default/test-topic-1 \
--partitions 6
```

--------------------------------

### Start BookKeeper Bookie in Background

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

Command to start a BookKeeper bookie process in the background using the `pulsar-daemon` CLI tool, allowing the terminal to be closed.

```shell
bin/pulsar-daemon start bookie
```

--------------------------------

### Initialize Minikube Kubernetes Cluster

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

This command starts a Minikube Kubernetes cluster, allocating 8GB of memory and 4 CPUs, and specifies the Kubernetes version to use. Replace `<k8s-version>` with a supported version.

```bash
minikube start --memory=8192 --cpus=4 --kubernetes-version=<k8s-version>
```

--------------------------------

### Start ZooKeeper Daemon for Apache Pulsar

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

This command uses the `pulsar-daemon` CLI tool to start the ZooKeeper service in the background, which is required for a Pulsar cluster.

```shell
bin/pulsar-daemon start zookeeper
```

--------------------------------

### Extract Pulsar Binary and Navigate Directory

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-standalone

Shows how to extract the downloaded Pulsar binary tarball using `tar` and then navigate into the extracted directory using `cd`. This prepares the environment for running Pulsar.

```Shell
tar xvfz apache-pulsar-2.10.6-bin.tar.gz
cd apache-pulsar-2.10.6
```

--------------------------------

### Start BookKeeper Bookie in Background

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Command to start a BookKeeper bookie process in the background using the `pulsar-daemon` CLI tool. This allows the bookie to run without occupying the terminal.

```Shell
$ bin/pulsar-daemon start bookie
```

--------------------------------

### Create Kubernetes Cluster with Minikube

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

This command initializes a Kubernetes cluster using Minikube, allocating 8GB of memory and 4 CPUs. Replace <k8s-version> with a supported Kubernetes version.

```bash
minikube start --memory=8192 --cpus=4 --kubernetes-version=<k8s-version>
```

--------------------------------

### Create Partitioned Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Creates a new partitioned topic named `test-topic` with 4 partitions within the `apache/pulsar` namespace. Partitioned topics allow for higher throughput and parallel processing of messages.

```bash
bin/pulsar-admin topics create-partitioned-topic apache/pulsar/test-topic -p 4
```

--------------------------------

### Start Pulsar Configuration Store Service

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal-multi-cluster

Command to start the Pulsar configuration store service using `pulsar-daemon` after the ZooKeeper configuration is in place, ensuring the metadata store is operational.

```shell
$ bin/pulsar-daemon start configuration-store
```

--------------------------------

### Start Pulsar ZooKeeper Daemon

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal-multi-cluster

This snippet shows how to start the ZooKeeper server in the background using the `pulsar-daemon` CLI tool after the `zookeeper.conf` and `myid` files have been properly configured on all hosts.

```bash
$ bin/pulsar-daemon start zookeeper
```

--------------------------------

### Consume Messages from Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Command to create a subscription and start consuming messages from a specified Pulsar topic using the Pulsar client CLI.

```bash
bin/pulsar-client consume -s sub apache/pulsar/test-topic  -n 0
```

--------------------------------

### Clone Apache Pulsar Helm Chart Repository

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Clones the official Apache Pulsar Helm chart repository from GitHub and navigates into the cloned directory.

```bash
git clone https://github.com/apache/pulsar-helm-chart
cd pulsar-helm-chart
```

--------------------------------

### Python: Create JSON Producer and Consumer with Class

Source: https://pulsar.apache.org/docs/2.6.3/next/schema-get-started

This Python example demonstrates creating a Pulsar producer and consumer by passing a class (`Example`) to `JsonSchema`. This method simplifies schema definition for structured data.

```Python
producer = client.create_producer(
   'avro-schema-topic',
   schema=JsonSchema(Example))

consumer = client.subscribe(
	'avro-schema-topic',
	'sub',
	schema=JsonSchema(Example))
```

--------------------------------

### Producer Output: Messages Successfully Produced

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Console output confirming that the Pulsar producer successfully sent 10 messages to the topic.

```bash
18:15:15.489 [main] INFO  org.apache.pulsar.client.cli.PulsarClientTool - 10 messages successfully produced
```

--------------------------------

### Get Pulsar Stateful Function Details

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/functions-quickstart

This command retrieves the detailed configuration and runtime information for the 'word_count' function, providing insights into its setup and current state within the Pulsar environment.

```Shell
bin/pulsar-admin functions get \
   --tenant test \
   --namespace test-namespace \
   --name word_count
```

```JSON
{
  "tenant": "test",
  "namespace": "test-namespace",
  "name": "word_count",
  "className": "org.apache.pulsar.functions.api.examples.WordCountFunction",
  "inputSpecs": {
    "test_wordcount_src": {
      "isRegexPattern": false,
      "schemaProperties": {},
      "consumerProperties": {},
      "poolMessages": false
    }
  },
  "producerConfig": {
    "useThreadLocalProducers": false,
    "batchBuilder": ""
  },
  "processingGuarantees": "ATLEAST_ONCE",
  "retainOrdering": false,
  "retainKeyOrdering": false,
  "forwardSourceMessageProperty": true,
  "userConfig": {},
  "runtime": "JAVA",
  "autoAck": true,
  "parallelism": 1,
  "resources": {
    "cpu": 1.0,
    "ram": 1073741824,
    "disk": 10737418240
  },
  "cleanupSubscription": true,
  "subscriptionPosition": "Latest"
}
```

--------------------------------

### Start Pulsar Broker in Background

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

This command starts the Pulsar broker service as a background process. It utilizes `nohup` for continuous operation and the `pulsar-daemon` CLI tool for managing the service lifecycle.

```Shell
bin/pulsar-daemon start broker
```

--------------------------------

### Produce Messages to Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Command to create a producer and send a specified number of messages to a Pulsar topic using the Pulsar client CLI.

```bash
bin/pulsar-client produce apache/pulsar/test-topic  -m "---------hello apache pulsar-------" -n 10
```

--------------------------------

### Update Helm Chart Repositories

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Updates all Helm chart repositories to ensure you have the latest chart versions available.

```bash
helm repo update
```

--------------------------------

### Start Pulsar Broker in Background

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal-multi-cluster

This command starts the Pulsar broker service in the background using the `pulsar-daemon` CLI tool, suitable for production environments where the service needs to run persistently.

```Shell
$ bin/pulsar-daemon start broker
```

--------------------------------

### Organize Downloaded Pulsar Builtin Connector Files

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-standalone

This example illustrates the steps to create a 'connectors' directory within the Pulsar installation and move a downloaded Pulsar connector NAR file into it. It concludes with a command to list the directory contents, verifying the successful placement of the connector.

```shell
$ mkdir connectors
$ mv pulsar-io-aerospike-2.6.3.nar connectors

$ ls connectors
pulsar-io-aerospike-2.6.3.nar
...
```

--------------------------------

### Start BookKeeper Bookie in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal

This command starts a BookKeeper bookie process in the foreground. This is often used for debugging or initial setup, as it keeps the process output visible in the current terminal.

```Shell
bin/pulsar bookie
```

--------------------------------

### Set kubectl Context to Minikube

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

This command configures `kubectl` to use the 'minikube' context, directing all subsequent Kubernetes commands to the Minikube cluster.

```bash
kubectl config use-context minikube
```

--------------------------------

### Start Pulsar Consumer

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

Starts a Pulsar consumer using the `pulsar-perf` client tool. The consumer subscribes to the specified topic and waits for incoming messages. This command is useful for testing message reception.

```Shell
bin/pulsar-perf consume persistent://test-tenant/ns1/my-topic
```

--------------------------------

### Start Pulsar Broker in Background

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

For background operation, use the `pulsar-daemon` CLI tool to start a Pulsar broker. This allows the broker to run as a daemon process, freeing up the terminal.

```Shell
bin/pulsar-daemon start broker
```

--------------------------------

### Create Partitioned Pulsar Topic

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Creates a new partitioned topic named 'test-topic' with 4 partitions within the 'apache/pulsar' namespace. Partitioned topics allow for higher throughput and parallel processing across multiple consumers.

```bash
bin/pulsar-admin topics create-partitioned-topic apache/pulsar/test-topic -p 4
```

--------------------------------

### Pulsar Configuration Store Command Example: Starting with Custom Configuration

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/reference-cli-tools

An example demonstrating how to start the Pulsar configuration store using a custom configuration file.

```Shell
$ PULSAR_CONFIGURATION_STORE_CONF=/path/to/configuration_store.conf pulsar configuration-store
```

--------------------------------

### Start Pulsar Broker in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal-multi-cluster

This command starts the Pulsar broker service in the foreground using the `pulsar broker` CLI tool. This is useful for debugging or when you want to see the logs directly in the console.

```Shell
$ bin/pulsar broker
```

--------------------------------

### Pulsar CLI: Initialize with Existing BookKeeper Cluster

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

This example demonstrates how to initialize a Pulsar cluster while leveraging an existing BookKeeper cluster. It uses the `--existing-bk-metadata-service-uri` flag to connect to the BookKeeper metadata service, alongside multi-host configurations for Pulsar's web and broker service URLs, providing flexibility for deployments with pre-existing BookKeeper setups.

```Shell
--existing-bk-metadata-service-uri "zk+null://zk1:2181;zk2:2181/ledgers" \
--web-service-url http://host1:8080,host2:8080,host3:8080 \
--web-service-url-tls https://host1:8443,host2:8443,host3:8443 \
--broker-service-url pulsar://host1:6650,host2:6650,host3:6650 \
--broker-service-url-tls pulsar+ssl://host1:6651,host2:6651,host3:6651
```

--------------------------------

### Create and navigate to Go module directory

Source: https://pulsar.apache.org/docs/2.6.3/next/client-libraries-go-setup

Creates a new directory named `test_dir` and changes the current working directory into it, preparing for Go module setup. This is a common initial step for new Go projects.

```Shell
mkdir test_dir && cd test_dir
```

--------------------------------

### Create new .NET console project with dotnet CLI

Source: https://pulsar.apache.org/docs/2.6.3/next/client-libraries-dotnet-setup

This command initializes a new C# console application project in the current directory using the .NET Core SDK's command-line interface. It sets up the basic project structure and files.

```Shell
dotnet new console
```

--------------------------------

### Clone Apache Pulsar Helm Chart Repository

Source: https://pulsar.apache.org/docs/2.6.3/2.6.3/getting-started-helm

Clones the official Apache Pulsar Helm chart repository from GitHub into the current directory and then changes the current working directory to the newly cloned repository, preparing for subsequent script execution.

```bash
git clone https://github.com/apache/pulsar-helm-chart
cd pulsar-helm-chart
```

--------------------------------

### Install Apache Pulsar Cluster with Helm

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-ibm

Installs an Apache Pulsar cluster on Kubernetes using the Helm chart. It specifies a values file for minikube and sets 'initialize=true' for the initial installation. This command deploys and starts the Pulsar components.

```bash
helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar
```

--------------------------------

### Pulsar Protobuf Producer and Consumer in Go

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/schema-get-started

Demonstrates creating a Pulsar producer and consumer in Go using a Protobuf schema. It shows how to initialize 'pulsar.NewProtoSchema' with the schema definition and then send and receive messages containing 'protobufDemo' instances.

```Go
psProducer := pulsar.NewProtoSchema(protoSchemaDef, nil)
producer, err := client.CreateProducer(pulsar.ProducerOptions{
    Topic:  "proto",
    Schema: psProducer,
})
msgId, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
    Value: &protobufDemo{
        Num: 100,
        Msf: "pulsar",
  },
})
psConsumer := pulsar.NewProtoSchema(protoSchemaDef, nil)
consumer, err := client.Subscribe(pulsar.ConsumerOptions{
    Topic:                       "proto",
    SubscriptionName:            "sub-1",
    Schema:                      psConsumer,
    SubscriptionInitialPosition: pulsar.SubscriptionPositionEarliest,
})
msg, err := consumer.Receive(context.Background())
```

--------------------------------

### Install Pulsar Python Client Library

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/getting-started-docker

Command to install the official Apache Pulsar client library for Python using pip, the Python package installer. This library enables Python applications to interact with Pulsar clusters for message production and consumption.

```shell
pip install pulsar-client
```

--------------------------------

### Get Minikube Service URLs for Pulsar Proxy

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Run this command to retrieve the IP address and exposed ports of the `pulsar-mini-proxy` service running in Minikube, which provides the URLs for connecting Pulsar clients.

```bash
minikube service pulsar-mini-proxy -n pulsar
```

--------------------------------

### Produce Messages to a Pulsar Topic using pulsar-perf

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/admin-api-get-started

This command uses the `pulsar-perf` tool to produce 1000 messages per second to the 'test-topic-1' on the specified broker service URL. It simulates message production for performance testing.

```bash
bin/pulsar-perf produce -u pulsar://localhost:6650 -r 1000 -i 1000 persistent://public/default/test-topic-1
```

--------------------------------

### Download Apache Pulsar C++ Client Devel RPM Package

Source: https://pulsar.apache.org/docs/2.6.3/next/client-libraries-cpp-setup

Download the Apache Pulsar C++ client devel RPM package, which includes static libraries (`libpulsar.a`, `libpulsarwithdeps.a`) and C/C++ header files necessary for development.

```Shell
wget https://archive.apache.org/dist/pulsar/pulsar-client-cpp-3.7.1/rpm-x86_64/x86_64/apache-pulsar-client-devel-3.7.1-1.x86_64.rpm
```

--------------------------------

### Start Pulsar Broker in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

This command starts the Pulsar broker service in the foreground. It uses the `pulsar broker` CLI tool, allowing direct observation of logs and output in the current terminal session.

```Shell
bin/pulsar broker
```

--------------------------------

### Start Apache Pulsar BookKeeper Bookie in Background

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

This command starts a BookKeeper bookie as a background daemon using the `pulsar-daemon` CLI tool. It's the recommended way to run bookies in a production environment.

```Shell
bin/pulsar-daemon start bookie
```

--------------------------------

### Download Pulsar Builtin Connectors using Wget

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/deploy-bare-metal

Instructions to download a specific Pulsar builtin connector .nar file using `wget`. Builtin connectors are optional and provide extended integration capabilities for Pulsar.

```Shell
$ wget https://archive.apache.org/dist/pulsar/pulsar-2.10.6/connectors/{connector}-2.10.6.nar
```

--------------------------------

### Initialize and build Go module with Pulsar client

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/client-libraries-go

Steps to initialize a Go module, manage dependencies, build, and run a sample Go application using the Pulsar client.

```Go
mkdir test_dir && cd test_dir
go mod init test_dir
go mod tidy && go mod download
go build test_example.go
./test_example
```

--------------------------------

### Start Local Pulsar ZooKeeper Daemon

Source: https://pulsar.apache.org/docs/2.6.3/next/deploy-bare-metal-multi-cluster

This command uses the `pulsar-daemon` CLI tool to start the local ZooKeeper server in the background. It assumes ZooKeeper has been properly configured and `myid` files are set up on all nodes.

```Shell
bin/pulsar-daemon start zookeeper
```

--------------------------------

### Expose PULSAR_HOME Environment Variable

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Set the `PULSAR_HOME` environment variable to the current working directory, which should be the root of the decompressed Pulsar installation.

```bash
export PULSAR_HOME=$(pwd)
```

--------------------------------

### Create and List Pulsar Namespaces

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-helm

Illustrates creating a new namespace 'pulsar' within the 'apache' tenant and then listing namespaces for 'apache' to confirm creation. Namespaces are administrative units within tenants for managing topics.

```bash
bin/pulsar-admin namespaces create apache/pulsar
```

```bash
bin/pulsar-admin namespaces list apache
```

```text
"apache/pulsar"
```

--------------------------------

### Start Pulsar Broker in Foreground

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

To start a Pulsar broker in the foreground, use the `pulsar broker` command. This command keeps the broker running in the current terminal session, displaying logs directly.

```Shell
bin/pulsar broker
```

--------------------------------

### Install Pulsar Built-in Connector

Source: https://pulsar.apache.org/docs/2.6.3/2.10.x/getting-started-standalone

Steps to create a `connectors` directory within the Pulsar installation and move a downloaded Pulsar connector NAR file into it. This makes the connector available for use by Pulsar Functions or IO.

```Shell
mkdir connectors
mv pulsar-io-aerospike-2.10.6.nar connectors

ls connectors
pulsar-io-aerospike-2.10.6.nar
...
```

--------------------------------

### Set ZooKeeper Observer Peer Type

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal-multi-cluster

This parameter must be added to the ZooKeeper configuration for any server designated as an observer in a multi-cluster setup. It ensures the server acts as a non-voting member of the ZooKeeper ensemble.

```ZooKeeper Config
peerType=observer
```

--------------------------------

### Initialize Pulsar Cluster Metadata with DNS URLs (Shell)

Source: https://pulsar.apache.org/docs/2.6.3/4.0.x/deploy-bare-metal

Demonstrates the initial setup of Apache Pulsar cluster metadata using the `pulsar initialize-cluster-metadata` command. This example configures the cluster with standard DNS-based service URLs for web and broker services, and specifies the metadata store locations. This command is executed once to provision a new cluster.

```shell
bin/pulsar initialize-cluster-metadata \
    --cluster pulsar-cluster-1 \
    --metadata-store zk:zk1.us-west.example.com:2181,zk2.us-west.example.com:2181 \
    --configuration-metadata-store zk:zk1.us-west.example.com:2181,zk2.us-west.example.com:2181 \
    --web-service-url http://pulsar.us-west.example.com:8080 \
    --web-service-url-tls https://pulsar.us-west.example.com:8443 \
    --broker-service-url pulsar://pulsar.us-west.example.com:6650 \
    --broker-service-url-tls pulsar+ssl://pulsar.us-west.example.com:6651
```
Tokens:
Raw