apache / apache/pulsar

[feat][doc] add instructions of environment variables in pulsar_env.sh

Open
#19,589 1 comment 0 reactions 0 assignees View on GitHub
doc-required Stale
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

### Search before asking

- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.

### What issue do you find in Pulsar docs?

@asafm
While trying to setup docker compose to run on my mac, it fails on OOM.
I tried searching for a listing of environment variables, so I can configure the memory for the JVM but couldn’t find one.
@hangc0276 helped to understand its PULSAR_MEM . I searched for it and couldn’t find it using Search bar.
I think we should have environment variables listed under Administration.

@Anonymitaet
Do we need to add explanations for all the environment variables in [pulsar_env.sh](https://github.com/apache/pulsar/blob/master/conf/pulsar_env.sh#L21) to docs?
![image](https://user-images.githubusercontent.com/50226895/220508188-2a4405e7-6303-474b-8971-2709b8767e5e.png)

Asaf Mesika
IMO all besides JAVA_HOME. We don’t have time even just the memory one will be great.

### What is your suggestion?

Add instructions of environment variables in pulsar_env.sh

### Any reference?

_No response_

### Are you willing to submit a PR?

- [ ] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start with conf/pulsar_env.sh, especially the environment variables around line 21, and review the Administration documentation. Document PULSAR_MEM and determine whether the remaining variables should also be covered; the work is done when users can find clear configuration instructions through the documentation search.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.