Fix the cluster setup instructions. #21

radekg · 2016-09-18T21:08:18Z

Motivation

The current cluster setup instructions are inaccurate.

Modifications

Updated cluster setup instructions.

Result

Reduce the time it takes to setup a cluster by removing the time it takes to find all this info yourself.

yahoocla · 2016-09-18T21:08:19Z

Thank you for submitting this pull request, however I do not see a valid CLA on file for you. Before we can merge this request please visit https://yahoocla.herokuapp.com/ and agree to the terms. Thanks! 😄

yahoocla · 2016-09-18T21:08:19Z

CLA is valid!

radekg · 2016-09-18T21:09:24Z

docs/ClusterSetup.md

-server.1=zk1.us-west.example.com:2181
-server.2=zk2.us-west.example.com:2181
-server.3=zk3.us-west.example.com:2181
+server.1=zk1.us-west.example.com:2888:3888


The default quorum and leader election ports are 2888:3888 for port 2181.

Good point.

radekg · 2016-09-18T21:09:35Z

docs/ClusterSetup.md

-             --global-zookeeper zk1.us-west.example.com:2184 \
-             --service-url http://pulsar.us-west.example.com:8080/ \
-						 --service-url-tls https://pulsar.us-west.example.com:8443/
+$ bin/pulsar initialize-cluster-metadata --cluster us-west \


Missing command.

radekg · 2016-09-18T21:11:26Z

docs/ClusterSetup.md

@@ -183,6 +183,9 @@ ledgerDirectories=data/bookkeeper/ledgers

 # Point to local ZK quorum
 zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+
+# Change the ledger manager type
+ledgerManagerType=hierarchical


The broker expects hierarchical while default is flat. The omission causes the failure while starting the broker. The failure goes along the lines of:

2016-09-18 20:31:08,601 - ERROR [main:PulsarService@311] - Configured layout org.apache.bookkeeper.meta.HierarchicalLedgerManagerFactory does not match existing layout org.apache.bookkeeper.meta.FlatLedgerManagerFactory java.io.IOException: Configured layout org.apache.bookkeeper.meta.HierarchicalLedgerManagerFactory does not match existing layout org.apache.bookkeeper.meta.FlatLedgerManagerFactory at org.apache.bookkeeper.meta.LedgerManagerFactory.newLedgerManagerFactory(LedgerManagerFactory.java:159) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:299) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:266) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:243) at com.yahoo.pulsar.broker.BookKeeperClientFactoryImpl.create(BookKeeperClientFactoryImpl.java:79) at com.yahoo.pulsar.broker.ManagedLedgerClientFactory.<init>(ManagedLedgerClientFactory.java:38) at com.yahoo.pulsar.broker.PulsarService.start(PulsarService.java:231) at com.yahoo.pulsar.PulsarBrokerStarter.main(PulsarBrokerStarter.java:59) 2016-09-18 20:31:08,603 - ERROR [main:PulsarBrokerStarter@62] - Failed to start pulsar service. com.yahoo.pulsar.broker.PulsarServerException: java.io.IOException: Configured layout org.apache.bookkeeper.meta.HierarchicalLedgerManagerFactory does not match existing layout org.apache.bookkeeper.meta.FlatLedgerManagerFactory at com.yahoo.pulsar.broker.PulsarService.start(PulsarService.java:312) at com.yahoo.pulsar.PulsarBrokerStarter.main(PulsarBrokerStarter.java:59) Caused by: java.io.IOException: Configured layout org.apache.bookkeeper.meta.HierarchicalLedgerManagerFactory does not match existing layout org.apache.bookkeeper.meta.FlatLedgerManagerFactory at org.apache.bookkeeper.meta.LedgerManagerFactory.newLedgerManagerFactory(LedgerManagerFactory.java:159) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:299) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:266) at org.apache.bookkeeper.client.BookKeeper.<init>(BookKeeper.java:243) at com.yahoo.pulsar.broker.BookKeeperClientFactoryImpl.create(BookKeeperClientFactoryImpl.java:79) at com.yahoo.pulsar.broker.ManagedLedgerClientFactory.<init>(ManagedLedgerClientFactory.java:38) at com.yahoo.pulsar.broker.PulsarService.start(PulsarService.java:231) ... 1 more

