Skip to content

Commit cd3ef85

Browse files
smarnachwillkg
authored andcommitted
Update documentation with new names of the run_service_*.sh scripts.
1 parent 7dc536e commit cd3ef85

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

docs/configuration.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Gunicorn configuration:
2929

3030
https://docs.gunicorn.org/en/stable/settings.html#timeout
3131

32-
Used in `bin/run_webapp.sh
33-
<https://github.com/mozilla-services/socorro/blob/main/bin/run_webapp.sh>`_.
32+
Used in `bin/run_service_webapp.sh
33+
<https://github.com/mozilla-services/socorro/blob/main/bin/run_service_webapp.sh>`_.
3434

3535

3636
.. everett:option:: GUNICORN_WORKERS
@@ -44,8 +44,8 @@ Gunicorn configuration:
4444

4545
http://docs.gunicorn.org/en/stable/design.html#how-many-workers
4646

47-
Used in `bin/run_webapp.sh
48-
<https://github.com/mozilla-services/socorro/blob/main/bin/run_webapp.sh>`_.
47+
Used in `bin/run_service_webapp.sh
48+
<https://github.com/mozilla-services/socorro/blob/main/bin/run_service_webapp.sh>`_.
4949

5050

5151
.. everett:option:: GUNICORN_WORKER_CLASS
@@ -55,8 +55,8 @@ Gunicorn configuration:
5555

5656
https://docs.gunicorn.org/en/stable/settings.html#workers
5757

58-
Used in `bin/run_webapp.sh
59-
<https://github.com/mozilla-services/socorro/blob/main/bin/run_webapp.sh>`_.
58+
Used in `bin/run_service_webapp.sh
59+
<https://github.com/mozilla-services/socorro/blob/main/bin/run_service_webapp.sh>`_.
6060

6161

6262
.. everett:option:: GUNICORN_MAX_REQUESTS
@@ -66,8 +66,8 @@ Gunicorn configuration:
6666

6767
https://docs.gunicorn.org/en/stable/settings.html#workers
6868

69-
Used in `bin/run_webapp.sh
70-
<https://github.com/mozilla-services/socorro/blob/main/bin/run_webapp.sh>`_.
69+
Used in `bin/run_service_webapp.sh
70+
<https://github.com/mozilla-services/socorro/blob/main/bin/run_service_webapp.sh>`_.
7171

7272

7373
.. everett:option:: GUNICORN_MAX_REQUESTS_JITTER
@@ -78,8 +78,8 @@ Gunicorn configuration:
7878

7979
https://docs.gunicorn.org/en/stable/settings.html#workers
8080

81-
Used in `bin/run_webapp.sh
82-
<https://github.com/mozilla-services/socorro/blob/main/bin/run_webapp.sh>`_.
81+
Used in `bin/run_service_webapp.sh
82+
<https://github.com/mozilla-services/socorro/blob/main/bin/run_service_webapp.sh>`_.
8383

8484

8585
Webapp configuration:

docs/service/cron.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Job configuration is in ``webapp/crashstats/cron/__init__.py``.
1111

1212
Code is in ``webapp/crashstats/cron/``.
1313

14-
Run script is ``/app/bin/run_crontabber.sh``. This is an infinite loop that
15-
runs the ``manage.py cronrun`` command every 5 minutes.
14+
Run script is ``/app/bin/run_service_crontabber.sh``. This is an infinite loop
15+
that runs the ``manage.py cronrun`` command every 5 minutes.
1616

1717

1818
manage.py cronrun

docs/service/processor.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ To run the processor in the local dev environment, do::
4747
$ docker compose up processor
4848

4949
That will bring up all the services the processor requires to run and start the
50-
processor using the ``/app/bin/run_processor.sh`` script and the processor
51-
configuration.
50+
processor using the ``/app/bin/run_service_processor.sh`` script and the
51+
processor configuration.
5252

5353
To use tools and also ease debugging in the container, you can run a shell::
5454

@@ -69,4 +69,4 @@ Run the docker image using the ``processor`` command. Something like this::
6969
--volume /data:/data \
7070
mozilla/socorro_app processor
7171

72-
This runs the ``/app/bin/run_processor.sh`` script.
72+
This runs the ``/app/bin/run_service_processor.sh`` script.

docs/service/webapp.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Crash Stats Webapp
66

77
Code is in ``webapp/``.
88

9-
Run script is ``/app/bin/run_webapp.sh``.
9+
Run script is ``/app/bin/run_service_webapp.sh``.
1010

1111

1212
Configuration
@@ -144,7 +144,7 @@ Then compile the static assets::
144144

145145
Now run the webapp with ``gunicorn`` and ``DEBUG=False``::
146146

147-
app@socorro:/app$ DEBUG=False bash bin/run_webapp.sh
147+
app@socorro:/app$ DEBUG=False bash bin/run_service_webapp.sh
148148

149149
You will now be able to open ``http://localhost:8000`` on the host and if you
150150
view the source you see that the minified and concatenated static assets are

socorro/processor/cache_manager.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
To run::
1919
20-
$ /app/bin/run_processor_cache_manager.sh
20+
$ /app/bin/run_cache_manager.sh
2121
2222
"""
2323

0 commit comments

Comments
 (0)