Skip to content
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.

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

Update private-locations.rst for validating no_proxy settings #1545

Merged
merged 4 commits into from
Sep 23, 2024
Merged
Changes from all commits
Commits
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
23 changes: 22 additions & 1 deletion synthetics/test-config/private-locations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,28 @@ NO_PROXY is configured to bypass the proxy for local addresses and specific doma

Ensure that these variables are correctly configured to comply with your network policies. This setup allows the synthetic tests to communicate securely and efficiently in a controlled network environment.


When using runner, it's important to correctly configure the proxy settings to avoid issues with browser-based tests. The following steps should be followed when setting up their environment:

1. :strong:`Ensure Proper NO_PROXY Setup`:

- When configuring ``NO_PROXY`` always include the following addresses:

- ``127.0.0.1`` (for localhost communication)
- ``localhost`` (for resolving local tests)

These addresses ensure that internal services and tests run correctly without routing through a proxy, preventing potential failures.

2. :strong:`Merging HTTP_PROXY and http_proxy`:

- The system automatically handles both ``HTTP_PROXY`` and ``http_proxy`` environment variables. If you define one of these, ensure the other is also set, or they will be automatically merged at start-up.

3. :strong:`Dockerfile defaults`:

- By default, the runner will set the ``NO_PROXY`` variable in the Dockerfile to include ``127.0.0.1``. If you override ``NO_PROXY``, you must ensure that ``127.0.0.1`` and ``localhost`` are still present, or browser tests may fail.

4. :strong:`Startup Check`:

- The runner includes a startup check to validate that ``NO_PROXY`` contains ``127.0.0.1`` and ``localhost``. If these are missing, you might encounter unexpected behavior in test execution.



Expand Down
Loading