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 7f8d94f6762 [improve][doc] SEO for deployment (#681)
7f8d94f6762 is described below
commit 7f8d94f676269fb709061c50df6f43737206182a
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Mon Sep 4 10:40:55 2023 +0800
[improve][doc] SEO for deployment (#681)
---
docs/deploy-aws.md | 15 +++++++++------
docs/deploy-bare-metal-multi-cluster.md | 19 ++++++++-----------
docs/deploy-bare-metal.md | 30 +++++++++++++-----------------
docs/deploy-docker.md | 12 +++++-------
docs/deploy-ibm.md | 17 ++++++-----------
docs/helm-deploy.md | 13 +++++--------
docs/helm-prepare.md | 1 +
docs/helm-upgrade.md | 3 ++-
8 files changed, 49 insertions(+), 61 deletions(-)
diff --git a/docs/deploy-aws.md b/docs/deploy-aws.md
index 0994114269a..a0767576148 100644
--- a/docs/deploy-aws.md
+++ b/docs/deploy-aws.md
@@ -2,12 +2,15 @@
id: deploy-aws
title: Deploy a Pulsar cluster on AWS using Terraform and Ansible
sidebar_label: "Terraform (AWS)"
+description: Learn to deploy a Pulsar cluster on AWS using Terraform and
Ansible.
---
> For instructions on deploying a single Pulsar cluster manually rather than
> using Terraform and Ansible, see [Deploying a Pulsar cluster on bare
> metal](deploy-bare-metal.md). For instructions on manually deploying a
> multi-cluster Pulsar instance, see [Deploying a Pulsar instance on bare
> metal](deploy-bare-metal-multi-cluster.md).
One of the easiest ways to get a Pulsar
[cluster](reference-terminology.md#cluster) running on [Amazon Web
Services](https://aws.amazon.com/) (AWS) is to use the
[Terraform](https://terraform.io) infrastructure provisioning tool and the
[Ansible](https://www.ansible.com) server automation tool. Terraform can create
the resources necessary for running the Pulsar
cluster---[EC2](https://aws.amazon.com/ec2/) instances, networking and security
infrastructure, etc.---While Ansible can install [...]
+To deploy a Pulsar cluster on AWS, complete the following steps.
+
## Requirements and setup
To install a Pulsar cluster on AWS using Terraform and Ansible, you need to
prepare the following things:
@@ -22,7 +25,7 @@ You also need to make sure that you are currently logged into
your AWS account v
aws configure
```
-## Installation
+## Step 1: Installation
You can install Ansible on Linux or macOS using pip.
@@ -39,7 +42,7 @@ git clone https://github.com/apache/pulsar
cd pulsar/deployment/terraform-ansible/aws
```
-## SSH setup
+## Step 2: SSH setup
> If you already have an SSH key and want to use it, you can skip the step of
> generating an SSH key and update `private_key_file` setting in `ansible.cfg`
> file and `public_key_path` setting in `terraform.tfvars` file.
>
@@ -74,7 +77,7 @@ ls ~/.ssh
id_rsa id_rsa.pub
```
-## Create AWS resources using Terraform
+## Step 3: Create AWS resources using Terraform
To start building AWS resources with Terraform, you need to install all
Terraform dependencies. Enter the following command:
@@ -157,7 +160,7 @@ At any point, you can destroy all AWS resources associated
with your cluster usi
terraform destroy
```
-## Setup Disks
+## Step 4: Setup Disks
Before you run the Pulsar playbook, you need to mount the disks to the correct
directories on those bookie nodes. Since different types of machines have
different disk layouts, you need to update the task defined in the
`setup-disk.yaml` file after changing the `instance_types` in your terraform
config,
@@ -173,7 +176,7 @@ setup-disk.yaml
After that, the disks are mounted under `/mnt/journal` as journal disk, and
`/mnt/storage` as ledger disk.
Remember to enter this command just only once. If you attempt to enter this
command again after you have run the Pulsar playbook, your disks might
potentially be erased again, causing the bookies to fail to start up.
-## Run the Pulsar playbook
+## Step 5: Run the Pulsar playbook
Once you have created the necessary AWS resources using Terraform, you can
install and run Pulsar on the Terraform-created EC2 instances using Ansible.
@@ -198,7 +201,7 @@ ansible-playbook \
../deploy-pulsar.yaml
```
-## Access the cluster
+## Step 6: Access the cluster
You can now access your running Pulsar using the unique Pulsar connection URL
for your cluster, which you can obtain following the instructions
[above](#fetch-your-pulsar-connection-url).
diff --git a/docs/deploy-bare-metal-multi-cluster.md
b/docs/deploy-bare-metal-multi-cluster.md
index ac8c7c24884..9d65f9d80c6 100644
--- a/docs/deploy-bare-metal-multi-cluster.md
+++ b/docs/deploy-bare-metal-multi-cluster.md
@@ -2,6 +2,7 @@
id: deploy-bare-metal-multi-cluster
title: Deploying a multi-cluster on bare metal
sidebar_label: "Bare metal multi-cluster"
+description: Learn to deploy a multi-cluster Pulsar instance on bare metal.
---
:::tip
@@ -12,17 +13,13 @@ sidebar_label: "Bare metal multi-cluster"
:::
-A Pulsar instance consists of multiple Pulsar clusters working in unison. You
can distribute clusters across data centers or geographical regions and
replicate the clusters amongst themselves using
[geo-replication](administration-geo.md). Deploying a multi-cluster Pulsar
instance consists of the following steps:
-
-1. Deploying two separate ZooKeeper quorums: a local quorum for each cluster
in the instance and a configuration store quorum for instance-wide tasks
-2. Initializing cluster metadata for each cluster
-3. Deploying a BookKeeper cluster of bookies in each Pulsar cluster
-4. Deploying brokers in each Pulsar cluster
-
+A Pulsar instance consists of multiple Pulsar clusters working in unison. You
can distribute clusters across data centers or geographical regions and
replicate the clusters amongst themselves using
[geo-replication](administration-geo.md).
> #### Run Pulsar locally or on Kubernetes?
> This guide shows you how to deploy Pulsar in production in a non-Kubernetes
> environment. If you want to run a standalone Pulsar cluster on a single
> machine for development purposes, see the [Setting up a local
> cluster](getting-started-standalone.md) guide. If you want to run Pulsar on
> [Kubernetes](https://kubernetes.io), see the [Pulsar on
> Kubernetes](deploy-kubernetes.md) guide, which includes sections on running
> Pulsar on Kubernetes, on Google Kubernetes Engine and on Amazon Web Services.
+Deploying a multi-cluster Pulsar instance on bare metal consists of the
following steps.
+
## System requirement
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and
**Windows**. To use Pulsar, you need to install 64-bit JRE/JDK.
@@ -76,7 +73,7 @@ Directory | Contains
`logs` | Logs that the installation creates
-## Deploy ZooKeeper
+## Step 1: Deploy ZooKeeper
Each Pulsar instance relies on two separate ZooKeeper quorums.
@@ -197,7 +194,7 @@ Once your configuration store configuration is in place,
you can start up the se
bin/pulsar-daemon start configuration-store
```
-## Cluster metadata initialization
+## Step 2: Cluster metadata initialization
Once you set up the cluster-specific ZooKeeper and configuration store quorums
for your instance, you need to write some metadata to ZooKeeper for each
cluster in your instance. **you only need to write these metadata once**.
@@ -226,7 +223,7 @@ If you use [TLS](security-tls-transport.md), you also need
to specify a TLS web
Make sure to run `initialize-cluster-metadata` for each cluster in your
instance.
-## Deploy BookKeeper
+## Step 3: Deploy BookKeeper
BookKeeper provides [persistent message
storage](concepts-architecture-overview.md#persistent-storage) for Pulsar.
@@ -273,7 +270,7 @@ designed to use multiple devices:
-## Deploy brokers
+## Step 4: Deploy brokers
Once you set up ZooKeeper, initialize cluster metadata, and spin up BookKeeper
bookies, you can deploy brokers.
diff --git a/docs/deploy-bare-metal.md b/docs/deploy-bare-metal.md
index a09b11f1482..0d3dca12ae4 100644
--- a/docs/deploy-bare-metal.md
+++ b/docs/deploy-bare-metal.md
@@ -2,6 +2,7 @@
id: deploy-bare-metal
title: Deploy a cluster on bare metal
sidebar_label: "Bare metal"
+description: Learn to deploy a Pulsar cluster on bare metal.
---
:::tip
@@ -12,12 +13,7 @@ sidebar_label: "Bare metal"
:::
-Deploying a Pulsar cluster consists of the following steps:
-
-1. Deploy a [ZooKeeper](#deploy-a-zookeeper-cluster) cluster (optional)
-2. Initialize [cluster metadata](#initialize-cluster-metadata)
-3. Deploy a [BookKeeper](#deploy-a-bookkeeper-cluster) cluster
-4. Deploy one or more Pulsar [brokers](#deploy-pulsar-brokers)
+Deploying a Pulsar cluster on bare metal consists of the following steps.
## Preparation
@@ -50,7 +46,7 @@ To run Pulsar on bare metal, the following configuration is
recommended:
The following is a diagram showing the basic setup:
-
+
In this diagram, connecting clients need to communicate with the Pulsar
cluster using a single URL. In this case, `pulsar-cluster.acme.com` abstracts
over all of the message-handling brokers. Pulsar message brokers run on
machines alongside BookKeeper bookies; brokers and bookies, in turn, rely on
ZooKeeper.
@@ -58,18 +54,18 @@ In this diagram, connecting clients need to communicate
with the Pulsar cluster
If you deploy a Pulsar cluster, keep in mind the following basic better
choices when you do the capacity planning.
-#### ZooKeeper
+##### ZooKeeper
For machines running ZooKeeper, it is recommended to use less powerful
machines or VMs. Pulsar uses ZooKeeper only for periodic coordination-related
and configuration-related tasks, not for basic operations. If you run Pulsar on
[Amazon Web Services](https://aws.amazon.com/) (AWS), for example, a
[t2.small](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-instances.html)
instance might likely suffice.
-#### Bookies and Brokers
+##### Bookies and Brokers
For machines running a bookie and a Pulsar broker, more powerful machines are
required. For an AWS deployment, for example,
[i3.4xlarge](https://aws.amazon.com/blogs/aws/now-available-i3-instances-for-demanding-io-intensive-applications/)
instances may be appropriate. On those machines you can use the following:
* Fast CPUs and 10Gbps
[NIC](https://en.wikipedia.org/wiki/Network_interface_controller) (for Pulsar
brokers)
* Small and fast [solid-state
drives](https://en.wikipedia.org/wiki/Solid-state_drive) (SSDs) or [hard disk
drives](https://en.wikipedia.org/wiki/Hard_disk_drive) (HDDs) with a
[RAID](https://en.wikipedia.org/wiki/RAID) controller and a battery-backed
write cache (for BookKeeper bookies)
-#### Hardware recommendations
+##### Hardware recommendations
To start a Pulsar instance, below are the minimum and the recommended hardware
settings.
@@ -91,7 +87,7 @@ A cluster consists of 3 broker nodes, 3 bookie nodes, and 3
ZooKeeper nodes. The
Bookie|4|8GB|Journal: 256 GB<br /><br />PD-SSDLedger: 2 TB,
PD-STANDARD|Write throughput: 75 MB/s<br /><br />Read throughput: 75 MB/s<br
/><br />|Write rate: 7,500 entries/s<br /><br />Read rate: 7,500 entries/s
ZooKeeper|1|2 GB|Log: 64 GB, PD-SSD<br /><br />Data: 256 GB, PD-STANDARD|/|/
-## Install the Pulsar binary package
+### Install the Pulsar binary package
> You need to install the Pulsar binary package on each machine in the
> cluster, including machines running ZooKeeper and BookKeeper.
@@ -124,7 +120,7 @@ Directory | Contains
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files that
Pulsar uses
`logs` | Logs that the installation creates
-## Install Built-in Connectors (optional)
+### Install Built-in Connectors (optional)
To use `built-in` connectors, you need to download the connectors tarball
release on every broker node in one of the following ways :
@@ -152,7 +148,7 @@ pulsar-io-aerospike-@pulsar:[email protected]
...
```
-## Install Tiered Storage Offloaders (optional)
+### Install Tiered Storage Offloaders (optional)
To use tiered storage offloaders, you need to download the offloaders tarball
release on every broker node in one of the following ways:
@@ -185,7 +181,7 @@ tiered-storage-jcloud-@pulsar:[email protected]
For more details of how to configure tiered storage feature, you can refer to
the [Tiered storage cookbook](cookbooks-tiered-storage.md)
-## Deploy a ZooKeeper cluster
+## Step 1: Deploy a ZooKeeper cluster
:::note
@@ -237,7 +233,7 @@ bin/pulsar-daemon start zookeeper
> If you plan to deploy Zookeeper with the Bookie on the same node, you need
> to start zookeeper by using different stats
> port by configuring the `metricsProvider.httpPort` in zookeeper.conf.
-## Initialize cluster metadata
+## Step 2: Initialize cluster metadata
:::note
@@ -296,7 +292,7 @@ You can obtain the metadata service URI of the existing
BookKeeper cluster by us
:::
-## Deploy a BookKeeper cluster
+## Step 3: Deploy a BookKeeper cluster
[BookKeeper](https://bookkeeper.apache.org) handles all persistent data
storage in Pulsar. You need to deploy a cluster of BookKeeper bookies to use
Pulsar. You can choose to run a **3-bookie BookKeeper cluster**.
@@ -339,7 +335,7 @@ bin/bookkeeper shell simpletest --ensemble <num-bookies>
--writeQuorum <num-book
This command creates a `num-bookies` sized ledger on the cluster, writes a few
entries, and finally deletes the ledger.
-## Deploy Pulsar brokers
+## Step 4: Deploy Pulsar brokers
Pulsar brokers are the last thing you need to deploy in your Pulsar cluster.
Brokers handle Pulsar messages and provide the administrative interface of
Pulsar. A good choice is to run **3 brokers**, one for each machine that
already runs a BookKeeper bookie.
diff --git a/docs/deploy-docker.md b/docs/deploy-docker.md
index 3b3367162e8..baf1de1a7af 100644
--- a/docs/deploy-docker.md
+++ b/docs/deploy-docker.md
@@ -2,14 +2,12 @@
id: deploy-docker
title: Deploy a cluster on Docker
sidebar_label: "Docker"
+description: Learn to deploy a Pulsar cluster on Docker.
---
-To deploy a Pulsar cluster on Docker using Docker commands, you need to
complete the following steps:
-1. Pull a Pulsar Docker image.
-2. Create a network.
-3. Create and start the ZooKeeper, bookie, and broker containers.
+To deploy a Pulsar cluster on Docker using Docker commands, you need to
complete the following steps.
-## Pull a Pulsar image
+## Step 1: Pull a Pulsar image
To run Pulsar on Docker, you need to create a container for each Pulsar
component: ZooKeeper, bookie, and the broker. You can pull the images of
ZooKeeper and bookie separately on Docker Hub, and pull the Pulsar image for
the broker. You can also pull only one Pulsar image and create three containers
with this image. This tutorial takes the second option as an example.
@@ -18,7 +16,7 @@ You can pull a Pulsar image from Docker Hub with the
following command. If you d
docker pull apachepulsar/pulsar-all:latest
```
-## Create a network
+## Step 2: Create a network
To deploy a Pulsar cluster on Docker, you need to create a network and connect
the containers of ZooKeeper, bookie, and broker to this network.
Use the following command to create the network `pulsar`:
@@ -27,7 +25,7 @@ Use the following command to create the network `pulsar`:
docker network create pulsar
```
-## Create and start containers
+## Step 3: Create and start containers
### Create a ZooKeeper container
diff --git a/docs/deploy-ibm.md b/docs/deploy-ibm.md
index 1966d17696a..16f9d6137be 100644
--- a/docs/deploy-ibm.md
+++ b/docs/deploy-ibm.md
@@ -3,6 +3,7 @@ id: deploy-ibm
title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart
sidebar_label: "IBM Cloud Services"
original_id: deploy-ibm
+description: Learn to deploy a Pulsar cluster on IBM cloud.
---
:::tip
@@ -12,15 +13,9 @@ This tutorial uses Apache Pulsar 2.9.3 as an example. If you
want to upgrade Pul
:::
-Deploying a Pulsar cluster on IBM cloud consists of the following steps:
+Deploying a Pulsar cluster on IBM cloud consists of the following steps.
-1. [Create VM on IBM Cloud.](#create-vm-on-ibm-cloud)
-2. [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm)
-3. [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm
chart on Kubernetes
cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster)
-4. [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment)
-
-
-## 1. Create VM on IBM Cloud
+## Step 1: Create VM on IBM Cloud
1. Go to [IBM Cloud](
https://cloud.ibm.com/?cm_sp=freelancer-_-pulsar-iks-_-cta) and login with
your credentials.
2. Search for Virtual Server.
@@ -71,7 +66,7 @@ Deploying a Pulsar cluster on IBM cloud consists of the
following steps:
-## 2. Create Kubernetes Cluster on IBM
+## Step 2: Create Kubernetes Cluster on IBM
1. Search for the Kubernetes services
@@ -116,7 +111,7 @@ Deploying a Pulsar cluster on IBM cloud consists of the
following steps:
-## 3. Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm
chart on Kubernetes cluster.
+## Step 3: Prepare VM for connecting to Kubernetes cluster and deploy Pulsar
Helm chart on Kubernetes cluster.
**Prerequisites**
1. Install [IBM Cloud
CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli) and connect
to Kubernetes master node.
@@ -163,7 +158,7 @@ Output
> Now we are able to run commands of kubectl.
-## 4. Verify the deployment
+## Step 4: Verify the deployment
Make sure all the pods of Pulsar are running. Get the service URL and broker
URL for publishing and consuming the messages.
diff --git a/docs/helm-deploy.md b/docs/helm-deploy.md
index f342d89a2a3..04b46e659d6 100644
--- a/docs/helm-deploy.md
+++ b/docs/helm-deploy.md
@@ -2,15 +2,12 @@
id: helm-deploy
title: Deploy a Pulsar cluster on Kubernetes
sidebar_label: "Deploy"
+description: Learn to deploy a Pulsar cluster on Kubernetes.
---
Before deploying a Pulsar cluster, you need to [prepare Kubernetes
resources](helm-prepare.md) and then continue with the following steps.
-1. Select configuration options
-2. Install dependent charts
-3. Prepare Helm release
-4. Deploy your Pulsar cluster using Helm
-## Select configuration options
+## Step 1: Select configuration options
Specify how to run Pulsar using Helm's `--set option.name=value` command line
option. In each section, collect the options that are combined to use with the
`helm install` command.
@@ -276,7 +273,7 @@ By default, the resource requests and the number of
replicas for the Pulsar comp
Once you have all of your configuration options collected, you can install
dependent charts before installing the Pulsar Helm Chart.
-## Install dependent charts
+## Step 2: Install dependent charts
### Install storage provisioner
@@ -300,7 +297,7 @@ cd pulsar-helm-chart
./scripts/cert-manager/install-cert-manager.sh
```
-## Prepare Helm release
+## Step 3: Prepare Helm release
Once you have installed all the dependent charts and collected all of your
configuration options, you can run
[prepare_helm_release.sh](https://github.com/apache/pulsar-helm-chart/blob/master/scripts/pulsar/prepare_helm_release.sh)
to prepare the Helm release.
@@ -318,7 +315,7 @@ The `prepare_helm_release` creates the following resources:
- the `proxy-admin` role is used for proxies to communicate with brokers.
- the `admin` role is used by the admin tools.
-## Deploy Pulsar cluster using Helm
+## Step 4: Deploy Pulsar cluster using Helm
Once you have finished the above steps, you can install a Helm release.
diff --git a/docs/helm-prepare.md b/docs/helm-prepare.md
index d87ffb7cd69..3d0fe3ab577 100644
--- a/docs/helm-prepare.md
+++ b/docs/helm-prepare.md
@@ -2,6 +2,7 @@
id: helm-prepare
title: Prepare Kubernetes resources
sidebar_label: "Prepare"
+description: Learn to create a Kubernetes cluster before deploying the Apache
Pulsar Helm Chart.
---
For a fully functional Pulsar cluster, you need a few resources before
deploying the Apache Pulsar Helm Chart. This section provides the information
about the preparations you need to do before deploying the Pulsar Helm Chart.
diff --git a/docs/helm-upgrade.md b/docs/helm-upgrade.md
index 209b1427032..6fc41b7c0dd 100644
--- a/docs/helm-upgrade.md
+++ b/docs/helm-upgrade.md
@@ -2,10 +2,11 @@
id: helm-upgrade
title: Upgrade Pulsar Helm release
sidebar_label: "Upgrade"
+description: Learn to upgrade Apache Pulsar Helm to a newer version.
---
-To upgrade Apache Pulsar Helm to a newer version, complete the following steps:
+To upgrade Apache Pulsar Helm to a newer version, complete the following steps.
1. Check the change log for the specific version you would like to upgrade to
and read the release notes that might pertain to the new Pulsar Helm Chart
version.
