This is an automated email from the ASF dual-hosted git repository.
guangning pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-manager.git
The following commit(s) were added to refs/heads/master by this push:
new 2ca8a39 Add frequently asked questions document (#308)
2ca8a39 is described below
commit 2ca8a39efc2ad24ea8b1cb1f317bb84413be2019
Author: Guangning <guangn...@apache.org>
AuthorDate: Wed Dec 23 19:42:26 2020 +0800
Add frequently asked questions document (#308)
* There are some problems that users often encounter, so add a faq document
---
docs/faq.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 102 insertions(+)
diff --git a/docs/faq.md b/docs/faq.md
new file mode 100644
index 0000000..a73319f
--- /dev/null
+++ b/docs/faq.md
@@ -0,0 +1,102 @@
+## FAQ
+
+* Question: "I cannot do any operation on Pulsar" or "Pulsar Manager does not
show the `standalone cluster` option when adding to a tenant?
+```
+java.lang.NullPointerException: null
+ at
org.apache.pulsar.manager.service.impl.BrokersServiceImpl.getBrokersList(BrokersServiceImpl.java:54)
~[pulsar-manager.jar:na]
+ at
org.apache.pulsar.manager.service.impl.ClustersServiceImpl.getClustersList(ClustersServiceImpl.java:70)
~[pulsar-manager.jar:na]
+ at
org.apache.pulsar.manager.service.impl.BrokerStatsServiceImpl.scheduleCollectStats(BrokerStatsServiceImpl.java:129)
~[pulsar-manager.jar:na]
+ at sun.reflect.GeneratedMethodAccessor118.invoke(Unknown Source)
~[na:na]
+ at
sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
~[na:1.8.0_212]
+ at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_212]
+ at
org.springframework.scheduling.support.ScheduledMethodRunnable.run(ScheduledMethodRunnable.java:65)
~[spring-context-5.0.6.RELEASE.jar:5.0.6.RELEASE]
+ at
org.springframework.scheduling.support.DelegatingErrorHandlingRunnable.run(DelegatingErrorHandlingRunnable.java:54)
~[spring-context-5.0.6.RELEASE.jar:5.0.6.RELEASE]
+ at
java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
[na:1.8.0_212]
+ at java.util.concurrent.FutureTask.runAndReset(FutureTask.java:308)
[na:1.8.0_212]
+ at
java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$301(ScheduledThreadPoolExecutor.java:180)
[na:1.8.0_212]
+ at
java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:294)
[na:1.8.0_212]
+ at
java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
[na:1.8.0_212]
+ at
java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
[na:1.8.0_212]
+ at java.lang.Thread.run(Thread.java:748) [na:1.8.0_212]
+```
+
+* Reason: The webservice URL configured by the Pulsar cluster when
initializing metadata is inconsistent with the actual webservice URL.
+
+* Solution: check the status and information of the cluster.
+```
+./bin/pulsar-admin clusters list
+./bin/pulsar-admin clusters get cluster-name (eg, standalone)
+```
+
+The following results are correct:
+```
+./bin/pulsar-admin clusters get standalone
+{
+ "serviceUrl" : "http://127.0.0.1:8080";,
+ "brokerServiceUrl" : "pulsar://127.0.0.1:6650"
+}
+```
+Your network should be connected to serviceUrl's network.
+
+If these two domain names are set incorrectly, use the `./bin/pulsar-admin
clusters update` command to update them.
+```
+./bin/pulsar-admin clusters update --broker-url http://broker-ip:6605 --url
http://broker-ip:8080 cluster-name (eg, standalone)
+```
+* Releated issue: https://github.com/apache/pulsar-manager/issues/292
+
+
+* Question: Pulsar Manager keeps saying "This environment is error. Please
check it"
+
+* Reason: Your Pulsar Manager service cannot connect with your Pulsar cluster
network.
+
+
+* Solution: _pulsar_ and _pulsar-manger_ runs in different containers with
their own localhosts (each container just knows its own `localhost`).
+You should either run these two containers in one network using tools like
Docker composer or set `--network host` as below.
+```bash
+docker run --rm --network host -it -e REDIRECT_HOST=http://localhost -e
REDIRECT_PORT=9527 -e DRIVER_CLASS_NAME=org.postgresql.Driver -e
URL='jdbc:postgresql://127.0.0.1:5432/pulsar_manager' -e USERNAME=pulsar -e
PASSWORD=pulsar -e LOG_LEVEL=DEBUG -v $PWD:/data
apachepulsar/pulsar-manager:v0.1.0 /bin/sh
+```
+
+* Releated issue: https://github.com/apache/pulsar-manager/issues/292
https://github.com/apache/pulsar-manager/issues/214
+
+
+## Troubleshooting steps for Pulsar Manager
+
+1. Check whether the Pulsar cluster runs well.
+
+```
+curl -v http://webservice-url:port/metrics/
+
+For example:
+curl -v http://localhost:8080/metrics/
+```
+
+2. Check the cluster configuration.
+
+```
+./bin/pulsar-admin clusters list
+./bin/pulsar-admin clusters get cluster-name (eg, standalone)
+```
+
+The following results are correct:
+```
+./bin/pulsar-admin clusters get standalone
+{
+ "serviceUrl" : "http://127.0.0.1:8080";,
+ "brokerServiceUrl" : "pulsar://127.0.0.1:6650"
+}
+```
+Your network should be connected to serviceUrl's network. If these two domain
names are set incorrectly, please use the `./bin/pulsar-admin clusters update`
command to update them to be correct.
+
+```
+./bin/pulsar-admin clusters update --broker-url http://broker-ip:6605 --url
http://broker-ip:8080 cluster-name (eg, standalone)
+
+3. Check the log of Pulsar Manager
+
+```
+docker logs -f pulsar-manager-container-name
+```
+
+```
+docker exec -it /bin/sh pulsar-mananger-container-name /bin/sh
+tail -f /pulsar-manager/puslar-manager.log
+```
\ No newline at end of file
