DEV-15159 update readme and example name (#21)

Author: Tamr-Frank

README.md

@@ -3,68 +3,33 @@ This modules launches and configures a tamr VM in gcp. If all the inputs are giv
 This repo follows the [terraform standard module structure](https://www.terraform.io/docs/modules/index.html#standard-module-structure).
 
 # Examples
-This example just outputs a basic tamr configuration file
-```
-locals {
-  gcp_project = "tamr-deployment"
-  default_region = "us-east1"
-  default_zone = "us-east1-b"
-}
-
-module "sample" {
-  source = "../"
-  # bigtable config
-  tamr_bigtable_project_id  = local.gcp_project
-  tamr_bigtable_instance_id = "tamr-bigtable-instance"
-  tamr_bigtable_cluster_id  = "TAMR_BIGTABLE_CLUSTER_ID"
-  tamr_bigtable_min_nodes   = 1
-  tamr_bigtable_max_nodes   = 10
-  # dataproc
-  tamr_dataproc_project_id = local.gcp_project
-  tamr_dataproc_bucket     = "tamr_dataproc_home"
-  tamr_dataproc_region     = local.default_region
-  # dataproc_cluster_config
-  tamr_dataproc_cluster_subnetwork_uri  = "projects/${local.gcp_project}/regions/${local.default_region}/subnetworks/default"
-  tamr_dataproc_cluster_service_account = "tamr-instance@${local.gcp_project}.iam.gserviceaccount.com"
-  tamr_dataproc_cluster_zone            = local.default_zone
-  # cloud sql
-  tamr_cloud_sql_project  = local.gcp_project
-  tamr_cloud_sql_location = local.default_region
-  tamr_cloud_sql_name     = "tamr-db"
-  tamr_sql_user           = "tamr"
-  tamr_sql_password       = "super_secure_password"
-  # filesystem
-  tamr_filesystem_bucket = "tamr_application_home"
-}
-
-output "tamr_config" {
-  value = module.sample.tamr_config_file
-}
-```
+## Minimal
+Smallest complete fully working example. This example might require extra resources to run the example.
+- [Minimal](https://github.com/Datatamer/terraform-gcp-tamr-vm/tree/master/examples/minimal)
 
 # Resources Created
 This modules creates:
-* a null resource
+* a VM instance in order to run Tamr
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.0.0 |
-| google | >= 4.6.0 |
+| google | >= 4.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| google | >= 4.6.0 |
+| google | >= 4.0 |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| tamr\_config\_file | full tamr config file | `string` | n/a | yes |
+| tamr\_config\_file | Override generated tamr configuration. The tamr configuration is specified using a yaml file, in the format that is documented (https://docs.tamr.com/previous/docs/configuration-configuring-unify#section-setting-configuration-variables) for configuring “many variables” at once. | `string` | n/a | yes |
 | tamr\_filesystem\_bucket | GCS bucket to use for the tamr default file system | `string` | n/a | yes |
 | tamr\_instance\_image | Image to use for boot disk | `string` | n/a | yes |
 | tamr\_instance\_project | The project to launch the tamr VM instance in. | `string` | n/a | yes |

examples/basic/README.md

@@ -0,0 +1,30 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| google | n/a |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| filesystem\_bucket | n/a | `string` | n/a | yes |
+| project\_id | n/a | `string` | n/a | yes |
+| subnet\_name | n/a | `string` | n/a | yes |
+| instance\_id | n/a | `string` | `"tamr-vm-example"` | no |
+| instance\_image | n/a | `string` | `"tamr-private-images/bionic-base-1644877703"` | no |
+| region\_id | n/a | `string` | `"us-east1"` | no |
+| service\_account | n/a | `string` | `""` | no |
+| zip\_url | n/a | `string` | `"gs://tamr-releases/v2022.005.0/unify.zip"` | no |
+| zone\_id | n/a | `string` | `"us-east1-b"` | no |
+
+## Outputs
+
+No output.
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/minimal/README.md

@@ -4,7 +4,7 @@ data "google_compute_subnetwork" "project_subnet" {
   project = "tamr-networking"
 }
 
-module "sample" {
+module "minimal" {
   source = "../../"
 
   tamr_instance_project         = var.project_id