Skip to content

Commit d7decb3

Browse files
committed
OSDOCS-2466: Created configuration instructions for cluster-wide proxy.
1 parent 4f5e385 commit d7decb3

File tree

4 files changed

+77
-0
lines changed

4 files changed

+77
-0
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ Topics:
124124
Topics:
125125
- Name: Enabling multicast for a project
126126
File: enabling-multicast
127+
- Name: Configuring a cluster-wide proxy during installation
128+
File: configuring-cluster-wide-proxy
127129
---
128130
Name: Nodes
129131
Dir: nodes

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ Topics:
139139
Topics:
140140
- Name: Enabling multicast for a project
141141
File: enabling-multicast
142+
- Name: Configuring a cluster-wide proxy during installation
143+
File: configuring-cluster-wide-proxy
142144
---
143145
Name: Authentication and authorization
144146
Dir: authentication

modules/cluster-wide-proxy.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
include::modules/common-attributes.adoc[]
2+
ifdef::openshift-dedicated[]
3+
include::modules/attributes-openshift-dedicated.adoc[]
4+
endif::[]
5+
[id="cluster-wide-proxy-configuration"]
6+
= Configuring a cluster-wide proxy during installation
7+
:context: cluster-wide-proxy-configuration
8+
9+
toc::[]
10+
11+
You can configure a cluster-wide proxy during cluster installation.
12+
13+
== Prerequisites
14+
[id="prerequisites_cluster-wide-proxy-configuration"]
15+
16+
* You are the cluster owner.
17+
* Your account has sufficient privileges.
18+
ifdef::openshift-dedicated[]
19+
* You must have a Customer Cloud Subscription (CCS) cluster with a VPC that the proxy can access.
20+
21+
For more information, see xref:../../osd_quickstart/osd-quickstart.adoc[Quick Start] for a basic cluster installation workflow.
22+
endif::[]
23+
24+
ifdef::openshift-rosa[]
25+
For information about standard installation prerequisites, see xref:../../rosa_getting_started/rosa-aws-prereqs.adoc[AWS prerequisites for ROSA]. For information about the prerequisites for installation using AWS Security Token Service (STS), see xref:../../rosa_getting_started_sts/rosa-sts-aws-prereqs.adoc[AWS prerequisites for ROSA with STS].
26+
endif::[]
27+
28+
include::modules/cluster-wide-proxy.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)