[OSDOCS-14539]: Custom DNS name #94090

lahinson · 2025-06-02T14:06:25Z

Version(s): 4.19+

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

Link to docs preview:
This PR adds one module to several places in the HCP docs:

Defining a custom DNS name: https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-aws.html#hcp-custom-dns_hcp-deploy-aws (in Deploying HCP on AWS docs)
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-bm#hcp-custom-dns_hcp-deploy-bm (in Deploying HCP on bare metal docs)
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-virt#hcp-custom-dns_hcp-deploy-virt (in Deploying HCP on OpenShift Virtualization docs)
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm#hcp-custom-dns_hcp-deploy-non-bm (in Deploying HCP on non-bare metal)
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz#hcp-custom-dns_hcp-deploy-ibmz (in Deploying HCP on IBM Z)
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power#hcp-custom-dns_hcp-deploy-ibm-power (in Deploying HCP on IBM Power)

QE review:

QE has approved this change.

Additional information: This PR should be published for the HCP 4.19 GA on July 2.

ocpdocs-previewbot · 2025-06-02T14:19:07Z

🤖 Thu Jun 05 14:01:28 - Prow CI generated the docs preview:

https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-aws.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-bm.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-virt.html
https://94090--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-manage/hcp-manage-aws.html

jparrill

Dropped a comment. Thanks!

modules/hcp-custom-kubeapi.adoc

jparrill

/lgtm

jiezhao16 · 2025-06-03T14:50:39Z

/lgtm

lpettyjo

A few small comments. Otherwise, LGTM!

lpettyjo · 2025-06-03T19:38:06Z

modules/hcp-custom-kubeapi.adoc

+
+* To replace the user-facing TLS certificate with one from a public CA without breaking the control plane functions that are bound to the internal root CA
+* To support split-horizon DNS and NAT scenarios
+* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration


Suggested change

* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration

* To ensure a similar experience to standalone control planes, where you can use functions, such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration

lpettyjo · 2025-06-03T19:38:20Z

modules/hcp-custom-kubeapi.adoc

+
+* To replace the user-facing TLS certificate with one from a public CA without breaking the control plane functions that are bound to the internal root CA
+* To support split-horizon DNS and NAT scenarios
+* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration


Suggested change

* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration

* To ensure a similar experience to standalone control planes, where you can use functions, such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration

lpettyjo · 2025-06-03T19:38:55Z

modules/hcp-custom-kubeapi.adoc

+* To support split-horizon DNS and NAT scenarios
+* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration
+
+In order to define a DNS name, you insert a domain name in the `kubeAPIServerDNSName` field of a `HostedCluster` object. You can define the name either during your initial setup or during day-2 operations.


Suggested change

In order to define a DNS name, you insert a domain name in the `kubeAPIServerDNSName` field of a `HostedCluster` object. You can define the name either during your initial setup or during day-2 operations.

To define a DNS name, insert a domain name in the `kubeAPIServerDNSName` field of a `HostedCluster` object. You can define the name either during your initial setup or during day-2 operations.

modules/hcp-custom-kubeapi.adoc

lahinson · 2025-06-04T15:00:30Z

Thanks for the review, @lpettyjo!

jparrill

/lgtm

wewang58 · 2025-06-05T01:08:11Z

modules/hcp-custom-dns.adoc

+This process does not directly affect the data plane, so no rollouts are expected to occur. The `HostedControlPlane` namespace receives the changes from the HyperShift Operator and deletes the corresponding fields.
+====
+
+If you remove the `kubeAPIServerDNSName` field from the specification, all newly generated secrets and the `CustomKubeconfig` reference are removed from the cluster and from the `status` field.


How about replacing "the specification" with " the specification for the HostedCluster object"?

Good suggestion -- it's better to be clear. I'll make that update. Thanks!

wewang58 · 2025-06-05T01:09:19Z

/lgtm

openshift-ci · 2025-06-05T14:02:40Z

@lahinson: all tests passed!

Full PR test history. Your PR dashboard.

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.

wewang58 · 2025-06-06T02:44:00Z

/lgtm

bergerhoffer · 2025-06-16T18:41:49Z

