Skip to content

Commit 67f79a2

Browse files
committed
Improve http-proxy docs
Signed-off-by: Vatsal Parekh <[email protected]>
1 parent 1e05d31 commit 67f79a2

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/advanced/settings.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,19 @@ Harvester sends a graceful shutdown signal to any VM that is stopped using the H
191191

192192
**Definition**: HTTP proxy used to access external services, including downloading of images and backup to S3 services.
193193

194+
When `httpProxy`, `httpsProxy`, and `noProxy` are configured, either during ISO-based installation or later on the host, these variables are automatically injected into every node-level process, including the kubernetes components, the container runtime that pulls Harvester’s system and VM-image containers, and other operating-system utilities.
195+
196+
All control-plane components, such as the image-downloader fetching external VM images, the backup-restore controller communicating with S3 targets, the upgrade-checker polling Rancher’s release server, and the embedded Rancher agent, honor these proxy settings. As a result, outbound requests to public endpoints are routed through the configured proxy, while traffic to internal VIPs, service domains, and CIDR ranges bypasses it.
197+
198+
Proxy settings are also useful for [Airgap environment](../airgap.md) setup.
199+
194200
:::caution
195201

196202
Changing this setting might cause single-node clusters to temporarily become unavailable or inaccessible.
197203

204+
Proxies can rewrite or remove critical headers like `Host` or `Cache-Control`, breaking API requests or caching mechanism. Long-running operations such as large VM image downloads or backup restores can fail due to proxy-imposed timeouts on idle connections.
205+
Ensure preservation of necessary authentication headers, exempt internal addresses via `noProxy` and adjust proxy timeout settings for lengthy control-plane tasks.
206+
198207
:::
199208

200209
**Default value**: `{}`

docs/airgap.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ The Harvester ISO image contains all the packages to make it work in an air gapp
2222

2323
In some environments, the connection to external services, from the servers or VMs, requires an HTTP(S) proxy.
2424

25+
## Connecting to Rancher in airgap environment
26+
27+
In an air-gapped network, HTTP(S) proxy settings must be configured so that Harvester and Rancher can still communicate. There are two common deployment topologies:
28+
29+
- Rancher inside the same isolated network: Configure the proxy on the Harvester side through OS environment variables and Harvester’s http-proxy, https-proxy and no-proxy settings so that rancher-agent pods on each Harvester node can reach the Rancher server endpoint. Make sure the no-proxy list includes the Harvester cluster VIP or API server IP, Harvester service domains such as harvester-system.svc.cluster.local, and any relevant CIDR ranges.
30+
31+
- Rancher outside the isolated network: Configure the proxy on the Rancher side using environment variables for the Rancher container or its Kubernetes deployment so Rancher can connect back to the Harvester API endpoint. Ensure the no-proxy list covers the Harvester VIP, service domains and internal CIDR ranges so internal traffic bypasses the proxy.
32+
2533
### Configure an HTTP Proxy During Installation
2634

2735
You can configure the HTTP(S) proxy during the [ISO installation](./install/iso-install.md) as shown in picture below:

0 commit comments

Comments
 (0)