Mercurial > p > roundup > code
comparison roundup/demo.py @ 7340:7b9bddda9d2d
Add support for demo mode in docker.
roundup/demo.py
Make changes to allow exposed port in docker to be specified
separately from the port that demo mode binds to. Also permit
bind address specification as well.
roundup/scripts/roundup_demo.py:
Update required by changes in demo.py. Also move away from
positional arguments to prefer flag arguments. Required for
passing port and host specification. Flake8 fixes.
share/man/man1/roundup-demo.1
Document use of option flags rather than positional
params. Other cleanups.
doc/installation.txt:
Document new docker modes: demo, shell and admin.
Update docs:
overview section - reorg, added template info
for the impatient section - added docker demo mode reference,
more docs on top level demo.py use.
new section on docker demo mode
removed getting roundup section. folded into installing roundup.
also prior for the impatient section describes how to download.
install via pip in venv recommended supported method
document all provided templates. not just minimal and classic.
added index references.
move sections around, decreased sectin depth, reformatting
scripts/Docker/roundup_healthcheck:
When running roundup-demo, there is no tracker spec. So default to
demo if no tracker=directory args found. Prevent's docker from
reporting an unhealthy container when running demo.
scripts/Docker/roundup_start:
implement demo, shell, admin docker modes.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 May 2023 09:43:53 -0400 |
| parents | 7147a4c833e9 |
| children | fb39200904a5 |
comparison
equal
deleted
inserted
replaced
| 7339:5eadba24e148 | 7340:7b9bddda9d2d |
|---|---|
| 21 | 21 |
| 22 # Path where demo instance files will be stored | 22 # Path where demo instance files will be stored |
| 23 TRACKER_HOME = os.path.abspath('demo') | 23 TRACKER_HOME = os.path.abspath('demo') |
| 24 | 24 |
| 25 | 25 |
| 26 def install_demo(home, backend, template): | 26 def install_demo(home, backend, template, use_port=None, use_host=None): |
| 27 """Install a demo tracker | 27 """Install a demo tracker |
| 28 | 28 |
| 29 Parameters: | 29 Parameters: |
| 30 home: | 30 home: |
| 31 tracker home directory path | 31 tracker home directory path |
| 89 nosyreaction += 'c' | 89 nosyreaction += 'c' |
| 90 if os.path.exists(nosyreaction): | 90 if os.path.exists(nosyreaction): |
| 91 os.remove(nosyreaction) | 91 os.remove(nosyreaction) |
| 92 | 92 |
| 93 # figure basic params for server | 93 # figure basic params for server |
| 94 hostname = 'localhost' | 94 hostname = use_host or 'localhost' |
| 95 # pick a fairly odd, random port | 95 # pick a fairly odd, random port |
| 96 port = 8917 | 96 port = use_port or 8917 |
| 97 while 1: | 97 while 1: |
| 98 print('Trying to set up web server on port %d ...' % port,) | 98 print('Trying to set up web server on port %d ...' % port,) |
| 99 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | 99 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 100 s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) | 100 s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
| 101 try: | 101 try: |
| 133 realname='Demo User', roles='User') | 133 realname='Demo User', roles='User') |
| 134 db.commit() | 134 db.commit() |
| 135 db.close() | 135 db.close() |
| 136 | 136 |
| 137 | 137 |
| 138 def run_demo(home): | 138 def run_demo(home, bind_addr=None, bind_port=None): |
| 139 """Run the demo tracker instance from its ``home`` directory""" | 139 """Run the demo tracker instance from its ``home`` directory |
| 140 | |
| 141 For running under docker, we need to split ports into | |
| 142 the port roundup-server binds to (usually 8080) and the | |
| 143 external mapping requested by docker to be used in external url's. | |
| 144 """ | |
| 145 | |
| 140 print("Demo Tracker Home:", home) | 146 print("Demo Tracker Home:", home) |
| 141 | 147 |
| 142 cfg = configuration.CoreConfig(home) | 148 cfg = configuration.CoreConfig(home) |
| 143 url = cfg["TRACKER_WEB"] | 149 url = cfg["TRACKER_WEB"] |
| 144 hostname, port = urlparse.urlparse(url)[1].split(':') | 150 try: |
| 145 port = int(port) | 151 hostname, port = urlparse.urlparse(url)[1].split(':') |
| 152 except ValueError: | |
| 153 print("\nThe TRACKER_WEB url:\n\n %(url)s\n\nin\n\n" | |
| 154 " %(home)s/config.ini" | |
| 155 "\n\nis missing a port number.\n" | |
| 156 "\nAre you using demo mode to start a production tracker? " | |
| 157 "Try running\ndemo mode with a different directory. " | |
| 158 "Use roundup-server to serve\nproduction trackers. " | |
| 159 "Exiting.\n" % {'home': home, 'url': url}) | |
| 160 exit(1) | |
| 161 | |
| 162 bind_addr = bind_addr or hostname | |
| 163 port = int(bind_port or port) | |
| 146 success_message = '''Server running - connect to: | 164 success_message = '''Server running - connect to: |
| 147 %(url)s | 165 %(url)s |
| 148 1. Log in as "demo"/"demo" or "admin"/"admin". | 166 1. Log in as "demo"/"demo" or "admin"/"admin". |
| 149 2. Hit Control-C to stop the server. | 167 2. Hit Control-C to stop the server. |
| 150 3. Re-start the server by running "%(script)s" again. | 168 3. Re-start the server by running "%(script)s" again. |
| 157 then restart demo. If you want to change backend types, you must use "nuke". | 175 then restart demo. If you want to change backend types, you must use "nuke". |
| 158 | 176 |
| 159 ''' % dict(url=url, script=sys.argv[0], datadir=TRACKER_HOME) | 177 ''' % dict(url=url, script=sys.argv[0], datadir=TRACKER_HOME) |
| 160 | 178 |
| 161 # disable command line processing in roundup_server | 179 # disable command line processing in roundup_server |
| 162 sys.argv = sys.argv[:1] + ['-p', str(port), '-n', hostname, 'demo=' + home] | 180 sys.argv = sys.argv[:1] + ['-p', str(port), '-n', bind_addr, 'demo=' + home] |
| 163 roundup_server.run(success_message=success_message) | 181 roundup_server.run(success_message=success_message) |
| 164 | 182 |
| 165 | 183 |
| 166 def usage(msg=''): | 184 def usage(msg=''): |
| 167 if msg: | 185 if msg: |