Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
ba2ae16
[Doc][Improve] Add landing pages
DaveDuggins Nov 8, 2022
af8ba62
Add tutorial pages
DaveDuggins Nov 8, 2022
1f378a1
Merge branch 'apache:master' into master
DaveDuggins Nov 8, 2022
587b1d5
Update site2/docs/about.md
DaveDuggins Nov 8, 2022
73a9fa2
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins Nov 8, 2022
9fc4de7
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins Nov 8, 2022
b43598f
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins Nov 8, 2022
7dfdb46
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins Nov 8, 2022
02dcbdd
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 9, 2022
9736d9d
Update developers-landing.md
DaveDuggins Nov 9, 2022
be1d9cc
Merge branch 'master' of https://github.com/DaveDuggins/pulsar
DaveDuggins Nov 9, 2022
95bbb02
Create tutorials-produce-consume.md
DaveDuggins Nov 9, 2022
982c0c8
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 9, 2022
10724b8
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 9, 2022
3653e12
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 9, 2022
72d9cb0
Merge branch 'apache:master' into master
DaveDuggins Nov 9, 2022
b72b624
Delete developer-landing.md
DaveDuggins Nov 9, 2022
53eedd8
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 9, 2022
cb94c02
Update install-deploy-upgrade-landing.md
DaveDuggins Nov 9, 2022
62bdfae
Merge branch 'master' of https://github.com/DaveDuggins/pulsar
DaveDuggins Nov 9, 2022
079699e
Update site2/docs/tutorials-topic.md
DaveDuggins Nov 9, 2022
e4994f9
Update site2/docs/tutorials-produce-consume.md
DaveDuggins Nov 9, 2022
9ab447a
Update site2/docs/tutorials-produce-consume.md
DaveDuggins Nov 9, 2022
ba03b8c
Update site2/docs/tutorials-topic.md
DaveDuggins Nov 9, 2022
e7ea050
Typo
DaveDuggins Nov 9, 2022
4ab3ae7
Update site2/docs/tutorials-tenant.md
DaveDuggins Nov 10, 2022
9a37e00
Update site2/docs/tutorials-produce-consume.md
DaveDuggins Nov 10, 2022
d439f4a
Update site2/docs/tutorials-produce-consume.md
DaveDuggins Nov 10, 2022
eb3b811
Update site2/docs/tutorials-produce-consume.md
DaveDuggins Nov 10, 2022
5e5ba80
Update site2/docs/tutorials-namespace.md
DaveDuggins Nov 10, 2022
e9ea087
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins Nov 10, 2022
1bf6473
Update site2/docs/how-to-landing.md
DaveDuggins Nov 10, 2022
6df9fdf
Merge branch 'apache:master' into master
DaveDuggins Nov 10, 2022
fd0f366
fix link and style issues
momo-jun Nov 11, 2022
33e1ea2
Merge branch 'apache:master' into master
DaveDuggins Nov 14, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions site2/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Select one of the content blocks below to begin your Pulsar journey. If you ...
<BlockLinks>
<BlockLink title="About Pulsar" url="/docs/next/concepts-overview/" />
<BlockLink title="Get Started" url="/docs/next/getting-started-home/" />
<BlockLink title="Install, Deploy, Upgrade" url="/docs/next/deploy-aws/" />
<BlockLink title="Install, Deploy, Upgrade" url="/docs/next/install-deploy-upgrade-landing/" />
<BlockLink title="Pulsar for Developers" url="/docs/next/developers-landing/" />
Comment thread
DaveDuggins marked this conversation as resolved.
Comment thread
momo-jun marked this conversation as resolved.
<BlockLink title="How To" url="/docs/next/functions-develop/" />
<BlockLink title="How To" url="/docs/next/how-to-landing/" />
<BlockLink title="Reference" url="/docs/next/reference-terminology/" />
</BlockLinks>

Expand Down
10 changes: 5 additions & 5 deletions site2/docs/developers-landing.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: developers-landing
title: Pulsar for Developers
sidebar_label: "get started"
sidebar_label: "Pulsar for Developers"
---

Developing applications for Pulsar can be a fun and rewarding experience. With Pulsar, you can quickly create, deploy, and manage your services using a powerful CLI tool and a comprehensive set of libraries. The topics below will get you started!

- [Simulation tools](develop-tools.md)
- [Developing binary protocol](developing-binary-protocol.md)
- [Modular load manager](develop-load-manager.md)
- [Pulsar plugin development](develop-plugin.md)
- [Develop simulation tools](develop-tools.md)
- [Develop binary protocol](developing-binary-protocol.md)
- [Develop load manager](develop-load-manager.md)
- [Develop Pulsar plugin](develop-plugin.md)
17 changes: 17 additions & 0 deletions site2/docs/how-to-landing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
Id: how-to-landing
title: How-to
Comment thread
DaveDuggins marked this conversation as resolved.
sidebar_label: “”
Comment thread
DaveDuggins marked this conversation as resolved.
---


Learning new software can be an overwhelming task, but relax – most aspects of Pulsar can be easily configured in just a few steps. These tutorials will show you how to quickly create topics, tenants, and namespaces, produce and consume messages, and more!
Comment thread
DaveDuggins marked this conversation as resolved.