I think the misunderstanding here is that these instructions are supposed to point to the config file keys that needs to be changed. The text in the block is not a valid complete configuration.

If you look in the conf/bookkeeper.conf, the ledgerManagerType=hierarchical line is already there.

Perhaps the text should make more clear to use the conf/bookkeeper.conf as the starting point and edit the specified lines.

That might be the case, indeed. However, these changes are absolute minimum to make it work without having to modify existing files (i.e. create bare minimum viable config). When using configuration management in any form, it might be easier to just apply the minimum config.

Main issue is that the minimum viable config might not be the best config for production use. In the broker config we can fix that, and already the conf file should have the same values that are taken as default. In BookKeeper config, however, we want to have different values from the BK defaults.

radekg · 2016-09-18T21:12:12Z

docs/ClusterSetup.md

@@ -221,6 +224,7 @@ zookeeperServers=zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.u
 globalZookeeperServers=zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184

 clusterName=us-west
+statusFilePath=broker-status-file


This setting is required. The broker will fail to start with a cryptic error. The error message could be improved, it does not mention that the required setting is missing in configuration. It only says something along the lines of required statusFilePath not set without pointing to configuration.

Maybe worth changing the default here? https://github.com/yahoo/pulsar/blob/master/conf/broker.conf#L78
The default is a little bit odd: statusFilePath=/usr/local/apache/htdocs

As per below comment: the example only states the configuration values to modify

This setting did not work for me, is there a default provided in the code? Or does this setting rely on being set in the file? If the latter, might be worth providing a sane default in the code so the broker does not error if the user misses this?

I'd swear I setup the test env with the above step and this setting was not preventing the broker from functioning. I need some time to look into it again

I just tried again to double-check. The status file settings that are in the conf/broker.conf file are "fine", in the sense that they don't prevent the broker from starting correctly.

About the statusFilePath setting, this is used to control whether the broker should be considered as "in-rotation" or "out-of-rotation" from an external monitor process. I'm not sure how useful would this be outside of Yahoo though.

Can you just remove this statusFilePath addition? I have that addressed in #28

radekg · 2016-09-18T21:14:17Z

Figuring out all these has been documented here: #19.

merlimat

Thanks for taking the time for this. Just a couple of comment on the required conf fields

merlimat · 2016-09-19T01:37:44Z

docs/ClusterSetup.md

-server.1=zk1.us-west.example.com:2181
-server.2=zk2.us-west.example.com:2181
-server.3=zk3.us-west.example.com:2181
+server.1=zk1.us-west.example.com:2888:3888


Good point.

merlimat · 2016-09-19T01:38:01Z

docs/ClusterSetup.md

-             --global-zookeeper zk1.us-west.example.com:2184 \
-             --service-url http://pulsar.us-west.example.com:8080/ \
-						 --service-url-tls https://pulsar.us-west.example.com:8443/
+$ bin/pulsar initialize-cluster-metadata --cluster us-west \


merlimat · 2016-09-19T01:39:58Z

docs/ClusterSetup.md

+                                         --zookeeper zk1.us-west.example.com:2181 \
+                                         --global-zookeeper zk1.us-west.example.com:2184 \
+                                         --service-url http://pulsar.us-west.example.com:8080/ \
+						                             --service-url-tls https://pulsar.us-west.example.com:8443/


Last line seems to have extra spaces compared to the rest

Corrected in a6df343

merlimat · 2016-09-19T01:43:02Z

docs/ClusterSetup.md

@@ -183,6 +183,9 @@ ledgerDirectories=data/bookkeeper/ledgers

 # Point to local ZK quorum
 zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+
+# Change the ledger manager type
+ledgerManagerType=hierarchical


I think the misunderstanding here is that these instructions are supposed to point to the config file keys that needs to be changed. The text in the block is not a valid complete configuration.

If you look in the conf/bookkeeper.conf, the ledgerManagerType=hierarchical line is already there.

Perhaps the text should make more clear to use the conf/bookkeeper.conf as the starting point and edit the specified lines.

merlimat · 2016-09-19T01:43:43Z

docs/ClusterSetup.md

@@ -221,6 +224,7 @@ zookeeperServers=zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.u
 globalZookeeperServers=zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184

 clusterName=us-west
