Skip to content

Commit 2f54632

Browse files
authored
Enable Onramp to work with proxy, if needed (#83)
* Enable Onramp to work with proxy, if needed Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Address Copilot's comments Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> --------- Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
1 parent 2743764 commit 2f54632

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

onramp/ref.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,21 @@ the list is not comprehensive.
115115
- `false`
116116
- Loads Helm Charts from public repo; set to `true` to utilize
117117
local charts, with `*.helm.charts_ref` set to local path name.
118+
* - `proxy.enabled`
119+
- `false`
120+
- Enable HTTP proxy support for all deployment steps; set to `true`
121+
when deploying behind a corporate or institutional proxy.
122+
* - `proxy.http_proxy`
123+
- `""`
124+
- HTTP proxy URL (e.g., ``http://proxy.example.com:3128``).
125+
* - `proxy.https_proxy`
126+
- `""`
127+
- HTTPS proxy URL (e.g., ``http://proxy.example.com:3128``).
128+
* - `proxy.no_proxy`
129+
- See ``vars/main.yml``
130+
- Comma-separated list of hosts and CIDRs that bypass the proxy;
131+
the default includes localhost, private subnets, and Kubernetes
132+
internal domains as defined in ``vars/main.yml``.
118133

119134
In addition to the variables listed in the preceding table, the vars
120135
file also references other configuration files required by each

onramp/start.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,31 @@ The output should show that Ansible is able to securely connect to all
247247
the nodes in your deployment, which is currently just the one that
248248
Ansible knows as ``node1``.
249249

250+
Configure Proxy (Optional)
251+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252+
253+
If your server accesses the Internet through an HTTP proxy, enable
254+
proxy support by editing the ``proxy`` section in
255+
``vars/main.yml``:
256+
257+
.. code-block:: yaml
258+
259+
proxy:
260+
enabled: true
261+
http_proxy: "http://proxy.example.com:3128"
262+
https_proxy: "http://proxy.example.com:3128"
263+
no_proxy: "localhost,127.0.0.1,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,10.42.0.0/16,10.43.0.0/16,.svc,.svc.cluster.local,.cluster.local"
264+
265+
When ``proxy.enabled`` is ``true``, OnRamp automatically propagates
266+
proxy settings to all deployment steps. This includes Ansible tasks
267+
that download software (e.g., ``apt``, ``pip``, ``helm``), the Docker
268+
daemon on nodes running Docker-based components, and RKE2's embedded
269+
containerd runtime on Kubernetes nodes. Adjust ``no_proxy`` to include
270+
any additional internal hosts or domains that should bypass the proxy.
271+
272+
When ``proxy.enabled`` is ``false`` (the default), the proxy section
273+
has no effect and can be left as-is.
274+
250275
Install Kubernetes
251276
~~~~~~~~~~~~~~~~~~~
252277

0 commit comments

Comments
 (0)