- [How to create a topic](tutorials-topic.md)
- [How to create a tenant](tutorials-tenant.md)
- [How to create a namespace](tutorials-namespace.md)
- [How to produce and consume messages](tutorials-produce-consume.md)




23 changes: 23 additions & 0 deletions site2/docs/install-deploy-upgrade-landing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
Id: install-deploy-upgrade-landing
title: Install, Deploy and Upgrade Pulsar
sidebar_label: “Tutorials”
---


Any developer can install, deploy, and upgrade Apache Pulsar in a few simple steps and start building scalable, real-time applications quickly. The resources below will kickstart your deployment!

- [Set up a standalone Pulsar locally](getting-started-standalone.md)

- [Deploy a Pulsar cluster on AWS using Terraform and Ansible](deploy-aws.md)

- [Deploy a Pulsar cluster using Helm](helm-deploy.md)

- [Upgrade Pulsar Helm release](helm-upgrade.md)







44 changes: 44 additions & 0 deletions site2/docs/tutorials-namespace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
Id: tutorials-namespace
title: How to create a namespace
sidebar_label: “Tutorials”
---


Pulsar namespaces are logical groupings of topics.

Namespaces can be managed via:

- The namespaces command of the pulsar-admin tool
- The /admin/v2/namespaces endpoint of the admin {@inject: rest:REST:/} API
- The namespaces method of the PulsarAdmin object in the Java API

In this tutorial, we create a namespace called pulsar in the tenant apache. Then we list namespaces of tenant apache to see if the namespace is created successfully.

Create the namespace.

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

Verify the namespace.

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

You should see similar output to show the namespace apache/pulsar has been successfully created.

#### Related Topics

- [Set up a tenant](tutorials-tenant.md)
- [Create a topic](tutorials-topic.md)
- [Produce and consume messages](tutorials-produce-consume.md)
- [Manage clusters](admin-api-clusters.md)







77 changes: 77 additions & 0 deletions site2/docs/tutorials-produce-consume.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
Id: tutorials-produce-consume
title: Produce and consume messages
sidebar_label: “Tutorials”
---

In this tutorial, we will:
- Configure the Pulsar client
- Create a subscription
- Create a producer
- Send test messages
- Verify the results

## Prerequisites

- [Create tenant](tutorials-tenant.md)
- [Create namespace](tutorials-namespace.md)
- [Create topic](tutorials-topic.md)

## Produce and consume messages

1. In the `${PULSAR_HOME}/conf/client.conf` file, replace `webServiceUrl` and `brokerServiceUrl` with your service URL.

2. Create a subscription to consume messages from `apache/pulsar/test-topic`.

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

3. In a new terminal, create a producer and send 10 messages to test-topic.

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

4. Verify the results.

```
----- 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-------

Output from the producer side shows the messages have been produced successfully:
18:15:15.489 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 10 messages successfully produced.
```

#### Related Topics
- [Set up a tenant](tutorials-tenant.md)
- [Create a topic](tutorials-topic.md)
- [Create a namespace](tutorials-namespace.md)
- [Manage clusters](admin-api-clusters.md)









54 changes: 54 additions & 0 deletions site2/docs/tutorials-tenant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
Id: tutorials-tenant
title: How to set up a tenant
sidebar_label: “Tutorials”
---


Pulsar is a powerful messaging system you can use to process and route high volumes of data. Each tenant provides a distinct unit of isolation with its own set of roles, permissions, configuration settings, and bookmarks.

In this tutorial, you will create a new tenant, named “apache” in your Pulsar cluster, hosted in K8s helm.

To create a tenant:

1. Enter the toolset container.

```bash
kubectl exec -it -n pulsar pulsar-mini-toolset-0 -- /bin/bash
```

2. In the toolset container, create a tenant named apache.

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

3. List the tenants to see if the tenant is created successfully.

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

You should see a similar output as below.

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

#### Related Topics

- [How to create a namespace](tutorials-namespace.md)
- [How to create a topic](tutorials-topic.md)
- [Run a standalone cluster in Kubernetes](getting-started-helm.md)









39 changes: 39 additions & 0 deletions site2/docs/tutorials-topic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
Id: tutorials-topic
title: How to create a topic
sidebar_label: “Tutorials”
Comment thread
DaveDuggins marked this conversation as resolved.
---


Apache Pulsar is a distributed messaging system that supports high performance and low latency. Topics are the primary way to structure data in Apache Pulsar. A Pulsar topic is a unit of storage that organizes messages into a stream. Each message in a topic has an offset, which uniquely identifies the message within the topic.

## Prerequisites
[Publish to partitioned topics](admin-api-topics.md#publish-to-partitioned-topics)

## Create a topic

1. Create `test-topic` with 4 partitions in the namespace `apache/pulsar`.

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

2. List all the partitioned topics in the namespace `apache/pulsar`.

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

#### Related Topics

- [How to set up a tenant](tutorials-tenant.md)
- [How to create a namespace](tutorials-namespace.md)
- [How to produce and consume messages](tutorial-produce-consume.md)








4 changes: 4 additions & 0 deletions site2/website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,10 @@
{
"type": "category",
"label": "Deployment",
"link": {
"type": "doc",
"id": "install-deploy-upgrade-landing"
},
"items": [
"deploy-aws",
{
Expand Down