Monty Taylor
51139a0682
zuul now provides socket-based console streaming, which is super cool. In order to have jenkins parity with web streaming, we need to provide a websocket (javascript in browsers can't really connect to random ports on servers) After surveying the existing python websocket options, basically all of them are based around twisted, eventlet, gevent or asyncio. It's not just a thing we can easily deal with from our current webob/paste structure, because it is a change to the fundamental HTTP handling. While we could write our own websocket server implementation that was threaded like the rest of zuul, that's a pretty giant amount of work. Instead, we can run an async-based server that's just for the websockets, so that we're not all of a sudden putting async code into the rest of zuul and winding up frankensteined. Since this is new code, using asyncio and python3 seems like an excellent starting place. aiohttp supports running a websocket server in a thread. It also supports doing other HTTP/REST calls, so by going aiohttp we can set ourselves up for a single answer for the HTTP tier. In order to keep us from being an open socket relay, we'll expect two parameters as the first message on the websocket - what's the zuul build uuid, and what log file do we want to stream. (the second thing, multiple log files, isn't supported yet by the rest of zuul, but one can imagine a future where we'd like to support that too, so it's in the protocol) The websocket server will then ask zuul over gearman for the IP and port associated with the build and logfile and will start streaming it to the socket. Ultimately we'll want the status page to make links of the form: /console.html?uuid=<uuid>&logfile=console.log and we'll want to have apache map the websocket server to something like /console. Co-Authored-By: Monty Taylor <mordred@inaugust.com> Change-Id: Idd0d3f9259e81fa9a60d7540664ce8d5ad2c298f
116 lines
3.8 KiB
Python
Executable File
116 lines
3.8 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# Copyright 2017 Red Hat, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import argparse
|
|
import asyncio
|
|
import daemon
|
|
import extras
|
|
import logging
|
|
import signal
|
|
import sys
|
|
import threading
|
|
|
|
import zuul.cmd
|
|
import zuul.web
|
|
|
|
from zuul.lib.config import get_default
|
|
|
|
# as of python-daemon 1.6 it doesn't bundle pidlockfile anymore
|
|
# instead it depends on lockfile-0.9.1 which uses pidfile.
|
|
pid_file_module = extras.try_imports(['daemon.pidlockfile', 'daemon.pidfile'])
|
|
|
|
|
|
class WebServer(zuul.cmd.ZuulApp):
|
|
|
|
def parse_arguments(self):
|
|
parser = argparse.ArgumentParser(description='Zuul Web Server.')
|
|
parser.add_argument('-c', dest='config',
|
|
help='specify the config file')
|
|
parser.add_argument('-d', dest='nodaemon', action='store_true',
|
|
help='do not run as a daemon')
|
|
parser.add_argument('--version', dest='version', action='version',
|
|
version=self._get_version(),
|
|
help='show zuul version')
|
|
self.args = parser.parse_args()
|
|
|
|
def exit_handler(self, signum, frame):
|
|
self.web.stop()
|
|
|
|
def _main(self):
|
|
params = dict()
|
|
|
|
params['listen_address'] = get_default(self.config,
|
|
'web', 'listen_address',
|
|
'127.0.0.1')
|
|
params['listen_port'] = get_default(self.config, 'web', 'port', 9000)
|
|
params['gear_server'] = get_default(self.config, 'gearman', 'server')
|
|
params['gear_port'] = get_default(self.config, 'gearman', 'port', 4730)
|
|
params['ssl_key'] = get_default(self.config, 'gearman', 'ssl_key')
|
|
params['ssl_cert'] = get_default(self.config, 'gearman', 'ssl_cert')
|
|
params['ssl_ca'] = get_default(self.config, 'gearman', 'ssl_ca')
|
|
|
|
try:
|
|
self.web = zuul.web.ZuulWeb(**params)
|
|
except Exception as e:
|
|
self.log.exception("Error creating ZuulWeb:")
|
|
sys.exit(1)
|
|
|
|
loop = asyncio.get_event_loop()
|
|
signal.signal(signal.SIGUSR1, self.exit_handler)
|
|
signal.signal(signal.SIGTERM, self.exit_handler)
|
|
|
|
self.log.info('Zuul Web Server starting')
|
|
self.thread = threading.Thread(target=self.web.run,
|
|
args=(loop,),
|
|
name='web')
|
|
self.thread.start()
|
|
|
|
try:
|
|
signal.pause()
|
|
except KeyboardInterrupt:
|
|
print("Ctrl + C: asking web server to exit nicely...\n")
|
|
self.exit_handler(signal.SIGINT, None)
|
|
|
|
self.thread.join()
|
|
loop.stop()
|
|
loop.close()
|
|
self.log.info("Zuul Web Server stopped")
|
|
|
|
def main(self):
|
|
self.setup_logging('web', 'log_config')
|
|
self.log = logging.getLogger("zuul.WebServer")
|
|
|
|
try:
|
|
self._main()
|
|
except Exception:
|
|
self.log.exception("Exception from WebServer:")
|
|
|
|
|
|
def main():
|
|
server = WebServer()
|
|
server.parse_arguments()
|
|
server.read_config()
|
|
|
|
pid_fn = get_default(server.config, 'web', 'pidfile',
|
|
'/var/run/zuul-web/zuul-web.pid', expand_user=True)
|
|
|
|
pid = pid_file_module.TimeoutPIDLockFile(pid_fn, 10)
|
|
|
|
if server.args.nodaemon:
|
|
server.main()
|
|
else:
|
|
with daemon.DaemonContext(pidfile=pid):
|
|
server.main()
|