Skip to content

Commit 1464204

Browse files
authored
updated NO_PROXY list and accounting for worker service (#793)
updated `NO_PROXY` ENV service list and added `worker` to list of services that might require `HTTP_PROXY` configuration
1 parent 78f587d commit 1464204

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/admin/config/private-network.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ A **private network** refers to a secure network environment segregated from the
44
When deploying self-hosted Sourcegraph instances in private networks with specific compliance and policy requirements, additional configuration may be required to ensure all networking features function correctly. The reasons for applying the following configuration options depend on the specific functionality of the Sourcegraph service and the unique network and infrastructure requirements of the organization.
55

66
The following is a list of Sourcegraph services and how and when each initiates outbound connections to external services:
7+
- **executor**: Sourcegraph [Executor](../executors) batch change or precise indexing jobs may need to connect to services hosted within an organization's private network
78
- **frontend**: The frontend service communicates externally when connecting to external [auth providers](../auth), sending [telemetry data](../pings), testing code host connections, and connecting to [externally hosted](../external_services) Sourcegraph services
89
- **gitserver**: Executes git commands against externally hosted [code hosts](../external_service)
9-
- **repo-updater**: Communicates with [code hosts](../external_service) APIs to coordinate repository synchronization
1010
- **migrator**: Connects to Postgres instances (which may be [externally hosted](../external_services/postgres)) to process database migrations
11-
- **executor**: Sourcegraph [Executor](../executors) batch change or precise indexing jobs may need to connect to services hosted within an organization's private network
11+
- **repo-updater**: Communicates with [code hosts](../external_service) APIs to coordinate repository synchronization
12+
- **worker**: Sourcegraph [Worker](../workers) run various background jobs that may require establishing connections to services hosted within an organization's private network
1213

1314
## HTTP proxy configuration
1415
All Sourcegraph services respect the conventional `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables for routing Sourcegraph client application HTTP traffic through a proxy server. The steps for configuring proxy environment variables will depend on your Sourcegraph deployment method.
@@ -17,14 +18,14 @@ All Sourcegraph services respect the conventional `HTTP_PROXY`, `HTTPS_PROXY`, a
1718
Add the proxy environment variables to your Sourcegraph Helm chart [override file](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/values.yaml):
1819

1920
```yaml
20-
frontend|gitserver|repo-updater:
21+
executor|frontend|gitserver|migrator|repo-updater|worker:
2122
env:
2223
- name: HTTP_PROXY
2324
value: http://proxy.example.com:8080
2425
- name: HTTPS_PROXY
2526
value: http://proxy.example.com:8080
2627
- name: NO_PROXY
27-
value: "*.cluster.local,blobstore,codeinsights-db,codeintel-db,sourcegraph-frontend-internal,sourcegraph-frontend,github-proxy,gitserver,grafana,indexed-search-indexer,indexed-search,jaeger-query,pgsql,precise-code-intel-worker,prometheus,redis-cache,redis-store,repo-updater,searcher,symbols,syntect-server,worker-executors,worker"
28+
value: "blobstore,codeinsights-db,codeintel-db,sourcegraph-frontend-internal,sourcegraph-frontend,github-proxy,gitserver,grafana,indexed-search-indexer,indexed-search,jaeger-query,pgsql,precise-code-intel-worker,prometheus,redis-cache,redis-store,repo-updater,searcher,symbols,syntect-server,worker-executors,worker,cloud-sql-proxy,localhost,127.0.0.1,.svc,.svc.cluster.local,kubernetes.default.svc"
2829
```
2930
3031
<Callout type="warning">Failure to configure `NO_PROXY` correctly can cause the proxy configuration to interfere with local networking between internal Sourcegraph services.</Callout>

0 commit comments

Comments
 (0)