|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * networking/configuring-cluster-wide-proxy.adoc |
| 4 | + |
| 5 | +[id="cluster-wide-proxy-config_{context}"] |
| 6 | += Configuring a cluster-wide proxy |
| 7 | + |
| 8 | +You can add a proxy during cluster installation. Prior to installation, however, you should verify that the proxy is accessible from the intended cluster virtual private cloud (VPC) and its private subnets. |
| 9 | + |
| 10 | +.Prerequsites |
| 11 | +ifdef::openshift-rosa[] |
| 12 | +* You have the `rosa` CLI installed and configured. |
| 13 | +endif::[] |
| 14 | +ifdef::openshift-dedicated[] |
| 15 | +* You have the `ocm` CLI installed and configured. |
| 16 | +endif::[] |
| 17 | + |
| 18 | +.Procedure |
| 19 | +* To create a cluster with a proxy, run the following command: |
| 20 | ++ |
| 21 | +ifdef::openshift-rosa[] |
| 22 | +[source,terminal] |
| 23 | +---- |
| 24 | +$ rosa create cluster \ |
| 25 | + <other_arguments_here> \ |
| 26 | + --additional-trust-bundle-file <path_to_CA_bundle_file> \ <1> <2> <3> |
| 27 | + --http-proxy http://<username>:<pswd>@<ip>:<port> \ <1> <4> |
| 28 | + --https-proxy http(s)://<username>:<pswd>@<ip>:<port> <4> |
| 29 | +---- |
| 30 | +endif::[] |
| 31 | +ifdef::openshift-dedicated[] |
| 32 | +[source,terminal] |
| 33 | +---- |
| 34 | +$ ocm create cluster \ |
| 35 | + <other_arguments_here> \ |
| 36 | + --additional-trust-bundle-file <path_to_CA_bundle_file> \ <1> <2> <3> |
| 37 | + --http-proxy http://<username>:<pswd>@<ip>:<port> \ <1> <4> |
| 38 | + --https-proxy http(s)://<username>:<pswd>@<ip>:<port> <4> |
| 39 | +---- |
| 40 | +endif::[] |
| 41 | ++ |
| 42 | +<1> The `http-proxy`, `https-proxy`, and `additional-trust-bundle-file` arguments are all optional. |
| 43 | +<2> If you use the `additional-trust-bundle-file` option without an `http(s)-proxy` argument, the passed additional trust bundle is set on the cluster, but it is not configured to be used with the proxy. |
| 44 | +<3> The `additional-trust-bundle-file` argument is a file path pointing to a bundle of PEM-encoded X.509 certificates, which are all concatenated together. The `additionalTrustBundle` field is required unless the proxy's identity certificate is signed by an authority from the {op-system} trust bundle. If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must provide the MITM CA certificate. |
| 45 | +<4> The `http-proxy` and `https-proxy` arguments must point to a valid URL. |
0 commit comments