Skip to content

Commit aab7019

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #51726 from EricPonvelle/OSDOCS-4352_ClusterWideProxyUpdates
OSDOCS-4352: Updated cluster-wide proxy documentation
2 parents 5ac9db0 + 53cdddf commit aab7019

5 files changed

+132
-52
lines changed

‎modules/configuring-a-proxy-after-installation.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎modules/configuring-a-proxy-during-installation.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎modules/nw-proxy-remove.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
[id="nw-proxy-remove_{context}"]
77
= Removing the cluster-wide proxy
88

9-
The `cluster` Proxy object cannot be deleted. To remove the proxy from a cluster,
10-
remove all `spec` fields from the Proxy object.
9+
The `cluster` Proxy object cannot be deleted. To remove the proxy from a cluster, remove all `spec` fields from the Proxy object.
1110

1211
.Prerequisites
1312

@@ -35,4 +34,4 @@ spec: {}
3534
status: {}
3635
----
3736

38-
. Save the file to apply the changes.
37+
. Save the file to apply the changes.

‎modules/nw-rosa-proxy-remove-cli.adoc

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/enable-cluster-wide-proxy.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="nw-rosa-proxy-remove-cli_{context}"]
7+
= Removing the cluster-wide proxy using CLI
8+
9+
You must use the `rosa` CLI to remove the proxy's address from your cluster.
10+
11+
.Prerequisites
12+
13+
* You must have cluster administrator privileges.
14+
* You have installed the {product-title} `rosa` CLI tool.
15+
16+
.Procedure
17+
18+
* Use the `rosa edit` command to modify the proxy. You must pass empty strings to the `--http-proxy` and `--https-proxy` arguments to clear the proxy from the cluster:
19+
+
20+
[source,terminal]
21+
----
22+
$ rosa edit cluster -c <cluster_name> --http-proxy "" --https-proxy ""
23+
----
24+
+
25+
[NOTE]
26+
====
27+
While your proxy might only use one of the proxy arguments, the empty fields are ignored, so passing empty strings to both the `--http-proxy` and `--https-proxy` arguments do not cause any issues.
28+
====
29+
+
30+
.Example Output
31+
+
32+
[source,yaml]
33+
----
34+
I: Updated cluster <cluster_name>
35+
----
36+
37+
.Verification
38+
39+
* You can verify that the proxy has been removed from the cluster by using the `rosa describe` command:
40+
+
41+
[source,yaml]
42+
----
43+
$ rosa describe cluster -c <cluster_name>
44+
----
45+
+
46+
Before removal, the proxy IP displays in a proxy section:
47+
+
48+
[source,yaml]
49+
----
50+
Name: <cluster_name>
51+
ID: <cluster_internal_id>
52+
External ID: <cluster_external_id>
53+
OpenShift Version: 4.11.9
54+
Channel Group: stable
55+
DNS: <dns>
56+
AWS Account: <aws_account_id>
57+
API URL: <api_url>
58+
Console URL: <console_url>
59+
Region: us-east-1
60+
Multi-AZ: false
61+
Nodes:
62+
- Control plane: 3
63+
- Infra: 2
64+
- Compute: 2
65+
Network:
66+
- Type: OVNKubernetes
67+
- Service CIDR: <service_cidr>
68+
- Machine CIDR: <machine_cidr>
69+
- Pod CIDR: <pod_cidr>
70+
- Host Prefix: <host_prefix>
71+
Proxy:
72+
- HTTPProxy: <proxy_url>
73+
Additional trust bundle: REDACTED
74+
----
75+
+
76+
After removing the proxy, the proxy section is removed:
77+
+
78+
[source,yaml]
79+
----
80+
Name: <cluster_name>
81+
ID: <cluster_internal_id>
82+
External ID: <cluster_external_id>
83+
OpenShift Version: 4.11.9
84+
Channel Group: stable
85+
DNS: <dns>
86+
AWS Account: <aws_account_id>
87+
API URL: <api_url>
88+
Console URL: <console_url>
89+
Region: us-east-1
90+
Multi-AZ: false
91+
Nodes:
92+
- Control plane: 3
93+
- Infra: 2
94+
- Compute: 2
95+
Network:
96+
- Type: OVNKubernetes
97+
- Service CIDR: <service_cidr>
98+
- Machine CIDR: <machine_cidr>
99+
- Pod CIDR: <pod_cidr>
100+
- Host Prefix: <host_prefix>
101+
Additional trust bundle: REDACTED
102+
----

