Skip to content

Commit

Permalink
Update documentation with new names of the run_service_*.sh scripts.
Browse files Browse the repository at this point in the history
  • Loading branch information
smarnach authored and willkg committed May 16, 2024
1 parent 7dc536e commit cd3ef85
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
20 changes: 10 additions & 10 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Gunicorn configuration:

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

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


.. everett:option:: GUNICORN_WORKERS
Expand All @@ -44,8 +44,8 @@ Gunicorn configuration:

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

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


.. everett:option:: GUNICORN_WORKER_CLASS
Expand All @@ -55,8 +55,8 @@ Gunicorn configuration:

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

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


.. everett:option:: GUNICORN_MAX_REQUESTS
Expand All @@ -66,8 +66,8 @@ Gunicorn configuration:

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

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


.. everett:option:: GUNICORN_MAX_REQUESTS_JITTER
Expand All @@ -78,8 +78,8 @@ Gunicorn configuration:

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

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


Webapp configuration:
Expand Down
4 changes: 2 additions & 2 deletions docs/service/cron.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Job configuration is in ``webapp/crashstats/cron/__init__.py``.

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

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


manage.py cronrun
Expand Down
6 changes: 3 additions & 3 deletions docs/service/processor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ To run the processor in the local dev environment, do::
$ docker compose up processor

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

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

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

This runs the ``/app/bin/run_processor.sh`` script.
This runs the ``/app/bin/run_service_processor.sh`` script.
4 changes: 2 additions & 2 deletions docs/service/webapp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Crash Stats Webapp

Code is in ``webapp/``.

Run script is ``/app/bin/run_webapp.sh``.
Run script is ``/app/bin/run_service_webapp.sh``.


Configuration
Expand Down Expand Up @@ -144,7 +144,7 @@ Then compile the static assets::

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

app@socorro:/app$ DEBUG=False bash bin/run_webapp.sh
app@socorro:/app$ DEBUG=False bash bin/run_service_webapp.sh

You will now be able to open ``http://localhost:8000`` on the host and if you
view the source you see that the minified and concatenated static assets are
Expand Down
2 changes: 1 addition & 1 deletion socorro/processor/cache_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
To run::
$ /app/bin/run_processor_cache_manager.sh
$ /app/bin/run_cache_manager.sh
"""

Expand Down

0 comments on commit cd3ef85

Please sign in to comment.