search

aws-samples / service-catalog-engine-for-terraform-os

Apache License 2.0
128 stars 40 forks source link

Re-ordering the content of README.md file or Providing a Note Banner #47

Open RoshTech opened 1 year ago

RoshTech commented 1 year ago

Hi Team,

I would like to propose a minor change in the order of content in the README..md file or creating a Note Banner on top.

As Service Catalog now supports Terraform Open Source engine, the errors generated during provisioning a product can be confusing as to what is generating this error, is the error from the AWS Service Catalog or the Terraform engine.

The Architecture Overview provides the insight on how Service Catalog works with Terraform open source engine, and mentions that "The creation and management of resources will be done using Terraform Open Source running on EC2 instances."

Also, the third point under "What Is a TERRAFORM_OPEN_SOURCE Product Engine?" mentions that the terraform engine calls back to Service Catalog to report results.

Hence, it would be informative to summarize the three points under "What Is a TERRAFORM_OPEN_SOURCE Product Engine?" on top of the page before installation steps or a NOTE banner to let the users know that the info/error/warning logs during create/update/terminate is generated by engine.

smaly-amazon commented 1 year ago

Thanks for this suggestion. We will consider making this change in the future.