Skip to content

Document the Docker environment variables the applications read (#3387) #3420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamtheturtle merged 5 commits into from
Aug 12, 2026
Merged

Document the Docker environment variables the applications read (#3387) #3420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f63985
Document the Docker environment variables the applications read (#3387)
adamtheturtle Aug 12, 2026
9bf1efb
Drop the documentation-scraping tests
adamtheturtle Aug 12, 2026
b041b29
Generate the Docker configuration documentation from the settings
adamtheturtle Aug 12, 2026
98e0af5
Merge branch 'main' into adamtheturtle/pick-next-open-issue-v2
adamtheturtle Aug 12, 2026
c807605
Revert "Generate the Docker configuration documentation from the sett…
adamtheturtle Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 28 additions & 8 deletions docs/source/docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ One container mocks the VWS services, one container mocks the VWQ services and o

Each of these containers run their services on port 5000.

The VWS and VWQ containers must point to the target manager container using the :envvar:`TARGET_MANAGER_BACKEND` variable.
The VWS and VWQ containers must point to the target manager container using the :envvar:`TARGET_MANAGER_BASE_URL` variable.

.. _creating-containers:

Expand All @@ -32,13 +32,13 @@ Creating containers
$ docker run \
--detach \
--publish 5006:5000 \
-e TARGET_MANAGER_BACKEND=vuforia-target-manager-mock:5000 \
-e TARGET_MANAGER_BASE_URL=http://vuforia-target-manager-mock:5000 \
--network vws-bridge-network \
ghcr.io/vws-python/vuforia-vws-mock
$ docker run \
--detach \
--publish 5007:5000 \
-e TARGET_MANAGER_BACKEND=vuforia-target-manager-mock:5000 \
-e TARGET_MANAGER_BASE_URL=http://vuforia-target-manager-mock:5000 \
--network vws-bridge-network \
ghcr.io/vws-python/vuforia-vwq-mock

Expand All @@ -65,13 +65,23 @@ For example, with the containers set up as in :ref:`creating-containers`, use ``
--data '{}' \
'127.0.0.1:5005/cloud_databases'
{
"client_access_key": "2d61c1d17bb94694bee77c1f1f41e5d9",
"client_secret_key": "b73f8170cf7d42728fa8ce66221ad147",
"database_id": "ca6e48ed25a340d998905ac59747a1f8",
"database_name": "e515df24ba944f43b8f7969bc98af107",
"server_access_key": "cb1759871a504875ab5f96d6db5ff79b",
"server_secret_key": "9b8533d912ad4aa79cb61b6ee197ece2",
"client_access_key": "2d61c1d17bb94694bee77c1f1f41e5d9",
"client_secret_key": "b73f8170cf7d42728fa8ce66221ad147",
"state_name": "WORKING",
"targets": []
"database_type_name": "CLOUD_RECO",
"targets": [],
"request_quota": 100000,
"reco_threshold": 1000,
"current_month_recos": 0,
"previous_month_recos": 0,
"total_recos": 0,
"target_quota": 1000,
"requests_per_second_limit": null,
"request_rate_limits": null
}

Deleting a database
Expand All @@ -92,14 +102,24 @@ Configuration options
Required configuration
^^^^^^^^^^^^^^^^^^^^^^

.. envvar:: TARGET_MANAGER_BACKEND
.. envvar:: TARGET_MANAGER_BASE_URL

This is required by the VWS mock and the VWQ mock containers.
This is the route to the target manager container from the other containers.
This is the base URL of the target manager container as seen from the other containers.
It must include a scheme, for example ``http://vuforia-target-manager-mock:5000``.

Optional configuration
^^^^^^^^^^^^^^^^^^^^^^

VWS and Query containers
~~~~~~~~~~~~~~~~~~~~~~~~

.. envvar:: RESPONSE_DELAY_SECONDS

The number of seconds to wait before sending each response.

Default: ``0.0``

Target manager container
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions newsfragments/docker-documentation-target-manager-base-url.change
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document the Docker containers' configuration with the environment variable names and values which the applications actually read, starting with ``TARGET_MANAGER_BASE_URL``.