From 122f5b18ce2d7ee9953c0f5c9174167928d3e60a Mon Sep 17 00:00:00 2001 From: ada mancini Date: Mon, 23 Dec 2024 11:34:41 -0500 Subject: [PATCH 1/3] Update proxy-installs.md Explain all the parameters; in particular `noProxy` is confusing sitting next to the references to NO_PROXY variable. https://github.com/replicatedhq/kURL/blob/main/design/proxy.md?plain=1#L47 --- src/markdown-pages/install-with-kurl/proxy-installs.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/markdown-pages/install-with-kurl/proxy-installs.md b/src/markdown-pages/install-with-kurl/proxy-installs.md index f2a7411c..1cdc4052 100644 --- a/src/markdown-pages/install-with-kurl/proxy-installs.md +++ b/src/markdown-pages/install-with-kurl/proxy-installs.md @@ -16,6 +16,7 @@ spec: proxyAddress: http://10.128.0.70:3128 additionalNoProxyAddresses: - .corporate.internal + - 172.28.16.0/24 noProxy: false ``` @@ -23,6 +24,12 @@ The proxy configuration will be used to download packages required for the insta The provided proxy will be configured and used for HTTP and HTTPS access. See [Modifying an Install Using a YAML Patch File](/docs/install-with-kurl#modifying-an-install-using-a-yaml-patch-file-at-runtime) for more details on using patch files. +## Parameters + +- `proxyAddress`: string - a URL, including http:// or https:// protocol, of the forward proxy. Both HTTP_PROXY and HTTPS_PROXY will be set to `proxyAddress` in kURL. +- `additionalNoProxyAddresses`: string - a YAML list of all domains, IPs, and CIDR blocks that will be added to the list of NO_PROXY addresses. +- `noProxy`: boolean - If `noProxy` is set to `true` then the other proxy fields in the spec are ignored and the installer does not attempt to do any proxy configuration and will ignore the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables that are set in the shell. Defaults to `false`. + ## Proxy Environment Variables If a `proxyAddress` is not configured in the installer spec, the following environment variables will be used instead: From cf76a8b974e70fad2fa50ee0530d682cecca97f0 Mon Sep 17 00:00:00 2001 From: ada mancini Date: Mon, 23 Dec 2024 11:42:23 -0500 Subject: [PATCH 2/3] Update proxy-installs.md --- src/markdown-pages/install-with-kurl/proxy-installs.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/markdown-pages/install-with-kurl/proxy-installs.md b/src/markdown-pages/install-with-kurl/proxy-installs.md index 1cdc4052..a0dfc354 100644 --- a/src/markdown-pages/install-with-kurl/proxy-installs.md +++ b/src/markdown-pages/install-with-kurl/proxy-installs.md @@ -26,9 +26,11 @@ See [Modifying an Install Using a YAML Patch File](/docs/install-with-kurl#modif ## Parameters -- `proxyAddress`: string - a URL, including http:// or https:// protocol, of the forward proxy. Both HTTP_PROXY and HTTPS_PROXY will be set to `proxyAddress` in kURL. -- `additionalNoProxyAddresses`: string - a YAML list of all domains, IPs, and CIDR blocks that will be added to the list of NO_PROXY addresses. -- `noProxy`: boolean - If `noProxy` is set to `true` then the other proxy fields in the spec are ignored and the installer does not attempt to do any proxy configuration and will ignore the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables that are set in the shell. Defaults to `false`. +| Parameter | Type | Description | +|----------------------------|------|-------------| +`proxyAddress` | string | a URL, including http:// or https:// protocol, of the forward proxy. Both HTTP_PROXY and HTTPS_PROXY will be set to `proxyAddress` in kURL | +`additionalNoProxyAddresses` | string | a YAML list of all domains, IPs, and CIDR blocks that will be added to the list of NO_PROXY addresses | +`noProxy` | boolean | if `noProxy` is set to `true` then the other proxy fields in the spec are ignored and the installer does not attempt to do any proxy configuration and will ignore the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables that are set in the shell. Defaults to `false` | ## Proxy Environment Variables From bf62ccadaf22dd51ed4953c5aa274996a9518c0d Mon Sep 17 00:00:00 2001 From: ada mancini Date: Mon, 23 Dec 2024 11:42:58 -0500 Subject: [PATCH 3/3] Update proxy-installs.md --- src/markdown-pages/install-with-kurl/proxy-installs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/markdown-pages/install-with-kurl/proxy-installs.md b/src/markdown-pages/install-with-kurl/proxy-installs.md index a0dfc354..a03de635 100644 --- a/src/markdown-pages/install-with-kurl/proxy-installs.md +++ b/src/markdown-pages/install-with-kurl/proxy-installs.md @@ -28,9 +28,9 @@ See [Modifying an Install Using a YAML Patch File](/docs/install-with-kurl#modif | Parameter | Type | Description | |----------------------------|------|-------------| -`proxyAddress` | string | a URL, including http:// or https:// protocol, of the forward proxy. Both HTTP_PROXY and HTTPS_PROXY will be set to `proxyAddress` in kURL | -`additionalNoProxyAddresses` | string | a YAML list of all domains, IPs, and CIDR blocks that will be added to the list of NO_PROXY addresses | -`noProxy` | boolean | if `noProxy` is set to `true` then the other proxy fields in the spec are ignored and the installer does not attempt to do any proxy configuration and will ignore the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables that are set in the shell. Defaults to `false` | +| `proxyAddress` | string | a URL, including http:// or https:// protocol, of the forward proxy. Both HTTP_PROXY and HTTPS_PROXY will be set to `proxyAddress` in kURL | +| `additionalNoProxyAddresses` | string | a YAML list of all domains, IPs, and CIDR blocks that will be added to the list of NO_PROXY addresses | +| `noProxy` | boolean | if `noProxy` is set to `true` then the other proxy fields in the spec are ignored and the installer does not attempt to do any proxy configuration and will ignore the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables that are set in the shell. Defaults to `false` | ## Proxy Environment Variables