Bug 1852798 - [DOCS] UPI installation docs contain instructions to create etcd DNS records that are not required in 4.4+
Summary: [DOCS] UPI installation docs contain instructions to create etcd DNS records ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.8
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: 4.11.z
Assignee: Shubha Narayanan
QA Contact: Pedro Amoedo
Latha S
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-07-01 10:38 UTC by Jose Ignacio Jerez
Modified: 2023-10-06 20:56 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-11-15 07:01:41 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift installer pull 5764 0 None Merged Removing no-longer-needed DNS etcd stuff 2022-04-11 15:38:50 UTC
Red Hat Bugzilla 1964380 1 medium CLOSED [DOC] Remove the etcd DNS records from the Azure ARM templates 2022-01-06 16:26:10 UTC

Internal Links: 1964380

Description Jose Ignacio Jerez 2020-07-01 10:38:46 UTC
Document URL: 

https://docs.openshift.com/container-platform/4.4/installing/installing_aws/installing-aws-user-infra.html

Section Number and Name: 

Required DNS and load balancing components

CloudFormation template for control plane machines

Describe the issue: 

With the addition of cluster-etcd-operator in 4.4 we no longer have a dependency on DNS for etcd.

The documentation for UPI installation on AWS still contains instruction on how to create these DNS records (A and SRV), in particular the cloud formation templates will create them.

Suggestions for improvement: 

Remove the instructions to create the etcd DNS records during installation

Additional information: 

These is not a serios issue because even if the DNS records are created, they will not be used and there is no impact on the OCP cluster, however this is confusing for some customers.

Comment 1 Rejeeb 2020-07-28 03:54:48 UTC
Also in the following installation docs, it is mentioned that:
---
For each control plane machine, OpenShift Container Platform also `requires a SRV DNS record` for etcd server on that machine with priority 0, weight 10 and port 2380. 
---

