Feature Overview (aka. Goal Summary)  

As a customer, I should be provided with meaningful and actionable error messages when my cluster installation fails. The error messages should indicate why the failure happened and, if it is an issue at my end, how I can resolve it to successfully provision a new cluster.
 

Goals (aka. expected user outcomes)

• Include documentation links within error messages
• Include KCS article links within error messages

The observable functionality that the user now has as a result of receiving this feature. Complete during New status.

Requirements (aka. Acceptance Criteria):

• Review existing error messages in OCM
• Improve the error message based on discussion with Docs and UX teams
• Reference docs links in error messages and bubble those up in the UI and CLI outputs
• Include links to KCS articles for error messages where we have them
• Create KCS articles for additional error messages where applicable

KCS articles created for OCM errors:

• CLUSTERS-MGMT-400 : AWSCredsNotOSDCCSAdmin | KCS: https://access.redhat.com/solutions/6960534
• OCM3019 : AWSNATGatewayLimitExceeded | KCS: https://access.redhat.com/solutions/6869901
• OCM3008 : AWSAPIRateLimitExceeded | KCS: https://access.redhat.com/solutions/6989733
• OCM3014: S3BucketsLimitExceeded | KCS: https://access.redhat.com/solutions/6989740
• OCM3052: AWSInsufficientCapacity | KCS: https://access.redhat.com/solutions/6989719
• OCM3013: AWSVPCLimitExceeded | KCS: https://access.redhat.com/solutions/6990097
• OCM3021 : PendingVerification | KCS: https://access.redhat.com/solutions/6990100
• OCM3036 : LoadBalancerLimitExceeded | KCS: https://access.redhat.com/solutions/6990087
• OCM3020 : InvalidInstallConfigSubnet | KCS: https://access.redhat.com/solutions/6991393
• OCM3049 : MultipleRoute53ZonesFound | KCS: https://access.redhat.com/solutions/6995974
• OCM3042 : AWSEC2QuotaExceeded | KCS: https://access.redhat.com/solutions/6995931
• OCM3031 : ErrorDeletingIAMRole | KCS: https://access.redhat.com/solutions/6996152
• OCM3033 : AWSInsufficientPermissions | KCS: https://access.redhat.com/solutions/6996282
• OCM3032: AWSSubnetDoesNotExist | KCS: https://access.redhat.com/solutions/6996351
• TooManyRoute53Zones : OCM3006 | KCS: https://access.redhat.com/solutions/6999985
• OCM3055: Client.InvalidKMSKey | KCS: https://access.redhat.com/solutions/7048553
  {{}}

Use Cases (Optional):

Include use case diagrams, main success scenarios, alternative flow scenarios.  Initial completion during Refinement status.

Questions to Answer (Optional):

Include a list of refinement / architectural questions that may need to be answered before coding can begin.  Initial completion during Refinement status.

Out of Scope

High-level list of items that are out of scope.  Initial completion during Refinement status.

Background

Provide any additional context is needed to frame the feature.  Initial completion during Refinement status.

Customer Considerations

Provide any additional customer-specific considerations that must be made when designing and delivering the Feature.  Initial completion during Refinement status.

Documentation Considerations

Provide information that needs to be considered and planned so that documentation will meet customer needs.  Initial completion during Refinement status.

Interoperability Considerations

Which other projects and versions in our portfolio does this feature impact?  What interoperability test scenarios should be factored by the layered products?  Initial completion during Refinement status.