search

awslabs / aws-saas-boost

AWS SaaS Boost is a ready-to-use toolset that removes the complexity of successfully running SaaS workloads in the AWS cloud.
Apache License 2.0
960 stars 188 forks source link

Tenant onboarding failure should include CFN template failure reasons #86

Open PoeppingT opened 3 years ago

PoeppingT commented 3 years ago

Currently when tenant onboarding fails, no information is provided in the SaaS Boost UI or via the SaaS Boost APIs as to why: a user needs to go to CloudFormation in their AWS account to do the investigation themselves. To make SaaS Boost easier to use (and more "boosted") SaaS Boost should be able to return the stack failure reason provided by CloudFormation and ideally provide some suggestions for fixing the issue.

Use Case

Any tenant onboarding failure would be easier to debug with this feature.

Proposed Solution

Boost already tracks the created stack ARN for each tenant. Using the describeStacks API, Boost can track down to the nested stack failure reason by calling the stackStatusReason() function as part of the Stack class.

Other

This is a :rocket: Feature Request

PoeppingT commented 3 years ago

Note this is only if AppConfig validation doesn't catch the error, e.g. if the SSL ARN is of a valid format but doesn't exist

aiavci commented 2 years ago

Are there any manual steps that can be documented for this in the meantime? The build sometimes takes about 30 minutes in the "Deploying" state, then fails with no description

PoeppingT commented 2 years ago

Hi aiavci@, each tenant onboarding workflow is executed via the tenant-onboarding.yaml CloudFormation template. To view the stack failure reasons, you only need to inspect the "Events" tab for that CloudFormation stack in your AWS Console to view failure reasons.