Skip to content
Snippets Groups Projects
  • John Chilton's avatar
    67543f37
    Documentation overhaul for pip installation as best practice. · 67543f37
    John Chilton authored
     - Add a new section to the docs for configuring Pulsar, remove this from README.
     - Replace full install information in README with a very short quickstart and link to new install section of docs.
     - Add app.yml.sample - document parameters there instead.
     - Remove non-web related configuration from server.ini.sample.
     - Replace description in job_managers.rst with app.yml based description.
     - Preserve older variant of job_managers documentation as docs/job_managers_old.rst.
     - Add script to automatically generate RST documentation from scripts.
     - Add auto-generated documentation for various pulsar scripts (pulsar-main, pulsar-check, pulsar-config).
     - Fill out detailed option help for pulsar-check, pulsar-main, and pulsar-config.
     - Add manually created documentation for the puslar script.
     - Update pulsar-config to only present options available on current platform (e.g. no supervisor on Windows)
     - Many more tests for pulsar-config, comment out unreachable code.
    
    Closes #68.
    Closes #67.
    Closes #23.
    67543f37
    History
    Documentation overhaul for pip installation as best practice.
    John Chilton authored
     - Add a new section to the docs for configuring Pulsar, remove this from README.
     - Replace full install information in README with a very short quickstart and link to new install section of docs.
     - Add app.yml.sample - document parameters there instead.
     - Remove non-web related configuration from server.ini.sample.
     - Replace description in job_managers.rst with app.yml based description.
     - Preserve older variant of job_managers documentation as docs/job_managers_old.rst.
     - Add script to automatically generate RST documentation from scripts.
     - Add auto-generated documentation for various pulsar scripts (pulsar-main, pulsar-check, pulsar-config).
     - Fill out detailed option help for pulsar-check, pulsar-main, and pulsar-config.
     - Add manually created documentation for the puslar script.
     - Update pulsar-config to only present options available on current platform (e.g. no supervisor on Windows)
     - Many more tests for pulsar-config, comment out unreachable code.
    
    Closes #68.
    Closes #67.
    Closes #23.
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
server.ini.sample 1.59 KiB
### server:main section used by paster web server. More advanced,
### Python3 compatible circus setup configured using sections after
### app:main (circus, watcher:web, socket:web).

[server:main]
use = egg:Paste#http
## To use chaussette w/paster deploy (no circus), use follwoing: 
# use = egg:chaussette#main

## The port on which to listen.
port = 8913
## The hostname or IP address of the server.
host = localhost

## pem file to use to enable SSL. Set to * to generate one
## automatically.
# ssl_pem = host.pem

[app:main]
paste.app_factory = pulsar.web.wsgi:app_factory

app_config=%(here)s/app.yml

## Configure uWSGI (if used).
[uwsgi]
master = True
paste-logger = True
socket = 127.0.0.1:3031
processes = 1
enable-threads = True


## Configure circus and chaussette (if used).
[circus]
endpoint = tcp://127.0.0.1:5555
pubsub_endpoint = tcp://127.0.0.1:5556
#stats_endpoint = tcp://127.0.0.1:5557                                                                                    

[watcher:web]
cmd = chaussette --fd $(circus.sockets.web) paste:server.ini
use_sockets = True
# Pulsar must be single-process for now...
numprocesses = 1


[socket:web]
host = localhost
port = 8913



## Configure Python loggers.
[loggers]
keys = root,pulsar

[handlers]
keys = console

[formatters]
keys = generic

[logger_root]
level = INFO
handlers = console

[logger_pulsar]
level = DEBUG
handlers = console
qualname = pulsar
propagate = 0

[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = DEBUG
formatter = generic

[formatter_generic]
format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s