Bug 1956481 - Machineset location value hardcoded within the example
Summary: Machineset location value hardcoded within the example
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.6.z
Assignee: Kelly Brown
QA Contact: Guohua Ouyang
Latha S
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-05-03 18:47 UTC by Filipe
Modified: 2021-10-29 16:35 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-10-29 16:35:13 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
inspect file used to investigate (1.91 MB, application/gzip)
2021-05-03 18:47 UTC, Filipe
no flags Details

Description Filipe 2021-05-03 18:47:27 UTC
Created attachment 1779082 [details]
inspect file used to investigate

Document URL: 
https://docs.openshift.com/container-platform/4.7/machine_management/creating_machinesets/creating-machineset-azure.html#machineset-yaml-azure_creating-machineset-azure

Section Number and Name: 
Location

Describe the issue: 
When customers are copying the example template file to create a new machineset within Azure cloud, the location field is not labeled with a "number" therefore customers are no thinking that the value should be replaced and leaving the default centralus.


Suggestions for improvement: 
within the template file, I would replace the following:
...
          location: centralus
...
with:
...
          location: <region> 5
...

and under the example, I would also add the following information:
5: Specify your region to place Machines on.

Additional information: 

I also have confirmed that the documentation for ocp 4.6 must also be updated to reflect the change.

Comment 2 Kelly Brown 2021-10-28 14:13:53 UTC
PR for changes: https://github.com/openshift/openshift-docs/pull/38111


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