‎networking/configuring-cluster-wide-proxy.adoc

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,20 @@ endif::openshift-dedicated[]
4242

4343
include::modules/configuring-a-proxy-trust-bundle-responsibilities.adoc[leveloffset=+1]
4444

45+
[id="configuring-a-proxy-during-installation_{context}"]
46+
== Configuring a proxy during installation
47+
48+
ifdef::openshift-dedicated[]
49+
You can configure an HTTP or HTTPS proxy when you install an {product-title} with Customer Cloud Subscription (CCS) cluster into an existing Virtual Private Cloud (VPC). You can configure the proxy during installation by using {cluster-manager-first}.
50+
51+
include::modules/configuring-a-proxy-during-installation-ocm.adoc[leveloffset=+1]
52+
endif::openshift-dedicated[]
4553
ifdef::openshift-rosa[]
46-
include::modules/configuring-a-proxy-during-installation.adoc[leveloffset=+1]
54+
You can configure an HTTP or HTTPS proxy when you install a {product-title} (ROSA) cluster into an existing Virtual Private Cloud (VPC). You can configure the proxy during installation by using {cluster-manager-first} or the ROSA CLI (`rosa`).
55+
4756
include::modules/configuring-a-proxy-during-installation-ocm.adoc[leveloffset=+2]
4857
include::modules/configuring-a-proxy-during-installation-cli.adoc[leveloffset=+2]
4958
endif::openshift-rosa[]
50-
ifdef::openshift-dedicated[]
51-
include::modules/configuring-a-proxy-during-installation-ocm.adoc[leveloffset=+1]
52-
endif::openshift-dedicated[]
5359

5460
[role="_additional-resources"]
5561
.Additional Resources
@@ -63,11 +69,24 @@ ifdef::openshift-dedicated[]
6369
* xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-create-gcp-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP with CCS]
6470
endif::openshift-dedicated[]
6571

66-
ifdef::openshift-rosa[]
67-
include::modules/configuring-a-proxy-after-installation.adoc[leveloffset=+1]
68-
include::modules/configuring-a-proxy-after-installation-ocm.adoc[leveloffset=+2]
69-
include::modules/configuring-a-proxy-after-installation-cli.adoc[leveloffset=+2]
70-
endif::openshift-rosa[]
72+
[id="configuring-a-proxy-after-installation_{context}"]
73+
== Configuring a proxy after installation
74+
7175
ifdef::openshift-dedicated[]
76+
You can configure an HTTP or HTTPS proxy after you install an {product-title} with Customer Cloud Subscription (CCS) cluster into an existing Virtual Private Cloud (VPC). You can configure the proxy after installation by using {cluster-manager-first}.
77+
7278
include::modules/configuring-a-proxy-after-installation-ocm.adoc[leveloffset=+1]
7379
endif::openshift-dedicated[]
80+
ifdef::openshift-rosa[]
81+
You can configure an HTTP or HTTPS proxy after you install a {product-title} (ROSA) cluster into an existing Virtual Private Cloud (VPC). You can configure the proxy after installation by using {cluster-manager-first} or the ROSA CLI (`rosa`).
82+
83+
include::modules/configuring-a-proxy-after-installation-ocm.adoc[leveloffset=+2]
84+
include::modules/configuring-a-proxy-after-installation-cli.adoc[leveloffset=+2]
85+
86+
[id="removing-cluster-wide-proxy_{context}"]
87+
== Removing a cluster-wide proxy
88+
89+
You can remove your cluster-wide proxy by using the `rosa` CLI tool.
90+
91+
include::modules/nw-rosa-proxy-remove-cli.adoc[leveloffset=+2]
92+
endif::openshift-rosa[]

0 commit comments

Comments
 (0)