Bug 1613765 - [DOCS] Deprecated openshift_hostname Variable, still listed Configuring Host Variables
Summary: [DOCS] Deprecated openshift_hostname Variable, still listed Configuring Host ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.10.0
Hardware: x86_64
OS: Linux
high
medium
Target Milestone: ---
: ---
Assignee: Kathryn Alexander
QA Contact: Johnny Liu
Vikram Goyal
URL:
Whiteboard:
: 1572859 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-08-08 10:16 UTC by Paul Dwyer
Modified: 2022-03-13 15:22 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-11-05 17:00:03 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Knowledge Base (Solution) 3628511 0 None None None 2018-09-27 14:06:40 UTC

Description Paul Dwyer 2018-08-08 10:16:58 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.10/release_notes/ocp_3_10_release_notes.html#ocp-310-notable-technical-changes

&

https://docs.openshift.com/container-platform/3.10/install/configuring_inventory_file.html#configuring-host-variables

Describe the issue: 
In release notes for 3.10 we note that openshift_hostname variable is remove under heading "Deprecated openshift_hostname Variable"
This in itself is confusing is it deprecated and will be removed in future or has it been removed.

To further add to the confusion there is no mention of deprecation/removal in the configuring host variables section
https://docs.openshift.com/container-platform/3.10/install/configuring_inventory_file.html#configuring-host-variables

Suggestions for improvement: 
Clarify deprecation vs removal (I believe it is removed)

Either remove openshift_hostname variable from Host variables table or refer back to the release notes where deprecation/removal is noted.

Comment 1 Sergio G. 2018-08-08 11:40:12 UTC
Also note that [1] seems to tell the user to use it openshift_hostname to override the default hostname and provides a warning about what to set on it.

That part especially should be clear to not confuse users when installing configurations for cloud providers.

[1] https://docs.openshift.com/container-platform/3.10/install/prerequisites.html#overriding-detected-ip-addresses-host-names

Comment 3 Kathryn Alexander 2018-08-08 16:19:23 UTC
Here's an in-process PR: https://github.com/openshift/openshift-docs/pull/11430/files

- I've removed all the non-deprecation references to the openshift_hostname variable.
- I've updated some of the language in the notes to be more specific.

Comment 5 Vikram Goyal 2018-08-09 05:41:18 UTC
*** Bug 1572859 has been marked as a duplicate of this bug. ***

Comment 11 Kathryn Alexander 2018-10-17 20:59:22 UTC
Michael provided new info based on his changes here: https://github.com/openshift/openshift-ansible/pull/10392/files


There are two doc PRs now, and both are required to fully address this change.

The information in https://github.com/openshift/openshift-docs/pull/11430/files still applies to 3.10 and 3.11.

I made a new PR with information for only 3.10 to update the 3.9-3.10 upgrade here: https://github.com/openshift/openshift-docs/pull/12539

Comment 12 Johnny Liu 2018-10-25 08:58:24 UTC
Leave comments in the both PR.

Comment 13 Kathryn Alexander 2018-10-30 15:48:56 UTC
Jianlin, will you PTAL at https://github.com/openshift/openshift-docs/pull/11430 again? Jia approved the other PR.

Comment 14 Johnny Liu 2018-10-31 02:03:30 UTC
LGTM

Comment 15 openshift-github-bot 2018-10-31 15:46:12 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/35a7f96f39db815b6179239cba581b20022bc51c
bug 1613765 updating openshift_hostname information

https://github.com/openshift/openshift-docs/commit/cf071568042441535b62143f80c0a564400beb45
Merge pull request #11430 from kalexand-rh/BZ1613765

bug 1613765 updating openshift_hostname information

Comment 17 openshift-github-bot 2019-01-02 18:11:16 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/2110ba07550431ac119c80e9735801bc09c0b44b
bug 1613765 hostname changes for 3.10-3.11 upgrade

https://github.com/openshift/openshift-docs/commit/ec18609bde97db7850fb3293995a73c2d13dcb5c
Merge pull request #12639 from kalexand-rh/BZ1613765-3.11

bug 1613765 hostname changes for 3.10-3.11 upgrade


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