+statusFilePath=broker-status-file


As per below comment: the example only states the configuration values to modify

merlimat

Looks good!

* Relocate instance and spawner to be under `runtime` package * fix the pom files and travis build

* Add golangci-lint for formatting code

*Motivation* Need to port Kafka's coordinator algorithm. It requires using Kafka's timer and deplayed operations.

Fix the cluster setup instructions.

2264c35

radekg commented Sep 18, 2016

View reviewed changes

merlimat reviewed Sep 19, 2016

View reviewed changes

merlimat added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 19, 2016

merlimat added this to the 1.15 milestone Sep 19, 2016

merlimat self-assigned this Sep 19, 2016

radekg added 2 commits September 19, 2016 21:37

Fix tabs / spaces issue.

a8a8e8d

Remove statusFilePath addition as per #28.

e6fd5c9

merlimat approved these changes Sep 20, 2016

View reviewed changes

merlimat merged commit b5d0ebb into apache:master Sep 20, 2016

radekg deleted the update-cluster-setup-docs branch September 20, 2016 22:11

sijie added a commit to sijie/pulsar that referenced this pull request Mar 4, 2018

Relocate packages (apache#21)

5adc066

* Relocate instance and spawner to be under `runtime` package * fix the pom files and travis build

hrsakai pushed a commit to hrsakai/pulsar that referenced this pull request Dec 10, 2020

Add golangci-lint for formatting code (apache#21)

c53f30d

* Add golangci-lint for formatting code

LutzWeischerFujitsu mentioned this pull request Mar 17, 2021

test fails on AArch64, Fedora 33 #9936

Closed

hangc0276 referenced this pull request in hangc0276/pulsar May 26, 2021

Port Kafka timer classes (#21)

4ef4517

*Motivation* Need to port Kafka's coordinator algorithm. It requires using Kafka's timer and deplayed operations.

xiaotongwang1 mentioned this pull request Aug 4, 2021

Pulsar 2.7.0+ KOP 2.7.2.x getPartitionedTopicMetadata timeout #11532

Closed

paladin-dalao mentioned this pull request Jan 13, 2022

cpp client coredump #13735

Closed

ZHr-UChiHa mentioned this pull request Jun 3, 2023

[Bug] python pulsar client create producer thread suspend because of deadlock apache/pulsar-client-python#129

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the cluster setup instructions. #21

Fix the cluster setup instructions. #21

radekg commented Sep 18, 2016

yahoocla commented Sep 18, 2016

yahoocla commented Sep 18, 2016

radekg Sep 18, 2016

merlimat Sep 19, 2016

radekg Sep 18, 2016

merlimat Sep 19, 2016

radekg Sep 18, 2016

merlimat Sep 19, 2016 •

edited

Loading

radekg Sep 19, 2016

merlimat Sep 19, 2016

radekg Sep 18, 2016 •

edited

Loading

radekg Sep 18, 2016 •

edited

Loading

merlimat Sep 19, 2016

radekg Sep 19, 2016

merlimat Sep 19, 2016

merlimat Sep 20, 2016

merlimat Sep 20, 2016

radekg Sep 20, 2016

radekg commented Sep 18, 2016

merlimat left a comment

merlimat Sep 19, 2016

merlimat Sep 19, 2016

merlimat Sep 19, 2016

radekg Sep 19, 2016

merlimat Sep 19, 2016 •

edited

Loading

merlimat Sep 19, 2016

merlimat left a comment

Fix the cluster setup instructions. #21

Fix the cluster setup instructions. #21

Conversation

radekg commented Sep 18, 2016

Motivation

Modifications

Result

yahoocla commented Sep 18, 2016

yahoocla commented Sep 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merlimat Sep 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

radekg Sep 18, 2016 • edited Loading

Choose a reason for hiding this comment

radekg Sep 18, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

radekg commented Sep 18, 2016

merlimat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merlimat Sep 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merlimat left a comment

Choose a reason for hiding this comment

merlimat Sep 19, 2016 •

edited

Loading

radekg Sep 18, 2016 •

edited

Loading

radekg Sep 18, 2016 •

edited

Loading

merlimat Sep 19, 2016 •

edited

Loading