Bug 2071475 - Typos in the steps to create IAM Manually
Summary: Typos in the steps to create IAM Manually
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.10
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.7.z
Assignee: Jesse Dohmann
QA Contact: Yunfei Jiang
Latha S
URL:
Whiteboard: CEE.neXT
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-04-04 01:56 UTC by Apoorva Jagtap
Modified: 2023-03-09 01:16 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-03-09 01:16:35 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Apoorva Jagtap 2022-04-04 01:56:26 UTC
Document URL: https://docs.openshift.com/container-platform/4.10/installing/installing_aws/manually-creating-iam.html#manually-create-iam_manually-creating-iam-aws

Section Number and Name: Manually create IAM (Step 4)

Describe the issue: 
We have the following section added as step 4 in the doc, which is a bit confusing due to some typos and the sequence in which this step is:
~~~
4. Copy the generated credential files to the target manifests directory:

$ cp ./<path_to_ccoctl_output_dir>/manifests/*credentials.yaml ./<path_to_installation>dir>/manifests/
where:

<path_to_ccoctl_output_dir>
Specifies the directory created by the `ccoctl alibabacloud create-ram-users` command.

<path_to_installation>dir>
Specifies the directory in which the installation program creates files.
~~~

Suggestions for improvement: 

1. Shouldn't "ccoctl alibabacloud create-ram-users" be replaced with "ccoctl aws create-iam-roles/create-all" as the doc falls within 'Installing on AWS'?
2. <path_to_installation>dir> needs to be changed to <path_to_installation_dir>
3. It seems that placing step 4 after step 6 would be a better sequence.

Additional information: 
https://coreos.slack.com/archives/C011MLLLY4W/p1648710374116369

Comment 2 Jesse Dohmann 2022-04-05 21:43:49 UTC
This procedure applies to multiple platforms, so it's likely an issue with `ifdef` statements, I'll take a look

Comment 3 Jesse Dohmann 2022-04-06 16:33:09 UTC
PR is here: https://github.com/openshift/openshift-docs/pull/44248

Comment 4 Shiftzilla 2023-03-09 01:16:35 UTC
OpenShift has moved to Jira for its defect tracking! This bug can now be found in the OCPBUGS project in Jira.

https://issues.redhat.com/browse/OCPBUGS-9203


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