-
Notifications
You must be signed in to change notification settings - Fork 35
/
variables.tf
606 lines (511 loc) · 20.2 KB
/
variables.tf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0
# GENERAL
# -------
variable "ca_certificate_secret_id" {
default = null
description = "The Secret Manager secret which comprises the Base64 encoded PEM certificate file for a Certificate Authority. The Terraform provider calls this value the secret_id and the GCP UI calls it the name."
type = string
}
variable "container_runtime_engine" {
default = "docker"
type = string
description = "The container runtime engine to run the FDO container on. Default is docker."
validation {
condition = contains(["docker", "podman"], var.container_runtime_engine)
error_message = "Supported values for container_runtime_enginer are docker and podman."
}
}
variable "dns_create_record" {
default = true
description = "If true, will create a DNS record. If false, no record will be created and IP of load balancer will instead be output."
type = bool
}
variable "dns_zone_name" {
default = null
description = "Name of the DNS zone set up in GCP."
type = string
}
variable "existing_service_account_id" {
description = "An ID of an existing service account to use for log management. Setting this value prevents terraform from creating a new user and assigning a logWriter IAM role."
type = string
default = null
}
variable "is_replicated_deployment" {
type = bool
description = "TFE will be installed using a Replicated license and deployment method."
default = true
}
variable "labels" {
type = map(string)
description = "Labels to apply to resources"
default = {}
}
variable "namespace" {
description = "Prefix for naming resources"
type = string
}
variable "node_count" {
description = "The number of Terraform Enterprise nodes to deploy. Setting this value greater than 1 will enable Active/Active, forcing the Production installation type and the External production type."
type = number
validation {
condition = var.node_count >= 0 && var.node_count <= 5
error_message = "The node_count value must be between 0 and 2, inclusively."
}
}
variable "project" {
description = "The project id of the target project. This is not inferred from the provider. Required if var.existing_service_account_id is null."
type = string
default = null
}
variable "proxy_ip" {
default = null
description = "The host subcomponent of an HTTP proxy URI authority. This value will be used to configure the HTTP and HTTPS proxy settings of the operating system and Terraform Enterprise."
type = string
}
variable "proxy_port" {
default = null
description = "The port subcomponent of an HTTP proxy URI authority. This value will be used to configure the HTTP and HTTPS proxy settings of the operating system and Terraform Enterprise."
type = string
}
# NETWORKING
# -----------
variable "load_balancer" {
default = "PRIVATE"
description = "Load Balancing Scheme. Supported values are: 'PRIVATE'; 'PRIVATE_TCP'; 'PUBLIC'."
type = string
validation {
condition = contains(["PRIVATE", "PRIVATE_TCP", "PUBLIC"], var.load_balancer)
error_message = "The load_balancer value must be one of: 'PRIVATE'; 'PRIVATE_TCP'; 'PUBLIC'."
}
}
variable "network" {
default = null
description = "Pre-existing network self link"
type = string
}
variable "networking_firewall_ports" {
default = []
description = "Additional ports to open in the firewall"
type = list(string)
}
variable "networking_healthcheck_ips" {
default = ["35.191.0.0/16", "209.85.152.0/22", "209.85.204.0/22", "130.211.0.0/22"]
description = "Allowed IPs required for healthcheck. Provided by GCP"
type = list(string)
}
variable "networking_ip_allow_list" {
default = ["0.0.0.0/0"]
description = "List of allowed IPs for the firewall"
type = list(string)
}
variable "networking_reserve_subnet_range" {
default = "10.2.0.0/16"
description = "The range of IP addresses to reserve for the subnetwork dedicated to internal HTTPS load balancing, expressed in CIDR format."
type = string
}
variable "networking_subnet_range" {
default = "10.0.0.0/16"
description = "CIDR block for the created subnet"
type = string
}
variable "ssh_source_ranges" {
default = ["35.235.240.0/20"]
description = "The source IP address ranges from which SSH traffic will be permitted; these ranges must be expressed in CIDR notation. The default value permits traffic from GCP's Identity-Aware Proxy."
type = list(string)
}
variable "enable_public_ssh_access" {
type = bool
default = false
description = "A toggle to control the use of public SSH access to the compute instances. When enabled, the SSH port will be open to the public internet."
}
variable "subnetwork" {
default = null
description = "Pre-existing subnetwork self link"
type = string
}
# DATABASE
# --------
variable "database_availability_type" {
default = "ZONAL"
description = "Database Availability Type"
type = string
}
variable "database_backup_start_time" {
default = "00:00"
description = "Database backup start time"
type = string
}
variable "database_name" {
default = "tfe"
description = "Postgres database name"
type = string
}
variable "database_machine_type" {
default = "db-custom-4-16384"
description = "Database machine type"
type = string
}
variable "database_user" {
default = "tfe_user"
description = "Postgres username"
type = string
}
variable "postgres_disk_size" {
default = 50
description = "The size of the SQL database instance data disk, expressed in gigabytes."
type = number
}
variable "postgres_version" {
default = "POSTGRES_12"
description = "The version of PostgreSQL to be installed on the SQL database instance."
type = string
}
# REDIS
# -----
variable "redis_auth_enabled" {
default = true
description = "A toggle to enable Redis authentication"
type = bool
}
variable "redis_memory_size" {
default = 6
description = "Redis memory size in GiB"
type = number
}
variable "redis_version" {
type = string
description = "The version of Redis to install"
default = "REDIS_7_0"
}
# VM
# --
variable "vm_disk_size" {
default = 50
description = "VM Disk size. Should be at least 50"
type = number
}
variable "vm_disk_source_image" {
default = "projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts"
description = "VM Disk source image"
type = string
}
variable "vm_disk_type" {
default = "pd-ssd"
description = "VM Disk type. SSD recommended"
type = string
}
variable "vm_machine_type" {
default = "n1-standard-4"
description = "VM Machine Type"
type = string
}
variable "vm_metadata" {
default = {}
description = "Metadata key/value pairs to make available from within the compute instances."
type = map(string)
}
variable "vm_mig_check_interval_sec" {
default = 60
description = "How often (in seconds) to send a health check."
type = number
validation {
condition = var.vm_mig_check_interval_sec >= 1 && var.vm_mig_check_interval_sec <= 300
error_message = "The vm_mig_check_interval_sec must be an integer between 1 and 300, inclusive."
}
}
variable "vm_mig_healthy_threshold" {
default = 2
description = "The number of sequential successful health check probe results for a backend to be considered healthy."
type = number
validation {
condition = var.vm_mig_healthy_threshold >= 1 && var.vm_mig_healthy_threshold <= 10
error_message = "The vm_mig_healthy_threshold must be an integer between 1 and 10, inclusive."
}
}
variable "vm_mig_initial_delay_sec" {
default = 600
description = "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances."
type = number
validation {
condition = var.vm_mig_initial_delay_sec >= 1 && var.vm_mig_initial_delay_sec <= 3600
error_message = "The vm_mig_initial_delay_sec must be an integer between 1 and 3600, inclusive."
}
}
variable "vm_mig_timeout_sec" {
default = 10
description = "How long to wait (in seconds) before a request is considered a failure."
type = number
validation {
condition = var.vm_mig_timeout_sec >= 1 && var.vm_mig_timeout_sec <= 300
error_message = "The vm_mig_timeout_sec must be an integer between 1 and 300 and must be lower than or equal to vm_mig_check_interval_sec."
}
}
variable "vm_mig_unhealthy_threshold" {
default = 6
description = "The number of sequential failed health check probe results for a backend to be considered unhealthy."
type = number
validation {
condition = var.vm_mig_unhealthy_threshold >= 1 && var.vm_mig_unhealthy_threshold <= 10
error_message = "The vm_mig_unhealthy_threshold must be an integer between 1 and 10, inclusive."
}
}
variable "vm_mounted_disk_size" {
default = 40
description = "The size in gigabytes of the mounted disk to attach to the VM when the Operational Mode is Mounted Disk.}"
type = number
}
# USER DATA / TFE
# ---------------
variable "airgap_url" {
default = null
description = "The URL of a Replicated airgap package for Terraform Enterprise."
type = string
}
variable "bypass_preflight_checks" {
default = false
type = bool
description = "Allow the TFE application to start without preflight checks."
}
variable "capacity_cpu" {
default = 0
description = "Maximum number of CPU cores a Terraform run is allowed to use. Set to `0` for no limit. Defaults to `0` if no value is given."
type = number
}
variable "capacity_concurrency" {
default = "10"
description = "The maximum number of Terraform runs that will be executed concurrently on each compute instance."
type = string
}
variable "capacity_memory" {
default = null
type = number
description = "The maximum amount of memory (in megabytes) that a Terraform plan or apply can use on the system; defaults to 512."
}
variable "custom_agent_image_tag" {
default = null
type = string
description = "Configure the docker image for handling job execution within TFE. This can either be the standard image that ships with TFE or a custom image that includes extra tools not present in the default one. Should be in the format <name>:<tag>."
}
variable "custom_image_tag" {
default = null
type = string
description = "The name and tag for your alternative Terraform build worker image in the format <name>:<tag>. Default is 'hashicorp/build-worker:now'."
}
variable "disk_path" {
default = null
description = "The pathname of the directory in which Terraform Enterprise will store data on the compute instances."
type = string
}
variable "distribution" {
type = string
description = "(Required) What is the OS distribution of the instance on which Terraoform Enterprise will be deployed?"
validation {
condition = contains(["rhel", "ubuntu"], var.distribution)
error_message = "Supported values for distribution are 'rhel' or 'ubuntu'."
}
}
variable "enable_monitoring" {
default = false
description = "A toggle which controls the use of Stackdriver monitoring on the compute instances."
type = bool
}
variable "fqdn" {
description = "Fully qualified domain name for the TFE endpoint"
type = string
}
variable "hairpin_addressing" {
default = false
description = "A toggle to control the use of hairpin addressing within the TFE deployment."
type = bool
}
variable "hc_license" {
default = null
type = string
description = "(Not needed if is_replicated_deployment is true) The raw TFE license that is validated on application startup."
}
variable "http_port" {
default = 80
type = number
description = "(Optional if is_replicated_deployment is false) Port application listens on for HTTP. Default is 80."
}
variable "https_port" {
default = 443
type = number
description = "(Optional if is_replicated_deployment is false) Port application listens on for HTTPS. Default is 443."
}
variable "iact_subnet_list" {
default = []
description = "A list of IP address ranges which will be authorized to access the IACT. The ranges must be expressed in CIDR notation."
type = list(string)
}
variable "iact_subnet_time_limit" {
default = 60
description = "The time limit for IP addresses from iact_subnet_list to access the IACT. The value must be expressed in minutes."
type = number
}
variable "metrics_endpoint_enabled" {
default = false
type = bool
description = "(Optional) Metrics are used to understand the behavior of Terraform Enterprise and to troubleshoot and tune performance. Enable an endpoint to expose container metrics. Defaults to false."
}
variable "metrics_endpoint_port_http" {
default = null
type = number
description = "(Optional when metrics_endpoint_enabled is true.) Defines the TCP port on which HTTP metrics requests will be handled. Defaults to 9090."
}
variable "metrics_endpoint_port_https" {
default = null
type = string
description = "(Optional when metrics_endpoint_enabled is true.) Defines the TCP port on which HTTPS metrics requests will be handled. Defaults to 9091."
}
variable "license_reporting_opt_out" {
default = false
type = bool
description = "(Not needed if is_replicated_deployment is true) Whether to opt out of reporting licensing information to HashiCorp. Defaults to false."
}
variable "usage_reporting_opt_out" {
default = false
type = bool
description = "(Not needed if is_replicated_deployment is true) Whether to opt out of reporting usage information to HashiCorp. Defaults to false."
}
variable "operational_mode" {
default = "external"
description = "A special string to control the operational mode of Terraform Enterprise. Valid values are: 'external', 'disk' and 'active-active'."
type = string
validation {
condition = contains(["external", "disk", "active-active"], var.operational_mode)
error_message = "The operational_mode value must be one of: 'external', 'disk' or 'active-active'."
}
}
variable "redis_use_tls" {
default = false
description = "A toggle to control the use of TLS when connecting to the Redis endpoint."
type = bool
}
variable "registry" {
default = "images.releases.hashicorp.com"
type = string
description = "(Not needed if is_replicated_deployment is true) The docker registry from which to source the terraform_enterprise container images."
}
variable "registry_password" {
default = null
type = string
description = "(Not needed if is_replicated_deployment is true) The password for the docker registry from which to source the terraform_enterprise container images."
}
variable "registry_username" {
default = null
type = string
description = "(Not needed if is_replicated_deployment is true) The username for the docker registry from which to source the terraform_enterprise container images."
}
variable "release_sequence" {
default = null
description = "Release sequence of Terraform Enterprise to install."
type = number
}
variable "run_pipeline_image" {
default = null
type = string
description = "(Not needed if is_replicated_deployment is true) Container image used to execute Terraform runs. Leave blank to use the default image that comes with Terraform Enterprise. Defaults to ''."
}
variable "ssl_certificate_name" {
default = null
description = "Name of the created managed SSL certificate. Required when load_balancer == 'PUBLIC' or load_balancer == 'PRIVATE'."
type = string
}
variable "ssl_certificate_secret" {
default = null
description = "The Secret Manager secret which comprises the Base64 encoded PEM certificate file. The Terraform provider calls this value the secret_id and the GCP UI calls it the name. This value is only used when load_balancer == 'PRIVATE_TCP'."
type = string
}
variable "ssl_private_key_secret" {
default = null
description = "The Secret Manager secret which comprises the Base64 encoded PEM private key file. The Terraform provider calls this value the secret_id and the GCP UI calls it the name. This value is only used when load_balancer == 'PRIVATE_TCP'."
type = string
}
variable "tfe_image" {
default = "images.releases.hashicorp.com/hashicorp/terraform-enterprise:v202311-1"
type = string
description = "(Not needed if is_replicated_deployment is true) The registry path, image name, and image version."
}
variable "tfe_license_bootstrap_airgap_package_path" {
default = null
type = string
description = "(Required if air-gapped installation) The URL of a Replicated airgap package for Terraform Enterprise. The suggested path is '/var/lib/ptfe/ptfe.airgap'."
}
variable "tfe_license_file_location" {
default = "/etc/terraform-enterprise.rli"
type = string
description = "The path on the TFE instance to put the TFE license."
}
variable "tfe_license_secret_id" {
default = null
description = "The Secret Manager secret which comprises the Base64 encoded Replicated license file. The Terraform provider calls this value the secret_id and the GCP UI calls it the name."
type = string
}
variable "tls_bootstrap_cert_pathname" {
default = null
type = string
description = "The path on the TFE instance to put the certificate. ex. '/var/lib/terraform-enterprise/certificate.pem'"
}
variable "tls_bootstrap_key_pathname" {
default = null
type = string
description = "The path on the TFE instance to put the key. ex. '/var/lib/terraform-enterprise/key.pem'"
}
variable "tls_ciphers" {
default = null
type = string
description = "(Not needed if is_replicated_deployment is true) TLS ciphers to use for TLS. Must be valid OpenSSL format. Leave blank to use the default ciphers. Defaults to ''"
}
variable "tls_vers" {
default = "tls_1_2_tls_1_3"
description = "An indicator of the versions of TLS that will be supported by Terraform Enterprise. The value must be one of: 'tls_1_2_tls_1_3'; 'tls_1_2'; 'tls_1_3'."
type = string
validation {
condition = contains(["tls_1_2_tls_1_3", "tls_1_2", "tls_1_3"], var.tls_vers)
error_message = "The tls_vers value must be one of: 'tls_1_2_tls_1_3'; 'tls_1_2'; 'tls_1_3'."
}
}
variable "trusted_proxies" {
default = []
description = "A list of IP address ranges which will be considered safe to ignore when evaluating the IP addresses of requests like those made to the IACT endpoint."
type = list(string)
}
# External Vault
# --------------
variable "extern_vault_addr" {
default = null
type = string
description = "(Required if var.extern_vault_enable = true) URL of external Vault cluster."
}
variable "extern_vault_enable" {
default = false
type = bool
description = "(Optional) Indicate if an external Vault cluster is being used. Set to 1 if so."
}
variable "extern_vault_namespace" {
default = null
type = string
description = "(Optional if var.extern_vault_enable = true) The Vault namespace"
}
variable "extern_vault_path" {
default = "auth/approle"
type = string
description = "(Optional if var.extern_vault_enable = true) Path on the Vault server for the AppRole auth. Defaults to auth/approle."
}
variable "extern_vault_role_id" {
default = null
type = string
description = "(Required if var.extern_vault_enable = true) AppRole RoleId to use to authenticate with the Vault cluster."
}
variable "extern_vault_secret_id" {
default = null
type = string
description = "(Required if var.extern_vault_enable = true) AppRole SecretId to use to authenticate with the Vault cluster."
}
variable "extern_vault_token_renew" {
default = 3600
type = number
description = "(Optional if var.extern_vault_enable = true) How often (in seconds) to renew the Vault token."
}