Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 2007783

Summary: [DOC] Inconsistency and corrections common to multiple UPI pages (GCP/Azure, possibly others)
Product: OpenShift Container Platform Reporter: To Hung Sze <tsze>
Component: DocumentationAssignee: Kelly Brown <kelbrown>
Status: CLOSED CURRENTRELEASE QA Contact: MayXu <maxu>
Severity: low Docs Contact: Latha S <lmurthy>
Priority: low    
Version: 4.9CC: aos-bugs, kelbrown, lmurthy, maxu
Target Milestone: ---Flags: maxu: needinfo-
Target Release: 4.8.z   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-05-16 12:25:56 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description To Hung Sze 2021-09-24 20:43:50 UTC
Document URL: 
e.g.

https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html


Section Number and Name: 

Describe the issue: 
There are a few places that are inconsistent and shared between pages:

1. ./oc vs oc
https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html

uses ./openshift-install --dir=<installation_directory> wait-for install-complete 

but other places we just use oc

2 tar command missing - switch
https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#installation-obtaining-installer_installing-azure-user-infra

shows
tar xvf openshift-install-linux.tar.gz

should be
tar -xvf openshift-install-linux.tar.gz

3
https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#ssh-agent-using_installing-azure-user-infra

We give example of
ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 

but later on, we show results of
cat ~/.ssh/id_rsa.pub


Suggestions for improvement: 
Be consistent for #1.
If possible, give corresponding example for #3.

Comment 3 Kelly Brown 2022-04-04 17:07:22 UTC
Hello! Quick question, for #1, I can not seem to find instances where oc is used instead. Which sections are you referencing?

Comment 4 To Hung Sze 2022-04-04 17:25:36 UTC
https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#installation-initializing_installing-azure-user-infra uses 
./openshift-install create install-config --dir <installation_directory> 

Rest of the page, when referring to the oc command, like this: https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#cli-installing-cli_installing-azure-user-infra , uses
oc <command>

To be consistent, we either all use "./" or all skip "./".

Hope it helps.

Comment 5 MayXu 2022-04-06 04:41:00 UTC
@tsze 
for #2
tar xvf openshift-install-linux.tar.gz
and 
tar -xvf openshift-install-linux.tar.gz
both are accepted. 

for #3 
expect:
.ssh/id_ed25519.pub

Comment 6 To Hung Sze 2022-04-11 13:07:47 UTC
Is the "need info" from me for #2?
If yes, sure, we can ignore #2.

Thanks.

Comment 7 Kelly Brown 2022-04-26 17:46:29 UTC
@tsze
Hello! My apologies for the delay. 

In step 5 of this doc (https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#cli-installing-cli_installing-azure-user-infra) it directly states for the user to “Place the oc binary in a directory thats on your PATH”. Since this step is telling the user to place the binary directly, I believe there is no need to put the ./oc <command> here. ./oc makes sense on its own, but in the context of the procedure, I believe not having ./oc <command> is correct.

Same thing in this procedure with the ./openshift-install --dir=<installation_directory> wait-for install-complete 
 command (https://docs.openshift.com/container-platform/4.8/installing/installing_azure/installing-azure-user-infra.html#installation-initializing_installing-azure-user-infra), the use of ./ aligns with the step in the procedure.

Please reach out to me though if there are any questions or if my information is incorrect, Thank you! 


@MayXu 
Is the .ssh/id_ed25519 the expected output for command: cat ~/.ssh/id_rsa.pub?

Comment 10 Kelly Brown 2022-04-27 14:58:31 UTC
Hello, thank you for the updates! 
I just made this PR with the changes, PTAL: https://github.com/openshift/openshift-docs/pull/45034