diff --git a/modules/hcp-proxy-addl-network.adoc b/modules/hcp-proxy-addl-network.adoc index 54db8e0b8f42..93560bc9711c 100644 --- a/modules/hcp-proxy-addl-network.adoc +++ b/modules/hcp-proxy-addl-network.adoc @@ -4,6 +4,9 @@ :_mod-docs-content-type: CONCEPT [id="hcp-proxy-addl-network_{context}"] -= Management cluster that uses a proxy and a hosted cluster with a secondary network and no default pod network += Management cluster with a proxy and a hosted cluster with a secondary network and no default pod network -If a management cluster uses a proxy configuration and you are configuring a hosted cluster with a secondary network but are not attaching the default pod network, add the CIDR of the secondary network to the proxy configuration. Specifically, you need to add the CIDR of the secondary network to the `noProxy` section of the proxy configuration for the management cluster. Otherwise, the Kubernetes API server will route some API requests through the proxy. In the hosted cluster configuration, the CIDR of the secondary network is automatically added to the `noProxy` section. \ No newline at end of file +[role="_abstract"] +If a management cluster uses a proxy configuration and you are configuring a hosted cluster with a secondary network but are not attaching the default pod network, add the CIDR of the secondary network to the proxy configuration. + +Specifically, you need to add the CIDR of the secondary network to the `noProxy` section of the proxy configuration for the management cluster. Otherwise, the Kubernetes API server will route some API requests through the proxy. In the hosted cluster configuration, the CIDR of the secondary network is automatically added to the `noProxy` section. \ No newline at end of file diff --git a/modules/hcp-proxy-api.adoc b/modules/hcp-proxy-api.adoc index c8ca3f3bbc5c..5455348daff9 100644 --- a/modules/hcp-proxy-api.adoc +++ b/modules/hcp-proxy-api.adoc @@ -2,10 +2,16 @@ // // * hosted_control_planes/hcp-networking.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="hcp-proxy-api_{context}"] = Compute nodes that need to access the API server -This use case is relevant to self-managed {hcp}, not to {product-rosa} with {hcp}. +[role="_abstract"] +For communication with the control plane, {hcp} uses a local proxy in every compute node that listens on IP address 172.20.0.1 and forwards traffic to the API server. If an external proxy is required to access the API server, that local proxy needs to use the external proxy to send traffic out. -For communication with the control plane, {hcp} uses a local proxy in every compute node that listens on IP address 172.20.0.1 and forwards traffic to the API server. If an external proxy is required to access the API server, that local proxy needs to use the external proxy to send traffic out. When a proxy is not needed, {hcp} uses `haproxy` for the local proxy, which only forwards packets via TCP. When a proxy is needed, {hcp} uses a custom proxy, `control-plane-operator-kubernetes-default-proxy`, to send traffic through the external proxy. \ No newline at end of file +When a proxy is not needed, {hcp} uses `haproxy` for the local proxy, which only forwards packets via TCP. When a proxy is needed, {hcp} uses a custom proxy, `control-plane-operator-kubernetes-default-proxy`, to send traffic through the external proxy. + +[NOTE] +==== +This use case is relevant to self-managed {hcp}, not to {product-rosa}. +==== diff --git a/modules/hcp-proxy-cp-workloads.adoc b/modules/hcp-proxy-cp-workloads.adoc index 9b3f5eb64411..f808e05d38e2 100644 --- a/modules/hcp-proxy-cp-workloads.adoc +++ b/modules/hcp-proxy-cp-workloads.adoc @@ -6,7 +6,10 @@ [id="hcp-proxy-cp-workloads_{context}"] = Control plane workloads that need to access external services -Operators that run in the control plane need to access external services through the proxy that is configured for the hosted cluster. The proxy is usually accessible only through the data plane. The control plane workloads are as follows: +[role="_abstract"] +Operators that run in the control plane need to access external services through the proxy that is configured for the hosted cluster. The proxy is usually accessible only through the data plane. + +The control plane workloads are as follows: * The Control Plane Operator needs to validate and obtain endpoints from certain identity providers when it creates the OAuth server configuration. diff --git a/modules/hcp-proxy-ignition.adoc b/modules/hcp-proxy-ignition.adoc index bb35880ebfba..3e6f89ba5042 100644 --- a/modules/hcp-proxy-ignition.adoc +++ b/modules/hcp-proxy-ignition.adoc @@ -2,15 +2,18 @@ // // * hosted_control_planes/hcp-networking.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="hcp-proxy-ignition_{context}"] = Compute nodes that need to access an ignition endpoint -When compute nodes need a proxy to access the ignition endpoint, you must configure the proxy in the user-data stub that is configured on the compute node when it is created. For cases where machines need a proxy to access the ignition URL, the proxy configuration is included in the stub. +[role="_abstract"] +When compute nodes need a proxy to access the ignition endpoint, you must configure the proxy in the user-data stub that is configured on the compute node when it is created. + +For cases where machines need a proxy to access the ignition URL, the proxy configuration is included in the stub. The stub resembles the following example: [source,terminal] ---- +---- {"ignition":{"config":{"merge":[{"httpHeaders":[{"name":"Authorization","value":"Bearer ..."},{"name":"TargetConfigVersionHash","value":"a4c1b0dd"}],"source":"https://ignition.controlplanehost.example.com/ignition","verification":{}}],"replace":{"verification":{}}},"proxy":{"httpProxy":"http://proxy.example.org:3128", "httpsProxy":"https://proxy.example.org:3129", "noProxy":"host.example.org"},"security":{"tls":{"certificateAuthorities":[{"source":"...","verification":{}}]}},"timeouts":{},"version":"3.2.0"},"passwd":{},"storage":{},"systemd":{}} ---- \ No newline at end of file +---- \ No newline at end of file diff --git a/modules/hcp-proxy-mgmt-cluster.adoc b/modules/hcp-proxy-mgmt-cluster.adoc index c429c4ec6680..51e2637fbc56 100644 --- a/modules/hcp-proxy-mgmt-cluster.adoc +++ b/modules/hcp-proxy-mgmt-cluster.adoc @@ -6,4 +6,7 @@ [id="hcp-proxy-mgmt-cluster_{context}"] = Management clusters that need external access -The HyperShift Operator has a controller that monitors the OpenShift global proxy configuration of the management cluster and sets the proxy environment variables on its own deployment. Control plane deployments that need external access are configured with the proxy environment variables of the management cluster. \ No newline at end of file +[role="_abstract"] +The HyperShift Operator has a controller that monitors the OpenShift global proxy configuration of the management cluster and sets the proxy environment variables on its own deployment. + +Control plane deployments that need external access are configured with the proxy environment variables of the management cluster.