zuul
/
zuul
Code Issues Proposed changes

Docs: reformat web section 

Change-Id: I2c1bc1c0477f89a017e28d000bf688cce710b1a1
This commit is contained in:
James E. Blair 2017-08-03 15:11:47 -07:00
parent 9d0b4cc482
commit afe27e6959
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/source/admin/components.rst
View File

@ -438,9 +438,9 @@ stop``.
To request that the executor stop executing new jobs and exit when all To request that the executor stop executing new jobs and exit when all
currently running jobs have completed, run ``zuul-executor graceful``. currently running jobs have completed, run ``zuul-executor graceful``.
To enable or disable running Ansible in verbose mode (with the '-vvv' To enable or disable running Ansible in verbose mode (with the
argument to ansible-playbook) run ``zuul-executor verbose`` and ``-vvv`` argument to ansible-playbook) run ``zuul-executor verbose``
``zuul-executor unverbose``. and ``zuul-executor unverbose``.
Web Server Web Server
---------- ----------
@ -452,35 +452,34 @@ HTTP interactions with Zuul.
Configuration Configuration
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
In addition to the ``gearman`` common configuration section, the following In addition to the common configuration sections, the following
sections of **zuul.conf** are used by the web server: sections of ``zuul.conf`` are used by the web server:
web .. attr:: web
"""
**listen_address** .. attr:: listen_address
IP address or domain name on which to listen (default: 127.0.0.1):: :default: 127.0.0.1
listen_address=127.0.0.1 IP address or domain name on which to listen.
**log_config** .. attr:: log_config
Path to log config file for the web server process::
log_config=/etc/zuul/logging.yaml Path to log config file for the web server process.
**pidfile** .. attr:: pidfile
Path to PID lock file for the web server process:: :default: /var/run/zuul-web/zuul-web.pid
pidfile=/var/run/zuul-web/zuul-web.pid Path to PID lock file for the web server process.
**port** .. attr:: port
Port to use for web server process:: :default: 9000
port=9000 Port to use for web server process.
**websocket_url** .. attr:: websocket_url
Base URL on which the websocket service is exposed, if different than the
base URL of the web app. Base URL on which the websocket service is exposed, if different
than the base URL of the web app.
Operation Operation
~~~~~~~~~ ~~~~~~~~~