[OSDOCS-11968]: Proxy docs for HCP by lahinson · Pull Request #87863 · openshift/openshift-docs

lahinson · 2025-01-30T17:27:02Z

Version(s): 4.18+

Issue: https://issues.redhat.com/browse/OSDOCS-11968

Link to docs preview: https://87863--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-networking.html

QE review:

QE has approved this change.

Additional information: This is ready to merge, but will not be merged until the HCP docs are released on March. 20.

ocpdocs-previewbot · 2025-01-30T17:44:01Z

🤖 Wed Mar 19 13:53:40 - Prow CI generated the docs preview:

https://87863--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-networking.html
https://87863--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/enable-cluster-wide-proxy.html

csrwng

Just one comment, otherwise lgtm

csrwng · 2025-02-26T22:04:02Z

modules/hcp-proxy-ignition.adoc

+
+[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":{},"security":{"tls":{"certificateAuthorities":[{"source":"...","verification":{}}]}},"timeouts":{},"version":"3.2.0"},"passwd":{},"storage":{},"systemd":{}}


nit:
It would be good to include values for the proxy fields in the stub for this example:

{"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":{}}

Thank you, @csrwng! I added the values to the proxy field.

jiezhao16 · 2025-02-27T20:02:40Z

lgtm

xenolinux

Overall looks good! 2 comments only.

LGTM

xenolinux · 2025-02-28T05:39:49Z

modules/hcp-proxy-cp-workloads.adoc

+
+* The Ingress Operator needs access to validate external canary routes.
+
+In a hosted cluster, traffic that originates from the Control Plane Operator, Ingress Operator, OAuth server, and OpenShift API server pods should be sent through the data plane to the configured proxy and then to its final destination. 


Suggested change

In a hosted cluster, traffic that originates from the Control Plane Operator, Ingress Operator, OAuth server, and OpenShift API server pods should be sent through the data plane to the configured proxy and then to its final destination.

In a hosted cluster, traffic that originates from the Control Plane Operator, Ingress Operator, OAuth server, and OpenShift API server pods must be sent through the data plane to the configured proxy and then to its final destination.

If this is something done by users, then can be converted into an active voice. -- "...., you must send traffic that....through the data..."

Avoid using should
https://www.ibm.com/docs/en/ibm-style?topic=word-usage#s

Whenever possible, rewrite in a more direct way. Do not use should to refer to an action that must be performed.

Both good points. Will fix.

xenolinux · 2025-02-28T05:44:09Z

modules/hcp-proxy-ignition.adoc

+[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, the proxy must be configured 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.


Suggested change

When compute nodes need a proxy to access the ignition endpoint, the proxy must be configured 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.

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.

Active vs passive voice

lahinson · 2025-03-19T13:37:45Z

/cherrypick enterprise-4.18

lahinson · 2025-03-19T13:37:53Z

/cherrypick enterprise-4.19

openshift-cherrypick-robot · 2025-03-19T13:38:36Z

@lahinson: new pull request created: #90637

Details

In response to this:

/cherrypick enterprise-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-03-19T13:38:39Z

@lahinson: new pull request created: #90638

Details

In response to this:

/cherrypick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci · 2025-03-19T13:56:08Z

@lahinson: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

lahinson added this to the Planned for 4.18 GA milestone Jan 30, 2025

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 30, 2025

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 2, 2025

lahinson force-pushed the osdocs-11968-hcp-proxy branch from b7c2109 to 29e1d9f Compare February 4, 2025 20:49

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 4, 2025

lahinson force-pushed the osdocs-11968-hcp-proxy branch 5 times, most recently from 687249f to 9399a1f Compare February 18, 2025 18:43

lahinson force-pushed the osdocs-11968-hcp-proxy branch from 9399a1f to 3b24552 Compare February 24, 2025 18:07

kalexand-rh modified the milestones: OCP 4.18 GA, Continuous Release Feb 24, 2025

lahinson added branch/enterprise-4.18 branch/enterprise-4.19 labels Feb 24, 2025

csrwng reviewed Feb 26, 2025

View reviewed changes

lahinson force-pushed the osdocs-11968-hcp-proxy branch from 3b24552 to 55e3720 Compare February 27, 2025 17:16

lahinson added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 27, 2025

xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Feb 28, 2025

xenolinux reviewed Feb 28, 2025

View reviewed changes

xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Feb 28, 2025

[OSDOCS-11968]: Proxy docs for HCP

9330674

lahinson force-pushed the osdocs-11968-hcp-proxy branch from 55e3720 to 9330674 Compare March 3, 2025 17:43

lahinson marked this pull request as draft March 3, 2025 18:51

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 3, 2025

lahinson added the ok-to-merge label Mar 3, 2025

lahinson marked this pull request as ready for review March 19, 2025 13:37

lahinson merged commit 17bedd7 into openshift:main Mar 19, 2025
2 checks passed

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 19, 2025

openshift-cherrypick-robot mentioned this pull request Mar 19, 2025

[enterprise-4.18] [OSDOCS-11968]: Proxy docs for HCP #90637

Merged

openshift-cherrypick-robot mentioned this pull request Mar 19, 2025

[enterprise-4.19] [OSDOCS-11968]: Proxy docs for HCP #90638

Merged


		* The Ingress Operator needs access to validate external canary routes.

		In a hosted cluster, traffic that originates from the Control Plane Operator, Ingress Operator, OAuth server, and OpenShift API server pods should be sent through the data plane to the configured proxy and then to its final destination.

	When compute nodes need a proxy to access the ignition endpoint, the proxy must be configured 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.
	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.

Conversation

lahinson commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

csrwng left a comment

Choose a reason for hiding this comment

Uh oh!

csrwng Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lahinson Feb 27, 2025

Choose a reason for hiding this comment

Uh oh!

jiezhao16 commented Feb 27, 2025

Uh oh!

xenolinux left a comment

Choose a reason for hiding this comment

Uh oh!

xenolinux Feb 28, 2025

Choose a reason for hiding this comment

Uh oh!

lahinson Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

xenolinux Feb 28, 2025

Choose a reason for hiding this comment

Uh oh!

lahinson Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lahinson commented Mar 19, 2025

Uh oh!

lahinson commented Mar 19, 2025

Uh oh!

openshift-cherrypick-robot commented Mar 19, 2025

Uh oh!

openshift-cherrypick-robot commented Mar 19, 2025

Uh oh!

openshift-ci bot commented Mar 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

lahinson commented Jan 30, 2025 •

edited

Loading

ocpdocs-previewbot commented Jan 30, 2025 •

edited

Loading

csrwng Feb 26, 2025 •

edited

Loading