Learn about proxies for AI Data Engine
If your AI Data Engine (AIDE) host or cluster cannot reach the internet directly, configure a forward proxy so the installer and AI Data Engine can download components, pull container images, and register with NetApp Console. The proxy options are the same for single-node and multi-node deployments. The steps to prepare for and run the installation differ, so each deployment type has its own workflow.
The installer doesn't configure the proxy for other software on the host, such as the package manager. For a single-node deployment, the installer configures the proxy for k3s and AI Data Engine, and adds the CA certificate that you supply with --proxy-ca-cert to the host trust store. For a multi-node deployment, the installer configures only the AI Data Engine workloads. You configure the container runtime proxy and certificate trust on each node.
Deploy AI Data Engine with a proxy
Each deployment type has its own topic with the complete procedure, from preparing the environment to running the installer.
-
Deploy AI Data Engine as a single-node deployment with a proxy: The installer configures the proxy for the k3s runtime and for AI Data Engine, and adds the CA certificate that you supply to the trust stores.
-
Deploy AI Data Engine as a multi-node deployment with a proxy: You configure the container runtime proxy and the CA certificate trust on every node before you run the installer.
What goes through the proxy
Only internet-bound traffic uses the proxy. All AI Data Engine internet destinations use HTTPS on port 443, so your proxy must allow CONNECT to port 443 for each endpoint in Outbound internet access.
Traffic on your network connects directly and must stay reachable without the proxy:
-
The Console agent (
--cm-host) -
NFS, CIFS/SMB, ONTAP, and StorageGRID data sources
-
Active Directory and LDAP
-
The Kubernetes API server and the cluster's internal networks
Supported proxy configurations
| Configuration | Description | Authentication |
|---|---|---|
No proxy |
Direct connection to the internet; no proxy is used. |
None |
HTTP forward proxy |
AI Data Engine connects to the proxy over HTTP and tunnels HTTPS destinations with |
None, or HTTP Basic authentication (username and password) |
HTTPS forward proxy |
AI Data Engine connects to the proxy over TLS. If a private certificate authority (CA) signed the proxy certificate, you supply the CA certificate. |
None, or HTTP Basic authentication (username and password) |
TLS-inspecting proxy |
The proxy decrypts HTTPS traffic and re-signs the certificate of each destination with its own inspection CA. Set |
None, or HTTP Basic authentication (username and password) |
You can address the proxy by host name or IPv4 address.
Supported proxy types
AI Data Engine supports two proxy types. Set the type with --proxy-type.
Regular forward proxy (r) |
TLS-inspecting proxy (t) |
|
|---|---|---|
How it handles HTTPS traffic |
Tunnels connections with HTTP |
Decrypts HTTPS traffic and re-signs the certificate of each destination with the proxy's inspection CA. |
|
Required only if the proxy itself uses HTTPS and its certificate is signed by a private CA. |
Required. Supply the CA certificate that the proxy uses for inspection. If you omit it, the installer rejects the command before it makes any network connections. |
|
|
|
A TLS-inspecting proxy is different from an HTTPS proxy. An HTTPS proxy is a proxy that you connect to over TLS (--proxy-scheme https). A TLS-inspecting proxy is a proxy that re-signs the certificates of the destinations that you reach through it. A TLS-inspecting proxy can use either scheme.
Some other proxy features aren't supported. See Known limitations.
The installer uses one proxy for every internet destination and every AI Data Engine component. The proxy settings are set during installation.
Proxy configuration parameters
| Parameter | Default | Description |
|---|---|---|
|
None |
Host name or IPv4 address of the forward proxy, without |
|
|
Port the proxy listens on. Ignored if the port is already included in |
|
|
Protocol used to connect to the proxy server itself. This is not the scheme of the destinations that the proxy reaches. Most forward proxies listen on plain HTTP, so pass |
|
None |
Path to a PEM file, or to a flat directory of This is required when:
Don't specify it for a regular proxy ( |
|
None |
Username for basic authentication. With an HTTP proxy, the installer warns that credentials travel to the proxy unencrypted. Requires a password, supplied with |
|
None |
Path to a local file that contains only the proxy password, with permissions set to |
|
|
Type of proxy. |
|
— |
Explicitly disables proxy configuration and skips proxy prompts. Use it only when the host has direct internet access. |
|
|
The installer doesn't accept --proxy-password or the PROXY_PASSWORD environment variable. Use --proxy-password-file or the interactive prompt instead.
|
The installer download
The install command copied from NetApp Console downloads the installer from a content delivery network (CDN) and then runs it in one step. The download doesn't use the proxy. If the target host reaches the internet only through a proxy, you download the installer yourself and run the install command from the extracted installer. The deployment topics describe these steps.
Proxy verification
Before the installer downloads anything, it runs a check from the installer host. The check confirms that the proxy responds, that the proxy accepts your credentials, and that the proxy certificate is valid for the scheme you chose. If the check fails, the installer stops and names the cause, for example a wrong port, a wrong scheme, or a rejected password (HTTP 407).
For multi-node deployments, the check covers the proxy only. It does not test whether the cluster nodes can reach the proxy.
Change proxy settings after installation
The proxy settings are set during installation. The installer doesn't run again on an installed cluster. To change the proxy host, port, credentials, or CA certificate after installation, contact NetApp Support.