The branch/enterprise-4.20 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.19. And any PR going into main must also target the latest version branch (enterprise-4.20).

If the update in your PR does NOT apply to version 4.20 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

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

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch 2 times, most recently from e366ae8 to 06237a7 Compare June 2, 2025 14:39

lahinson added the branch/enterprise-4.19 label Jun 2, 2025

lahinson closed this Jun 2, 2025

lahinson reopened this Jun 2, 2025

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch 2 times, most recently from a81e330 to 41adc52 Compare June 2, 2025 17:50

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 2, 2025

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch from 41adc52 to 2234f54 Compare June 2, 2025 17:51

openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 2, 2025

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch 3 times, most recently from 3ea96ea to 246f1fb Compare June 2, 2025 20:21

jparrill reviewed Jun 3, 2025

View reviewed changes

modules/hcp-custom-kubeapi.adoc Outdated Show resolved Hide resolved

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch from 246f1fb to efcfc8f Compare June 3, 2025 13:43

jparrill reviewed Jun 3, 2025

View reviewed changes

openshift-ci bot assigned jparrill Jun 3, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 3, 2025

lahinson changed the title ~~[OSDOCS-14539]: Custom KubeAPI name~~ [OSDOCS-14539]: Custom DNS name Jun 3, 2025

openshift-ci bot assigned jiezhao16 Jun 3, 2025

lahinson added this to the Continuous Release milestone Jun 3, 2025

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

lpettyjo 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 Jun 3, 2025

lpettyjo self-requested a review June 3, 2025 19:35

lpettyjo removed their request for review June 3, 2025 19:36

lpettyjo reviewed Jun 3, 2025

View reviewed changes

lpettyjo 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 Jun 3, 2025

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch from efcfc8f to a45a4a8 Compare June 4, 2025 15:00

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 4, 2025

lahinson added the ok-to-merge label Jun 4, 2025

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch from a45a4a8 to 379d108 Compare June 4, 2025 16:09

jparrill approved these changes Jun 4, 2025

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 4, 2025

lahinson removed the ok-to-merge label Jun 4, 2025

wewang58 reviewed Jun 5, 2025

View reviewed changes

openshift-ci bot assigned wewang58 Jun 5, 2025

[OSDOCS-14539]: Custom KubeAPI name

465d90b

lahinson force-pushed the osdocs-14539-hcp-customized-dns branch from 379d108 to 465d90b Compare June 5, 2025 13:53

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 5, 2025

lahinson added the ok-to-merge label Jun 5, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 6, 2025

bergerhoffer added the branch/enterprise-4.20 label Jun 16, 2025

	* To ensure a similar experience to standalone control planes, where you can use functions such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration
	* To ensure a similar experience to standalone control planes, where you can use functions, such as the "Show Login Command" function with the correct `kubeconfig` and DNS configuration

	In order to define a DNS name, you insert a domain name in the `kubeAPIServerDNSName` field of a `HostedCluster` object. You can define the name either during your initial setup or during day-2 operations.
	To define a DNS name, insert a domain name in the `kubeAPIServerDNSName` field of a `HostedCluster` object. You can define the name either during your initial setup or during day-2 operations.

[OSDOCS-14539]: Custom DNS name #94090

Are you sure you want to change the base?

[OSDOCS-14539]: Custom DNS name #94090

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

jparrill left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jparrill left a comment

Choose a reason for hiding this comment

Uh oh!

jiezhao16 commented Jun 3, 2025

Uh oh!

lpettyjo left a comment

Choose a reason for hiding this comment

Uh oh!

lpettyjo Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

lpettyjo Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

lpettyjo Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lahinson commented Jun 4, 2025

Uh oh!

jparrill left a comment

Choose a reason for hiding this comment

Uh oh!

wewang58 Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

lahinson Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

wewang58 commented Jun 5, 2025

Uh oh!

openshift-ci bot commented Jun 5, 2025

Uh oh!

wewang58 commented Jun 6, 2025

Uh oh!

bergerhoffer commented Jun 16, 2025

Uh oh!

Uh oh!

lahinson commented Jun 2, 2025 •

edited

Loading

ocpdocs-previewbot commented Jun 2, 2025 •

edited

Loading