Skip to content

Commit aff2f97

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

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/advanced/settings.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,12 @@ 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+
You must configure HTTP proxy settings when deploying a Harvester cluster in an [air-gapped]((../airgap.md)) environment. If you want to import an air-gapped Harvester cluster into a Rancher deployed in the external environment, you must configure additional HTTP proxy settings in Rancher before starting the import.
195+
194196
:::caution
195197

196-
Changing this setting might cause single-node clusters to temporarily become unavailable or inaccessible.
198+
- Changing this setting might cause single-node clusters to temporarily become unavailable or inaccessible.
199+
- Proxies can rewrite or remove critical headers such as `Host` or `Cache-Control`, which in turn can break API requests and the caching mechanism. Long-running operations such as backup restoration and downloading of large virtual images can also fail due to proxy-imposed timeouts on idle connections. Ensure that necessary authentication headers are preserved, exempt internal addresses using the `noProxy` option, and adjust proxy timeout settings for lengthy control-plane tasks.
197200

198201
:::
199202

@@ -584,6 +587,10 @@ The value is a JSON object literal that contains the following key-value pairs:
584587
- `repository`: Name of the repository that stores the support bundle image.
585588
- `tag`: Tag assigned to the support bundle image.
586589
- `imagePullPolicy`: Pull policy of the support bundle image. The supported values are `IfNotPresent`, `Always`, and `Never`. For more information, see [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) in the Kubernetes documentation.
590+
- The configured `httpProxy`, `httpsProxy`, and `noProxy` values are automatically injected into node-level processes, including Kubernetes components, the container runtime that pulls the operating system and virtual machine image containers, and other operating system utilities.
591+
- The HTTP proxy settings are recognized by all control plane components, including the image downloader that fetches external virtual machine images, the backup-restore controller that communicates with S3 targets, the upgrade checker that polls Rancher’s release server, and the embedded Rancher agent. This behavior results in the following:
592+
- Outbound requests to public endpoints are routed through the configured proxy.
593+
- Traffic to internal VIPs, service domains, and CIDR ranges bypasses the configured proxy.
587594

588595
**Notes**:
589596

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+
## Connect an Air-Gapped Harvester Cluster to Rancher
26+
27+
HTTP proxy settings must be configured based on where Rancher is deployed.
28+
29+
- Rancher in the external environment: To allow Rancher to access the Harvester API endpoint, configure the proxy within Rancher using the following:
30+
- Operating system environment variables
31+
- `http-proxy` setting: Use the `httpProxy`, `httpsProxy`, and `noProxy` options. Ensure that the `noProxy` 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. Check more details in [settings](./advanced/settings.md#http-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)