Ogarrett patch 1 (#395)

notes from installing the sandbox environment recently...

Author: ogarrett

README.md

@@ -236,7 +236,105 @@ For a quicker destroy for development purposes, you can:
   as it does _not_ have the shared DNS suffix (gcp.sandbox.tetrate.io). In this case a public DNS zone will be
   created in the project for the configured DNS domain.
 
-### Repository structure
+## Troubleshooting
+
+### Error: Invalid provider configuration
+
+If you have an empty `aws` block (`"aws": []`), you may see the error:
+
+```text
+Error: Invalid provider configuration
+│
+│ Provider "registry.terraform.io/hashicorp/aws" requires explicit configuration. Add a provider block to the root
+│ module and configure the provider's required arguments as described in the provider documentation.
+```
+
+Follow the steps [here](https://stackoverflow.com/a/75626789); the easiest option is to `export AWS_REGION=eu-central-1`
+
+### Error: no matching Route 53 Hosted Zone found
+
+If you see the following error:
+
+```text
+Error: no matching Route 53 Hosted Zone found
+│
+│   with module.register_fqdn.data.aws_route53_zone.zone,
+│   on ../../../modules/aws/register_fqdn/main.tf line 1, in data "aws_route53_zone" "zone":
+│    1: data "aws_route53_zone" "zone" {
+```
+
+... check that the DNS name (for example `yourname.sandbox.tetrate.io`) can be managed from your AWS account.  You may need to select a different DNS root.
+
+### Error: Error in function call
+
+If you see the following error:
+
+```text
+Error: Error in function call
+│
+│   on ../../modules/aws/base/main.tf line 93, in resource "local_file" "aws_cleanup":
+│   93:     name_prefix   = regex("^\\w+-\\d", "${var.name_prefix}")
+│     ├────────────────
+│     │ while calling regex(pattern, string)
+│     │ var.name_prefix is "owen-two-0-njtu"
+```
+
+... ensure that the **name_prefix** only contains letters, numbers and underscores.
+
+### Error: No such file or directory
+
+If you see the following error:
+
+```text
+terraform output -json | jq . > ../../outputs/terraform_outputs/terraform-aws-owen1-eu-west-1-0.json
+/home/owen/src/one/tetrate-service-bridge-sandbox/make/helpers.sh: line 19: ../../outputs/terraform_outputs/terraform-aws-owen1-eu-west-1-0.json: No such file or directory
+```
+
+... create the directory (`mkdir outputs/terraform_outputs`) and repeat.
+
+### Error: Unable to find remote state
+
+If you see the following error when deploying the `tsb_mp` on EKS:
+
+```text
+Error: Unable to find remote state
+│
+│   with data.terraform_remote_state.k8s_auth,
+│   on main.tf line 8, in data "terraform_remote_state" "k8s_auth":
+│    8: data "terraform_remote_state" "k8s_auth" {
+│
+│ No stored state was found for the given workspace in the given backend.
+```
+
+... make sure to `export AWS_REGION=eu-west-2`, using the correct region.
+
+### Error: Failed to read variables file
+
+If you see the following error when deploying the `tsb_mp`:
+
+```text
+pushd tsb/fqdn/ > /dev/null
+
+.....
+╷
+│ Error: Failed to read variables file
+│
+│ Given variables file ../../../terraform.tfvars.json does not exist.
+```
+
+... the detection of the DNS provider has failed.  Add the following to your `terraform.tfvars.json`:
+
+```yaml
+    "tetrate": {
+        "dns_provider" : "aws"
+
+    }
+}
+```
+
+Valid values are `gcp`, `aws`, `azure`.
+
+## Repository structure
 
 | Directory | Description |
 | --------- | ----------- |