You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by mm...@apache.org on 2018/12/10 17:21:54 UTC

[pulsar] branch master updated: [website][doc] Update the deployment documentation on how to deploy Pulsar to one node (#3152)

This is an automated email from the ASF dual-hosted git repository.

mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new a60fb3f  [website][doc] Update the deployment documentation on how to deploy Pulsar to one node (#3152)
a60fb3f is described below

commit a60fb3f602025991257f5967967adbef6867d624
Author: Sijie Guo <gu...@gmail.com>
AuthorDate: Tue Dec 11 01:21:50 2018 +0800

    [website][doc] Update the deployment documentation on how to deploy Pulsar to one node (#3152)
    
    *Motivation*
    
    Sometimes, people might try out Pulsar by using one machine and expand to multiple nodes
    later. The steps to deploy Pulsar to one node is same as deploying to multiple nodes.
    However there are some places required attentions. This PR is to update the deployment doc
    with instructions on how to deploy Pulsar to one node
---
 site2/docs/deploy-bare-metal.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/site2/docs/deploy-bare-metal.md b/site2/docs/deploy-bare-metal.md
index 3669af9..af14062 100644
--- a/site2/docs/deploy-bare-metal.md
+++ b/site2/docs/deploy-bare-metal.md
@@ -29,13 +29,16 @@ Deploying a Pulsar cluster involves doing the following (in order):
 > If you already have an existing zookeeper cluster and would like to reuse it, you don't need to prepare the machines
 > for running ZooKeeper.
 
-To run Pulsar on bare metal, you will need:
+To run Pulsar on bare metal, you are recommended to have:
 
 * At least 6 Linux machines or VMs
   * 3 running [ZooKeeper](https://zookeeper.apache.org)
   * 3 running a Pulsar broker, and a [BookKeeper](https://bookkeeper.apache.org) bookie
 * A single [DNS](https://en.wikipedia.org/wiki/Domain_Name_System) name covering all of the Pulsar broker hosts
 
+> However if you don't have enough machines, or are trying out Pulsar in cluster mode (and expand the cluster later),
+> you can even deploy Pulsar in one node, where it will run zookeeper, bookie and broker in same machine.
+
 Each machine in your cluster will need to have [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or higher installed.
 
 Here's a diagram showing the basic setup:
@@ -148,6 +151,8 @@ server.2=zk2.us-west.example.com:2888:3888
 server.3=zk3.us-west.example.com:2888:3888
 ```
 
+> If you have only one machine to deploy Pulsar, you just need to add one server entry in the configuration file.
+
 On each host, you need to specify the ID of the node in each node's `myid` file, which is in each server's `data/zookeeper` folder by default (this can be changed via the [`dataDir`](reference-configuration.md#zookeeper-dataDir) parameter).
 
 > See the [Multi-server setup guide](https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#sc_zkMulitServerSetup) in the ZooKeeper documentation for detailed info on `myid` and more.
@@ -268,6 +273,19 @@ You also need to specify the cluster name (matching the name that you provided w
 clusterName=pulsar-cluster-1
 ```
 
+> If you deploy Pulsar in a one-node cluster, you should update the replication settings in `conf/broker.conf` to `1`
+>
+> ```properties
+> # Number of bookies to use when creating a ledger
+> managedLedgerDefaultEnsembleSize=1
+>
+> # Number of copies to store for each message
+> managedLedgerDefaultWriteQuorum=1
+> 
+> # Number of guaranteed copies (acks to wait before write is complete)
+> managedLedgerDefaultAckQuorum=1
+> ```
+
 ### Enabling Pulsar Functions (optional)
 
 If you want to enable [Pulsar Functions](functions-overview.md), you can follow the instructions as below: