Skip to content

Commit 1923eef

Browse files
authored
Merge pull request rancher#1841 from HarrisonWAffel/clarify-no-proxy-value
Clarify the expected format of `NO_PROXY`
2 parents e3eb640 + 717bef1 commit 1923eef

File tree

19 files changed

+150
-31
lines changed

19 files changed

+150
-31
lines changed

docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@ Once the infrastructure is ready, you can continue with setting up a Kubernetes
1010

1111
The steps to set up RKE, RKE2, or K3s are shown below.
1212

13-
For convenience, export the IP address and port of your proxy into an environment variable and set up the HTTP_PROXY variables for your current shell on every node:
13+
For convenience, export the IP address and port of your proxy into an environment variable and set up the `HTTP_PROXY` variables for your current shell on every node:
14+
15+
:::caution
16+
17+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable for Rancher, the value must adhere to the format expected by Golang.
18+
19+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
20+
21+
:::
1422

1523
```
1624
export proxy_host="10.0.0.5:8888"

docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ GKE Autopilot clusters aren't supported. See [Compare GKE Autopilot and Standard
5757
9. If you are using self-signed certificates, you will receive the message `certificate signed by unknown authority`. To work around this validation, copy the command starting with `curl` displayed in Rancher to your clipboard. Then run the command on a node where kubeconfig is configured to point to the cluster you want to import.
5858
10. When you finish running the command(s) on your node, click **Done**.
5959

60+
:::important
61+
62+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable in Rancher, the value must adhere to the format expected by Golang.
63+
64+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
65+
66+
:::
67+
6068
**Result:**
6169

6270
- Your cluster is registered and assigned a state of **Pending**. Rancher is deploying resources to manage your cluster.

docs/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ For private nodes or private clusters, the environment variables need to be set
2222

2323
When adding Fleet agent environment variables for the proxy, replace <PROXY_IP> with your private proxy IP.
2424

25+
:::caution
26+
27+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable in Rancher, the value must adhere to the format expected by Golang.
28+
29+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
30+
31+
:::
32+
2533
| Variable Name | Value |
2634
|------------------|--------|
2735
| `HTTP_PROXY` | http://<PROXY_IP>:8888 |

docs/reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ If you operate Rancher behind a proxy and you want to access services through th
1010

1111
Make sure `NO_PROXY` contains the network addresses, network address ranges and domains that should be excluded from using the proxy.
1212

13-
| Environment variable | Purpose |
14-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
15-
| HTTP_PROXY | Proxy address to use when initiating HTTP connection(s) |
16-
| HTTPS_PROXY | Proxy address to use when initiating HTTPS connection(s) |
17-
| NO_PROXY | Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s) |
13+
| Environment variable | Purpose |
14+
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
15+
| HTTP_PROXY | Proxy address to use when initiating HTTP connection(s) |
16+
| HTTPS_PROXY | Proxy address to use when initiating HTTPS connection(s) |
17+
| NO_PROXY | Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s). <br/><br/> The value must be a comma-delimited string which contains IP addresses, CIDR notation, domain names, or special DNS labels (*). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) |
1818

1919
:::note Important:
2020

@@ -62,4 +62,4 @@ acl SSL_ports port 2376
6262
6363
acl Safe_ports port 22 # ssh
6464
acl Safe_ports port 2376 # docker port
65-
```
65+
```

versioned_docs/version-2.10/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ The steps to set up RKE, RKE2, or K3s are shown below.
1212

1313
For convenience, export the IP address and port of your proxy into an environment variable and set up the HTTP_PROXY variables for your current shell on every node:
1414

15+
:::caution
16+
17+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable for Rancher, the value must adhere to the format expected by Golang.
18+
19+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
20+
21+
:::
22+
1523
```
1624
export proxy_host="10.0.0.5:8888"
1725
export HTTP_PROXY=http://${proxy_host}

versioned_docs/version-2.10/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,15 @@ GKE Autopilot clusters aren't supported. See [Compare GKE Autopilot and Standard
5656
9. If you are using self-signed certificates, you will receive the message `certificate signed by unknown authority`. To work around this validation, copy the command starting with `curl` displayed in Rancher to your clipboard. Then run the command on a node where kubeconfig is configured to point to the cluster you want to import.
5757
10. When you finish running the command(s) on your node, click **Done**.
5858

59+
:::important
60+
61+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable in Rancher, the value must adhere to the format expected by Golang.
62+
63+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
64+
65+
:::
66+
67+
5968
**Result:**
6069

6170
- Your cluster is registered and assigned a state of **Pending**. Rancher is deploying resources to manage your cluster.
@@ -295,4 +304,4 @@ This section lists some of the most common errors that may occur when importing
295304

296305
```sh
297306
az aks update --resource-group <resource-group> --name <cluster-name> --enable-local-accounts
298-
```
307+
```

versioned_docs/version-2.10/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ For private nodes or private clusters, the environment variables need to be set
2222

2323
When adding Fleet agent environment variables for the proxy, replace <PROXY_IP> with your private proxy IP.
2424

25+
:::caution
26+
27+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable in Rancher, the value must adhere to the format expected by Golang.
28+
29+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
30+
31+
:::
32+
2533
| Variable Name | Value |
2634
|------------------|--------|
2735
| `HTTP_PROXY` | http://<PROXY_IP>:8888 |

versioned_docs/version-2.10/reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ If you operate Rancher behind a proxy and you want to access services through th
1010

1111
Make sure `NO_PROXY` contains the network addresses, network address ranges and domains that should be excluded from using the proxy.
1212

13-
| Environment variable | Purpose |
14-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
15-
| HTTP_PROXY | Proxy address to use when initiating HTTP connection(s) |
16-
| HTTPS_PROXY | Proxy address to use when initiating HTTPS connection(s) |
17-
| NO_PROXY | Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s) |
18-
13+
| Environment variable | Purpose |
14+
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
15+
| HTTP_PROXY | Proxy address to use when initiating HTTP connection(s) |
16+
| HTTPS_PROXY | Proxy address to use when initiating HTTPS connection(s) |
17+
| NO_PROXY | Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s). <br/><br/> The value must be a comma-delimited string which contains IP addresses, CIDR notation, domain names, or special DNS labels (*). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) |
1918
:::note Important:
2019

2120
NO_PROXY must be in uppercase to use network range (CIDR) notation.
@@ -62,4 +61,4 @@ acl SSL_ports port 2376
6261
6362
acl Safe_ports port 22 # ssh
6463
acl Safe_ports port 2376 # docker port
65-
```
64+
```

versioned_docs/version-2.11/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ The steps to set up RKE, RKE2, or K3s are shown below.
1212

1313
For convenience, export the IP address and port of your proxy into an environment variable and set up the HTTP_PROXY variables for your current shell on every node:
1414

15+
:::caution
16+
17+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable for Rancher, the value must adhere to the format expected by Golang.
18+
19+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
20+
21+
:::
22+
1523
```
1624
export proxy_host="10.0.0.5:8888"
1725
export HTTP_PROXY=http://${proxy_host}

versioned_docs/version-2.11/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ GKE Autopilot clusters aren't supported. See [Compare GKE Autopilot and Standard
5757
9. If you are using self-signed certificates, you will receive the message `certificate signed by unknown authority`. To work around this validation, copy the command starting with `curl` displayed in Rancher to your clipboard. Then run the command on a node where kubeconfig is configured to point to the cluster you want to import.
5858
10. When you finish running the command(s) on your node, click **Done**.
5959

60+
:::important
61+
62+
The `NO_PROXY` environment variable is not standardized, and the accepted format of the value can differ between applications. When configuring the `NO_PROXY` variable in Rancher, the value must adhere to the format expected by Golang.
63+
64+
Specifically, the value should be a comma-delimited string which only contains IP addresses, CIDR notation, domain names, or special DNS labels (e.g. `*`). For a full description of the expected value format, refer to the [**upstream Golang documentation**](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config)
65+
66+
:::
67+
6068
**Result:**
6169

6270
- Your cluster is registered and assigned a state of **Pending**. Rancher is deploying resources to manage your cluster.

0 commit comments

Comments
 (0)