Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update proxy-installs.md explain parameters #1080

Merged
merged 3 commits into from
Dec 24, 2024
Merged

Update proxy-installs.md explain parameters #1080

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
122f5b1
Update proxy-installs.md
adamancini Dec 23, 2024
cf76a8b
Update proxy-installs.md
adamancini Dec 23, 2024
bf62cca
Update proxy-installs.md
adamancini Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/markdown-pages/install-with-kurl/proxy-installs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,22 @@ spec:
proxyAddress: http://10.128.0.70:3128
additionalNoProxyAddresses:
- .corporate.internal
- 172.28.16.0/24
noProxy: false
```

The proxy configuration will be used to download packages required for the installation script to complete and will be applied to the docker and KOTS add-ons.
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

| 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

If a `proxyAddress` is not configured in the installer spec, the following environment variables will be used instead:
Expand Down