Merge pull request #93 from ExpediaGroup/primary_latency_var

Added primary_metastore_latency

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.3.11] - 2021-11-03
+### Added
+- Added `primary_metastore_latency` variable.
+
 ## [3.3.10] - 2021-11-01
 ### Changed
 - Variable to configure pimary metastore mapped databases.

README.md

@@ -10,7 +10,8 @@ For more information please refer to the main [Apiary](https://github.com/Expedi
 | aws_region | AWS region to use for resources. | string | - | yes |
 | bastion_ssh_key_secret_name | Secret name in AWS Secrets Manager which stores the private key used to log in to bastions. The secret's key should be `private_key` and the value should be stored as a base64 encoded string. Max character limit for a secret's value is 4096. | string | `` | no |
 | cpu | The number of CPU units to reserve for the Waggle Dance container. Valid values can be 256, 512, 1024, 2048 and 4096. Reference: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html | string | `1024` | no |
-| default_latency | Latency used for the primary metastore, and other other metastores that don't override it in their own configurations. See `latency` parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md. | number | `0` | no |
+| default_latency | Latency used for other (not primary) metastores that don't override it in their own configurations. See `latency` parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md. | number | `0` | no |
+| primary_metastore_latency | Latency used for the primary metastores. See `latency` parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md. | number | `0` | no |
 | docker_image | Full path Waggle Dance Docker image. | string | - | yes |
 | docker_registry_auth_secret_name | Docker Registry authentication SecretManager secret name. | string | `` | no |
 | docker_version | Waggle Dance Docker image version. | string | - | yes |
@@ -71,8 +72,9 @@ module "apiary-waggledance" {
   docker_version              = "latest"
   primary_metastore_host      = "primary-metastore.yourdomain.com"
   primary_metastore_whitelist = ["test_.*", "team_.*"]
+  primary_metastore_latency   = 1000
 
-  default_latency = 2000
+  default_latency = 100
 
   remote_metastores = [
     {
@@ -139,7 +141,7 @@ local_metastores = [
       writable-whitelist    = "test"
     }
 ]
-``` 
+```
 `local_metastores` map entry fields:
 
 Name | Description | Type | Default | Required |
@@ -170,7 +172,7 @@ remote_metastores = [
       writable-whitelist    = ".*"
     }
 ]
-``` 
+```
 `remote_metastores` map entry fields:
 
 Name | Description | Type | Default | Required |
@@ -204,7 +206,7 @@ remote_region_metastores = [
       security_group_id     = "sg1
     }
 ]
-``` 
+```
 `remote_region_metastores` map entry fields:
 
 Name | Description | Type | Default | Required |
@@ -241,7 +243,7 @@ ssh_metastores = [
       database-name-mapping = "test:test_alias,default:default_alias"
     }
 ]
-``` 
+```
 `ssh_metastores` map entry fields:
 
 Name | Description | Type | Default | Required |

templates.tf

@@ -130,7 +130,7 @@ data "template_file" "federation_yaml" {
   vars = {
     primary_metastore_host             = var.primary_metastore_host
     primary_metastore_port             = var.primary_metastore_port
-    primary_metastore_latency          = var.default_latency
+    primary_metastore_latency          = var.primary_metastore_latency
     primary_metastore_whitelist        = join("", data.template_file.primary_metastore_whitelist.*.rendered)
     primary_metastore_mapped_databases = join("", data.template_file.primary_metastore_mapped_databases.*.rendered)
     local_metastores                   = join("", data.template_file.local_metastores_yaml.*.rendered)

variables.tf

@@ -248,5 +248,11 @@ variable "alluxio_endpoints" {
 variable "default_latency" {
   type        = number
   default     = 0
-  description = "HMS latency (in ms.) that Waggledance will tolerate.  See \"latency\" parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md."
+  description = "HMS latency (in ms.) that Waggledance will tolerate.  See \"latency\" parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md. This sets the default for all metastores except the primary metastore."
+}
+
+variable "primary_metastore_latency" {
+  type        = number
+  default     = 0
+  description = "HMS latency (in ms.) that Waggledance will tolerate.  See \"latency\" parameter in https://github.com/ExpediaGroup/waggle-dance/blob/main/README.md. This sets the latency for the primary metastore only."
 }