This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 8a21f795082 [improve][doc] SEO for "About" and "Get Started" (#664)
8a21f795082 is described below
commit 8a21f795082d5437bcabfd9687c40618aebf1477
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Wed Aug 9 11:16:41 2023 +0800
[improve][doc] SEO for "About" and "Get Started" (#664)
---
docs/about.md | 1 +
docs/getting-started-docker-compose.md | 9 +++-
docs/getting-started-docker.md | 87 ++++++++++++++++++++++++++++++++--
docs/getting-started-helm.md | 11 ++---
docs/getting-started-standalone.md | 19 ++++----
5 files changed, 105 insertions(+), 22 deletions(-)
diff --git a/docs/about.md b/docs/about.md
index 83f9263d2ac..f3cfa45e2ce 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -3,6 +3,7 @@ slug: /
id: about
title: Welcome to the Apache Pulsar documentation portal
sidebar_label: "About"
+description: Explore the Apache Pulsar documentation and join the
knowledgeable Pulsar community.
---
import BlockLinks from "@site/src/components/ui/BlockLinks";
diff --git a/docs/getting-started-docker-compose.md
b/docs/getting-started-docker-compose.md
index ca3ebb82d6e..fc59b9a3f59 100644
--- a/docs/getting-started-docker-compose.md
+++ b/docs/getting-started-docker-compose.md
@@ -2,9 +2,12 @@
id: getting-started-docker-compose
title: Run a Pulsar cluster locally with Docker Compose
sidebar_label: "Run Pulsar locally with Docker Compose"
+description: Get started with Apache Pulsar on your local machine using Docker
Compose.
---
-## Configure the `compose.yml` template
+To run Pulsar loccally with Docker Compose, follow the steps below.
+
+## Step 1: Configure the `compose.yml` template
To get up and run a Pulsar cluster quickly, you can use the following template
to create a `compose.yml` file by modifying or adding the configurations in the
**environment** section.
@@ -108,7 +111,7 @@ services:
command: bash -c "bin/apply-config-from-env.py conf/broker.conf && exec
bin/pulsar broker"
```
-## Create a Pulsar cluster
+## Step 2: Create a Pulsar cluster
To create a Pulsar cluster by using the `compose.yml` file, run the following
command.
@@ -116,6 +119,8 @@ To create a Pulsar cluster by using the `compose.yml` file,
run the following co
docker compose up -d
```
+## Step 3: Destroy the Pulsar cluster
+
If you want to destroy the Pulsar cluster with all the containers, run the
following command. It will also delete the network that the containers are
connected to.
```bash
diff --git a/docs/getting-started-docker.md b/docs/getting-started-docker.md
index f668f19b3d3..7daa1b604e3 100644
--- a/docs/getting-started-docker.md
+++ b/docs/getting-started-docker.md
@@ -2,26 +2,103 @@
id: getting-started-docker
title: Run a standalone Pulsar cluster in Docker
sidebar_label: "Run Pulsar in Docker"
+description: Get started with Apache Pulsar on your local machine using Docker.
---
+````mdx-code-block
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+````
+
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
-## Start Pulsar in Docker
+To run Pulsar in Docker, follow the steps below.
+
+## Step1: Start Pulsar in Docker
For macOS, Linux, and Windows, run the following command to start Pulsar
within a Docker container.
+````mdx-code-block
+<Tabs groupId="os-choice"
+ defaultValue="macOS & Linux"
+ values={[{"label":"macOS & Linux","value":"macOS &
Linux"},{"label":"Windows","value":"Windows"}]}>
+
+<TabItem value="macOS & Linux">
+
+```shell
+-p 6650:6650 \
+-p 8080:8080 \
+--mount source=pulsardata,target=/pulsar/data \
+--mount source=pulsarconf,target=/pulsar/conf \
+apachepulsar/pulsar:@pulsar:version@ \
+bin/pulsar standalone
+```
+
+</TabItem>
+
+<TabItem value="Windows">
+
```shell
-docker run -it -p 6650:6650 -p 8080:8080 --mount
source=pulsardata,target=/pulsar/data --mount
source=pulsarconf,target=/pulsar/conf apachepulsar/pulsar:@pulsar:version@
bin/pulsar standalone
+docker run -it ^
+-p 6650:6650 ^
+-p 8080:8080 ^
+--mount source=pulsardata,target=/pulsar/data ^
+--mount source=pulsarconf,target=/pulsar/conf ^
+apachepulsar/pulsar:@pulsar:version@ ^
+bin/pulsar standalone
```
+</TabItem>
+
+</Tabs>
+````
+
If you want to change Pulsar configurations and start Pulsar, run the
following command by passing environment variables with the `PULSAR_PREFIX_`
prefix. See [default configuration
file](https://github.com/apache/pulsar/blob/e6b12c64b043903eb5ff2dc5186fe8030f157cfc/conf/standalone.conf)
for more details.
+````mdx-code-block
+<Tabs groupId="os-choice"
+ defaultValue="macOS & Linux"
+ values={[{"label":"macOS & Linux","value":"macOS &
Linux"},{"label":"Windows","value":"Windows"}]}>
+
+<TabItem value="macOS & Linux">
+
+```shell
+docker run -it \
+-e PULSAR_PREFIX_xxx=yyy \
+-p 6650:6650 \
+-p 8080:8080 \
+--mount source=pulsardata,target=/pulsar/data \
+--mount source=pulsarconf,target=/pulsar/conf \
+apachepulsar/pulsar:2.10.0 sh \
+-c "bin/apply-config-from-env.py \
+conf/standalone.conf && \
+bin/pulsar standalone"
+```
+
+</TabItem>
+
+<TabItem value="Windows">
+
```shell
-docker run -it -e PULSAR_PREFIX_xxx=yyy -p 6650:6650 -p 8080:8080 --mount
source=pulsardata,target=/pulsar/data --mount
source=pulsarconf,target=/pulsar/conf apachepulsar/pulsar:2.10.0 sh -c
"bin/apply-config-from-env.py conf/standalone.conf && bin/pulsar standalone"
+docker run -it ^
+-e PULSAR_PREFIX_xxx=yyy ^
+-p 6650:6650 ^
+-p 8080:8080 ^
+--mount source=pulsardata,target=/pulsar/data ^
+--mount source=pulsarconf,target=/pulsar/conf ^
+apachepulsar/pulsar:2.10.0 sh ^
+-c "bin/apply-config-from-env.py ^
+conf/standalone.conf && ^
+bin/pulsar standalone"
```
+</TabItem>
+
+</Tabs>
+````
+
:::tip
* The docker container runs as UID 10000 and GID 0 by default. You need to
ensure the mounted volumes give write permission to either UID 10000 or GID 0.
Note that UID 10000 is arbitrary, so it is recommended to make these mounts
writable for the root group (GID 0).
@@ -46,7 +123,7 @@ After starting Pulsar successfully, you can see `INFO`-level
log messages like t
:::
-## Use Pulsar in Docker
+## Step 2: Use Pulsar in Docker
Pulsar offers a variety of [client libraries](client-libraries.md), such as
[Java](client-libraries-java.md), [Go](client-libraries-go.md),
[Python](client-libraries-python.md), [C++](client-libraries-cpp.md).
@@ -96,7 +173,7 @@ for i in range(10):
client.close()
```
-## Get the topic statistics
+## Step 3: Get the topic statistics
In Pulsar, you can use REST API, Java, or command-line tools to control every
aspect of the system. For details on APIs, refer to [Admin API
Overview](admin-api-overview.md).
diff --git a/docs/getting-started-helm.md b/docs/getting-started-helm.md
index 4d4f87808d5..6ea26dcf776 100644
--- a/docs/getting-started-helm.md
+++ b/docs/getting-started-helm.md
@@ -2,15 +2,10 @@
id: getting-started-helm
title: Run a standalone Pulsar cluster in Kubernetes
sidebar_label: "Run Pulsar in Kubernetes"
+description: Get started with Apache Pulsar on your local machine using
Kubernetes.
---
-This section guides you through every step of installing and running Apache
Pulsar with Helm on Kubernetes quickly, including the following sections:
-
-- Install the Apache Pulsar on Kubernetes using Helm
-- Start and stop Apache Pulsar
-- Create topics using `pulsar-admin`
-- Produce and consume messages using Pulsar clients
-- Monitor Apache Pulsar status with Prometheus and Grafana
+This section guides you through every step of installing and running Apache
Pulsar with Helm on Kubernetes quickly.
For deploying a Pulsar cluster for production usage, read the documentation on
[how to configure and install a Pulsar Helm chart](helm-deploy.md).
@@ -26,6 +21,8 @@ For the following steps, step 2 and step 3 are for
**developers** and step 4 and
:::
+To run Pulsar with Helm on Kubernetes, follow the steps below.
+
## Step 0: Prepare a Kubernetes cluster
Before installing a Pulsar Helm chart, you have to create a Kubernetes
cluster. You can follow [the instructions](helm-prepare.md) to prepare a
Kubernetes cluster.
diff --git a/docs/getting-started-standalone.md
b/docs/getting-started-standalone.md
index 857a6b752fb..ee127ff811f 100644
--- a/docs/getting-started-standalone.md
+++ b/docs/getting-started-standalone.md
@@ -2,6 +2,7 @@
id: getting-started-standalone
title: Run a standalone Pulsar cluster locally
sidebar_label: "Run Pulsar locally"
+description: Get started with Apache Pulsar on your local machine.
---
For local development and testing, you can run Pulsar in standalone mode on
your machine. The standalone mode runs all components inside a single Java
Virtual Machine (JVM) process.
@@ -12,11 +13,13 @@ If you're looking to run a full production Pulsar
installation, see the [Deployi
:::
-## Prerequisites
+To run Pulsar in standalone mode on your machine, follow the steps below.
+
+## Step 0: Prerequisites
- JRE (64-bit). Different Pulsar versions rely on different JRE versions. For
how to choose the JRE version, see [Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
-## Download Pulsar distribution
+## Step 1: Download Pulsar distribution
Download the official Apache Pulsar distribution:
@@ -52,7 +55,7 @@ The following directories are created:
| **examples** | [Pulsar Functions](functions-overview.md) examples
|
| **instances** | Artifacts for [Pulsar Functions](functions-overview.md)
|
-## Start a Pulsar standalone cluster
+## Step 2: Start a Pulsar standalone cluster
Run this command to start a standalone Pulsar cluster:
@@ -74,7 +77,7 @@ When the Pulsar cluster starts, the following directories are
created:
:::
-## Create a topic
+## Step 3: Create a topic
Pulsar stores messages in topics. It's a good practice to explicitly create
topics before using them, even if Pulsar can automatically create topics when
they are referenced.
@@ -84,7 +87,7 @@ To create a new topic, run this command:
bin/pulsar-admin topics create persistent://public/default/my-topic
```
-## Write messages to the topic
+## Step 4: Write messages to the topic
You can use the `pulsar` command line tool to write messages to a topic. This
is useful for experimentation, but in practice you'll use the Producer API in
your application code, or Pulsar IO connectors for pulling data in from other
systems to Pulsar.
@@ -94,7 +97,7 @@ Run this command to produce a message:
bin/pulsar-client produce my-topic --messages 'Hello Pulsar!'
```
-## Read messages from the topic
+## Step 5: Read messages from the topic
Now that some messages have been written to the topic, run this command to
launch the consumer and read those messages back:
@@ -113,7 +116,7 @@ You'll see the messages you produce in the previous step:
key:[null], properties:[], content:Hello Pulsar!
```
-## Write some more messages
+## Step 6: Write some more messages
Leave the consume command from the previous step running. If you've already
closed it, just re-run it.
@@ -125,7 +128,7 @@ bin/pulsar-client produce my-topic --messages "$(seq -s, -f
'Message NO.%g' 1 10
Note how they are displayed almost instantaneously in the consumer terminal.
-## Stop the Pulsar cluster
+## Step 7: Stop the Pulsar cluster
Once you've finished you can shut down the Pulsar cluster. Press **Ctrl-C** in
the terminal window in which you started the cluster.
