Bug 1865758
| Summary: | [DOC] Missing AMI & KMS parameter description in AWS installation documents | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Yunfei Jiang <yunjiang> |
| Component: | Documentation | Assignee: | James Brigman <jbrigman> |
| Status: | CLOSED DEFERRED | QA Contact: | Yunfei Jiang <yunjiang> |
| Severity: | medium | Docs Contact: | Latha S <lmurthy> |
| Priority: | medium | ||
| Version: | 4.6 | CC: | aos-bugs, jbrigman, kalexand, lmurthy |
| Target Milestone: | --- | Keywords: | Reopened |
| Target Release: | 4.9.0 | ||
| 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: | 2023-03-09 00:58:55 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
Yunfei Jiang
2020-08-04 04:44:00 UTC
Hello James, any updates regarding this bug? Yunfei - thank you for asking. I have enough information to generate half the desired information, I'm working on generating the other half. I expect to provide further update on my Tuesday workday. This is an urgent BZ for me, it is part of the supportability work our team is doing to help with caseload. Yunfei - Here is the text I plan to update the table with - I request your review please.
compute.platform.aws.rootVolume.amiID AMIID is the AMI that should be used to boot
the ec2 instance. If set, the AMI should
belong to the same region as the cluster. Valid AWS AMI of type <string>.
compute.platform.aws.rootVolume.kmsKeyARN The KMS key that will be used to encrypt the EBS volume.
If no key is provided the default KMS key for the
account will be used. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetEbsDefaultKmsKeyId.html Valid AWS kmsKeyId type <string>.
controlPlane.platform.aws.amiID AMIID is the AMI that should be used to boot
the control plane machines. If set, the AMI
should belong to the same region as the cluster. Valid AWS AMI of type <string>.
controlPlane.platform.aws.kmsKeyARN The KMS key that will be used to encrypt the controlPlane. Valid AWS kmsKeyId type <string>.
If no key is provided the default KMS key for the account
will be used.
https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetEbsDefaultKmsKeyId.html
PLEASE NOTE: I took this text from the installer, but after reading https://issues.redhat.com/browse/CORS-1401, it appears I should also say that these values can all be different, since that's the reason for CORS-1401.
The PR for this change is here: https://github.com/openshift/openshift-docs/pull/31856 Yunfei, will you PTAL? Hello James, thanks for you updates, I just added some comments in PR, PTAL, thanks. Hello and Good Morning/Good Day Yunfei! I let this BZ sit because Matthew Staebler introduced an entirely different way of looking at the issue, however, I did not have a chance to follow up with him before he went on leave for awhile. In that time, the 4.5 release went out of support and bugs for only 4.5 have been closed. Therefore, I am following up with you to find out if you agree that this BZ should be closed. PTAL, the original PR is at: https://github.com/openshift/openshift-docs/pull/31856 (You can see matthew's comments in this PR that caused me to pause.) Thank you so much for your time, I kindly await your answer, sir. James Brigman OpenShift Technical Writer. James, Although the PR is for 4.5 only, this issue may apply to 4.6+, so re-open this bug and setting Target Release to 4.9, you could backport to 4.6-4.8 in PR, WDTY? Thanks! Hello Yunfei - I checked other OCP docs versions as you suggested and yes, they need update of three missing parameters: compute.platform.aws.rootVolume.amiID compute.platform.aws.rootVolume.kmsKeyARN (controlPlane.platform.aws.amiID NO: this has been added to the table already) controlPlane.platform.aws.kmsKeyARN The table has become "Table 4. Optional AWS parameters" These are needed for the tables in 4.6, 4.7. 4.8, 4.9 and 4.10. Do you agree? Thank you - James Brigman James, yes, should be applied for 4.6-4.10, thanks. Hello Latha - the SME I was working with on this issue was Matthew Staebler. Matthew has left the company. So I need to locate the SME who replaced him. I will check on this today. I would prefer to have the result reviewed by whoever replaced Matthew. 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-8790 |