However, etcd DNS records are not required in Openshift v4.4 and above as the new etcd cluster operator makes these DNS records obsolete. Here is the list of pull requests implemented in OpenShift 4.4:

 [Bug 1813003: etcd: remove etcd DNS entries because etcd no longer uses DNS #3265]
 - https://github.com/openshift/installer/pull/3265

 [Bug 1811071: remove dns lookups #233]
 - https://github.com/openshift/cluster-etcd-operator/pull/233


https://docs.openshift.com/container-platform/4.4/installing/installing_vsphere/installing-vsphere.html
https://docs.openshift.com/container-platform/4.4/installing/installing_vsphere/installing-vsphere-network-customizations.html
https://docs.openshift.com/container-platform/4.4/installing/installing_vsphere/installing-restricted-networks-vsphere.html
https://docs.openshift.com/container-platform/4.4/installing/installing_ibm_power/installing-ibm-power.html
https://docs.openshift.com/container-platform/4.4/installing/installing_ibm_power/installing-restricted-networks-ibm-power.html
https://docs.openshift.com/container-platform/4.4/installing/installing_ibm_z/installing-ibm-z.html
https://docs.openshift.com/container-platform/4.4/installing/installing_ibm_z/installing-restricted-networks-ibm-z.html
https://docs.openshift.com/container-platform/4.4/installing/installing_bare_metal/installing-bare-metal.html
https://docs.openshift.com/container-platform/4.4/installing/installing_bare_metal/installing-bare-metal-network-customizations.html
https://docs.openshift.com/container-platform/4.4/installing/installing_bare_metal/installing-restricted-networks-bare-metal.html

Comment 5 Pedro Amoedo 2021-03-26 15:29:19 UTC
[QA FAILED] (moving to ASSIGNED)

Please see my comments within PR#30950[1], there are more things to modify/remove from the documentation like the control plane cloudformation template extra stuff.

That template is based on the default one provided by Engineering here[2], therefore I've raised PR#4795[3] so they can confirm first if my proposed changes are correct.

[1] - https://github.com/openshift/openshift-docs/pull/30950 
[2] - https://github.com/openshift/installer/blob/master/upi/aws/cloudformation/05_cluster_master_nodes.yaml
[3] - https://github.com/openshift/installer/pull/4795

Best Regards.

Comment 19 Chinmayi Chandrasekhar 2021-10-19 08:31:59 UTC
@pamoedom I would like to know the status of https://github.com/openshift/installer/pull/4795 so that I can work on this bug.

Comment 20 Pedro Amoedo 2021-10-19 08:48:48 UTC
Hi Chinmayi, as you can see within openshift/installer#4795, Matthew is trying to get a successful "e2e-aws-upi" test before approving the changes, from my side I've tested them and it works as expected, not sure if there is any possibility of expediting the merge without having that test in place, I'll let Matthew to comment on that part, is not my call.

Regards.

Comment 21 Chinmayi Chandrasekhar 2021-10-19 16:03:20 UTC
Closing this bug since it is dependent on this PR: https://github.com/openshift/installer/pull/4795
Once this PR is verified and merged, the bug can be reopened.

Comment 22 Pedro Amoedo 2022-04-11 15:38:51 UTC
Hi Chinmayi, we have finally made some progress here, we have closed old/broken PR#4795[1] and pushed the definite changes via PR#5764[2].

I'm reopening this BZ and targeting 4.11, please take a look when you have a chance, thanks.

[1] - https://github.com/openshift/installer/pull/4795
[2] - https://github.com/openshift/installer/pull/5764

Comment 29 Shubha Narayanan 2022-10-31 09:52:09 UTC
@pamoedom - Does this bug still exist in Azure and GCP?

Comment 30 Pedro Amoedo 2022-11-04 13:28:23 UTC
Hi Shuba, AFAIK, for Azure and GCP, the documentation was already fixed, I can't find the GCP BZ, but here[1] you have the Azure one.

[1] - https://bugzilla.redhat.com/show_bug.cgi?id=1964380

Best Regards.

Comment 31 Shubha Narayanan 2022-11-08 05:16:27 UTC
PR - https://github.com/openshift/openshift-docs/pull/52582

Comment 32 Shubha Narayanan 2022-11-08 09:14:01 UTC
(In reply to Shubha Narayanan from comment #31)
> PR - https://github.com/openshift/openshift-docs/pull/52582

@pamoedom - Can you please help me with your review?

Comment 33 Pedro Amoedo 2022-11-09 15:12:55 UTC
Hi Shubha, those changes are not sufficient, we need to also modify the cloudformation template examples accordingly, please take a look at this[1] PR for the exact changes, thanks.

[1] - https://github.com/openshift/installer/pull/5764

Regards.

Comment 34 Shubha Narayanan 2022-11-09 15:55:41 UTC
@pamoedom - I understand that this has been discussed previously in the bug too. However, i do not see that issue anymore. The template example directly points to the repo that your PR was raised for Here's the example https://docs.openshift.com/container-platform/4.11/installing/installing_aws/installing-aws-user-infra.html#installation-cloudformation-control-plane_installing-aws-user-infra

Comment 35 Pedro Amoedo 2022-11-09 16:34:13 UTC
Yes Shubha, in 4.11 seems to be the case, but your PR mentions "Version(s): 4.8+", right?

However, if those templates are loaded directly from the installer repo (I wasn't aware), maybe we should re-target your PR for 4.11 only?

Regards.

Comment 36 Shubha Narayanan 2022-11-10 06:03:55 UTC
If the changes to installer repo was targeted only for 4.11+, I will make that change. But does that mean there are no changes required for 4.8 - 4.10 as mentioned in the bug?

Comment 37 Shubha Narayanan 2022-11-11 10:09:08 UTC
(In reply to Shubha Narayanan from comment #36)
> If the changes to installer repo was targeted only for 4.11+, I will make
> that change. But does that mean there are no changes required for 4.8 - 4.10
> as mentioned in the bug?


@pamoedom - Can you confirm that no changes are required in doc for 4.8-4.10?

Comment 38 Pedro Amoedo 2022-11-11 15:25:17 UTC
Hi Shubha, AFAIK, those changes are needed for all supported versions higher than 4.4, which in this moment means 4.8+, however, if the cloudformation templates are directly linked with the installer repository, then I'm not sure if the backport could be requested for those, quoting Matthew from PR#5764[1]:

~~~
I do not think it warrants backporting. There are no side effects of this other than some unnecessary DNS records in the private hosted zone.
~~~

In summary, let's push the changes to 4.11+ to keep the documentation homogeneous, thanks.

[1] - https://github.com/openshift/installer/pull/5764#issuecomment-1093302736


Note You need to log in before you can comment on or make changes to this bug.