Skip to content

Commit 04ea138

Browse files
committed
Merge pull request openshift#1901 from adellape/global-proxy-config
Add global proxy config doc to Adv Install (WIP)
2 parents df17da8 + 7683d7b commit 04ea138

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

install_config/install/advanced_install.adoc

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,86 @@ allocate 10.128.0.0/23, 10.128.2.0/23, 10.128.4.0/23, and so on. This *cannot* b
302302
re-configured after deployment.
303303
|===
304304

305+
[[advanced-install-configuring-global-proxy]]
306+
=== Configuring Global Proxy Options
307+
308+
If your hosts require use of a HTTP or HTTPS proxy in order to connect to
309+
external hosts, there are many components that must be configured to use the
310+
proxy, including masters, Docker, and builds. Node services only connect to the
311+
master API requiring no external access and therefore do not need to be
312+
configured to use a proxy.
313+
314+
In order to simplify this configuration, the following Ansible variables can be
315+
specified at a cluster or host level to apply these settings uniformly across
316+
your environment.
317+
318+
[NOTE]
319+
====
320+
See link:../../install_config/build_defaults_overrides.html[Configuring
321+
Global Build Defaults and Overrides] for more information on how the proxy
322+
environment is defined for builds.
323+
====
324+
325+
.Cluster Proxy Variables
326+
[options="header"]
327+
|===
328+
329+
|Variable |Purpose
330+
331+
|`*openshift_http_proxy*`
332+
|This variable specifies the `*HTTP_PROXY*` environment variable for masters and
333+
the Docker daemon.
334+
335+
|`*openshift_https_proxy*`
336+
|This variable specifices the `*HTTPS_PROXY*` environment variable for masters
337+
and the Docker daemon.
338+
339+
|`*openshift_no_proxy*`
340+
|This variable is used to set the `*NO_PROXY*` environment variable for masters
341+
and the Docker daemon. This value should be set to a comma separated list of
342+
host names or wildcard host names that should not use the defined proxy. This
343+
list will be augmented with the list of all defined {product-title} host names
344+
by default.
345+
346+
|`*openshift_generate_no_proxy_hosts*`
347+
|This boolean variable specifies whether or not the names of all defined
348+
OpenShift hosts and `pass:[*.cluster.local]` should be automatically appended to
349+
the `*NO_PROXY*` list. Defaults to *true*; set it to *false* to override this
350+
option.
351+
352+
|`*openshift_builddefaults_http_proxy*`
353+
|This variable defines the `*HTTP_PROXY*` environment variable inserted into
354+
builds using the `*BuildDefaults*` admission controller. If
355+
`*openshift_http_proxy*` is set, this variable will inherit that value; you only
356+
need to set this if you want your builds to use a different value.
357+
358+
|`*openshift_builddefaults_https_proxy*`
359+
|This variable defines the `*HTTPS_PROXY*` environment variable inserted into
360+
builds using the `*BuildDefaults*` admission controller. If
361+
`*openshift_https_proxy*` is set, this variable will inherit that value; you
362+
only need to set this if you want your builds to use a different value.
363+
364+
|`*openshift_builddefaults_no_proxy*`
365+
|This variable defines the `*NO_PROXY*` environment variable inserted into
366+
builds using the `*BuildDefaults*` admission controller. If
367+
`*openshift_no_proxy*` is set, this variable will inherit that value; you only
368+
need to set this if you want your builds to use a different value.
369+
370+
|`*openshift_builddefaults_git_http_proxy*`
371+
|This variable defines the HTTP proxy used by `git clone` operations during a
372+
build, defined using the `*BuildDefaults*` admission controller. If
373+
`*openshift_builddefaults_http_proxy*` is set, this variable will inherit that
374+
value; you only need to set this if you want your `git clone` operations to use
375+
a different value.
376+
377+
|`*openshift_builddefaults_git_https_proxy*`
378+
|This variable defines the HTTPS proxy used by `git clone` operations during a
379+
build, defined using the `*BuildDefaults*` admission controller. If
380+
`*openshift_builddefaults_https_proxy*` is set, this variable will inherit that
381+
value; you only need to set this if you want your `git clone` operations to use
382+
a different value.
383+
|===
384+
305385
[[configuring-node-host-labels]]
306386
=== Configuring Node Host Labels
307387

0 commit comments

Comments
 (0)