docs && fmt
This commit is contained in:
Maciej Sikora
committed by
Wiktor Niesiobędzki
Wiktor Niesiobędzki
parent
1cc50e30ae
commit
fd8f659a3a
@@ -813,9 +813,9 @@ module "cloud_run" {
|
|||||||
|
|
||||||
| name | description | type | required | default |
|
| name | description | type | required | default |
|
||||||
|---|---|:---:|:---:|:---:|
|
|---|---|:---:|:---:|:---:|
|
||||||
| [name](variables.tf#L223) | Name used for Cloud Run service. | <code>string</code> | ✓ | |
|
| [name](variables.tf#L221) | Name used for Cloud Run service. | <code>string</code> | ✓ | |
|
||||||
| [project_id](variables.tf#L238) | Project id used for all resources. | <code>string</code> | ✓ | |
|
| [project_id](variables.tf#L236) | Project id used for all resources. | <code>string</code> | ✓ | |
|
||||||
| [region](variables.tf#L243) | Region used for all resources. | <code>string</code> | ✓ | |
|
| [region](variables.tf#L241) | Region used for all resources. | <code>string</code> | ✓ | |
|
||||||
| [containers](variables.tf#L17) | Containers in name => attributes format. | <code title="map(object({ image = string depends_on = optional(list(string)) command = optional(list(string)) args = optional(list(string)) env = optional(map(string)) env_from_key = optional(map(object({ secret = string version = string }))) liveness_probe = optional(object({ grpc = optional(object({ port = optional(number) service = optional(string) })) http_get = optional(object({ http_headers = optional(map(string)) path = optional(string) port = optional(number) })) failure_threshold = optional(number) initial_delay_seconds = optional(number) period_seconds = optional(number) timeout_seconds = optional(number) })) ports = optional(map(object({ container_port = optional(number) name = optional(string) }))) resources = optional(object({ limits = optional(object({ cpu = string memory = string })) cpu_idle = optional(bool) startup_cpu_boost = optional(bool) })) startup_probe = optional(object({ grpc = optional(object({ port = optional(number) service = optional(string) })) http_get = optional(object({ http_headers = optional(map(string)) path = optional(string) port = optional(number) })) tcp_socket = optional(object({ port = optional(number) })) failure_threshold = optional(number) initial_delay_seconds = optional(number) period_seconds = optional(number) timeout_seconds = optional(number) })) volume_mounts = optional(map(string)) }))">map(object({…}))</code> | | <code>{}</code> |
|
| [containers](variables.tf#L17) | Containers in name => attributes format. | <code title="map(object({ image = string depends_on = optional(list(string)) command = optional(list(string)) args = optional(list(string)) env = optional(map(string)) env_from_key = optional(map(object({ secret = string version = string }))) liveness_probe = optional(object({ grpc = optional(object({ port = optional(number) service = optional(string) })) http_get = optional(object({ http_headers = optional(map(string)) path = optional(string) port = optional(number) })) failure_threshold = optional(number) initial_delay_seconds = optional(number) period_seconds = optional(number) timeout_seconds = optional(number) })) ports = optional(map(object({ container_port = optional(number) name = optional(string) }))) resources = optional(object({ limits = optional(object({ cpu = string memory = string })) cpu_idle = optional(bool) startup_cpu_boost = optional(bool) })) startup_probe = optional(object({ grpc = optional(object({ port = optional(number) service = optional(string) })) http_get = optional(object({ http_headers = optional(map(string)) path = optional(string) port = optional(number) })) tcp_socket = optional(object({ port = optional(number) })) failure_threshold = optional(number) initial_delay_seconds = optional(number) period_seconds = optional(number) timeout_seconds = optional(number) })) volume_mounts = optional(map(string)) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||||
| [create_job](variables.tf#L80) | Create Cloud Run Job instead of Service. | <code>bool</code> | | <code>false</code> |
|
| [create_job](variables.tf#L80) | Create Cloud Run Job instead of Service. | <code>bool</code> | | <code>false</code> |
|
||||||
| [custom_audiences](variables.tf#L86) | Custom audiences for service. | <code>list(string)</code> | | <code>null</code> |
|
| [custom_audiences](variables.tf#L86) | Custom audiences for service. | <code>list(string)</code> | | <code>null</code> |
|
||||||
@@ -823,19 +823,18 @@ module "cloud_run" {
|
|||||||
| [encryption_key](variables.tf#L98) | The full resource name of the Cloud KMS CryptoKey. | <code>string</code> | | <code>null</code> |
|
| [encryption_key](variables.tf#L98) | The full resource name of the Cloud KMS CryptoKey. | <code>string</code> | | <code>null</code> |
|
||||||
| [eventarc_triggers](variables.tf#L104) | Event arc triggers for different sources. | <code title="object({ audit_log = optional(map(object({ method = string service = string }))) pubsub = optional(map(string)) service_account_email = optional(string) service_account_create = optional(bool, false) })">object({…})</code> | | <code>{}</code> |
|
| [eventarc_triggers](variables.tf#L104) | Event arc triggers for different sources. | <code title="object({ audit_log = optional(map(object({ method = string service = string }))) pubsub = optional(map(string)) service_account_email = optional(string) service_account_create = optional(bool, false) })">object({…})</code> | | <code>{}</code> |
|
||||||
| [iam](variables.tf#L122) | IAM bindings for Cloud Run service in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
| [iam](variables.tf#L122) | IAM bindings for Cloud Run service in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
||||||
| [iap_enabled](variables.tf#L128) | <<-EOT Enables Identity-Aware Proxy (IAP) for this service. IAP can only be enabled for Cloud Run services (create_job = false). EOT | <code>bool</code> | | <code>false</code> |
|
| [iap_config](variables.tf#L128) | <<-EOT If present, it turns on Identity-Aware Proxy (IAP) for this service. iam (resource google_iap_web_cloud_run_service_iam_binding) - list of iam emails (e.g. "group:abc@domain.com") to be granted with iap.httpsResourceAccessor role. iam_additive (resource google_iap_web_cloud_run_service_iam_member ) - list of iam emails (e.g. "group:abc@domain.com") to be granted with iap.httpsResourceAccessor. iam and iam_additive are mutually exclusive. EOT | <code title="object({ iam = optional(list(string)) iam_additive = optional(list(string)) })">object({…})</code> | | <code>null</code> |
|
||||||
| [iap_http_resource_accessors_config](variables.tf#L142) | <<-EOT IAP HTTP resource accessors configuration. When authoritative_mode is true, the google_iap_web_cloud_run_service_iam_binding resource is used which replaces any existing IAM policy attached to the IAP web service. When authoritative_mode is false (default), the google_iap_web_cloud_run_service_iam_member resource is used which adds the IAM policies to the service. EOT | <code title="object({ iam_emails = list(string) authoritative_mode = optional(bool, false) })">object({…})</code> | | <code>null</code> |
|
| [ingress](variables.tf#L168) | Ingress settings. | <code>string</code> | | <code>null</code> |
|
||||||
| [ingress](variables.tf#L166) | Ingress settings. | <code>string</code> | | <code>null</code> |
|
| [invoker_iam_disabled](variables.tf#L185) | Disables IAM permission check for run.routes.invoke for callers of this service. | <code>bool</code> | | <code>false</code> |
|
||||||
| [invoker_iam_disabled](variables.tf#L183) | Disables IAM permission check for run.routes.invoke for callers of this service. | <code>bool</code> | | <code>false</code> |
|
| [labels](variables.tf#L191) | Resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||||
| [labels](variables.tf#L189) | Resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
| [launch_stage](variables.tf#L197) | The launch stage as defined by Google Cloud Platform Launch Stages. | <code>string</code> | | <code>null</code> |
|
||||||
| [launch_stage](variables.tf#L195) | The launch stage as defined by Google Cloud Platform Launch Stages. | <code>string</code> | | <code>null</code> |
|
| [managed_revision](variables.tf#L214) | Whether the Terraform module should control the deployment of revisions. | <code>bool</code> | | <code>true</code> |
|
||||||
| [managed_revision](variables.tf#L216) | Whether the Terraform module should control the deployment of revisions. | <code>bool</code> | | <code>true</code> |
|
| [prefix](variables.tf#L226) | Optional prefix used for resource names. | <code>string</code> | | <code>null</code> |
|
||||||
| [prefix](variables.tf#L228) | Optional prefix used for resource names. | <code>string</code> | | <code>null</code> |
|
| [revision](variables.tf#L246) | Revision template configurations. | <code title="object({ labels = optional(map(string)) name = optional(string) gen2_execution_environment = optional(bool) max_concurrency = optional(number) max_instance_count = optional(number) min_instance_count = optional(number) job = optional(object({ max_retries = optional(number) task_count = optional(number) }), {}) vpc_access = optional(object({ connector = optional(string) egress = optional(string) network = optional(string) subnet = optional(string) tags = optional(list(string)) }), {}) timeout = optional(string) })">object({…})</code> | | <code>{}</code> |
|
||||||
| [revision](variables.tf#L248) | Revision template configurations. | <code title="object({ labels = optional(map(string)) name = optional(string) gen2_execution_environment = optional(bool) max_concurrency = optional(number) max_instance_count = optional(number) min_instance_count = optional(number) job = optional(object({ max_retries = optional(number) task_count = optional(number) }), {}) vpc_access = optional(object({ connector = optional(string) egress = optional(string) network = optional(string) subnet = optional(string) tags = optional(list(string)) }), {}) timeout = optional(string) })">object({…})</code> | | <code>{}</code> |
|
| [service_account](variables.tf#L285) | Service account email. Unused if service account is auto-created. | <code>string</code> | | <code>null</code> |
|
||||||
| [service_account](variables.tf#L287) | Service account email. Unused if service account is auto-created. | <code>string</code> | | <code>null</code> |
|
| [service_account_create](variables.tf#L291) | Auto-create service account. | <code>bool</code> | | <code>false</code> |
|
||||||
| [service_account_create](variables.tf#L293) | Auto-create service account. | <code>bool</code> | | <code>false</code> |
|
| [tag_bindings](variables.tf#L297) | Tag bindings for this service, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
||||||
| [tag_bindings](variables.tf#L299) | Tag bindings for this service, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
| [volumes](variables.tf#L304) | Named volumes in containers in name => attributes format. | <code title="map(object({ secret = optional(object({ name = string default_mode = optional(string) path = optional(string) version = optional(string) mode = optional(string) })) cloud_sql_instances = optional(list(string)) empty_dir_size = optional(string) gcs = optional(object({ bucket = string is_read_only = optional(bool) })) nfs = optional(object({ server = string path = optional(string) is_read_only = optional(bool) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||||
| [volumes](variables.tf#L306) | Named volumes in containers in name => attributes format. | <code title="map(object({ secret = optional(object({ name = string default_mode = optional(string) path = optional(string) version = optional(string) mode = optional(string) })) cloud_sql_instances = optional(list(string)) empty_dir_size = optional(string) gcs = optional(object({ bucket = string is_read_only = optional(bool) })) nfs = optional(object({ server = string path = optional(string) is_read_only = optional(bool) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
||||||
| [vpc_connector_create](variables-vpcconnector.tf#L17) | Populate this to create a Serverless VPC Access connector. | <code title="object({ ip_cidr_range = optional(string) machine_type = optional(string) name = optional(string) network = optional(string) instances = optional(object({ max = optional(number) min = optional(number) }), {} ) throughput = optional(object({ max = optional(number) min = optional(number) }), {} ) subnet = optional(object({ name = optional(string) project_id = optional(string) }), {}) })">object({…})</code> | | <code>null</code> |
|
| [vpc_connector_create](variables-vpcconnector.tf#L17) | Populate this to create a Serverless VPC Access connector. | <code title="object({ ip_cidr_range = optional(string) machine_type = optional(string) name = optional(string) network = optional(string) instances = optional(object({ max = optional(number) min = optional(number) }), {} ) throughput = optional(object({ max = optional(number) min = optional(number) }), {} ) subnet = optional(object({ name = optional(string) project_id = optional(string) }), {}) })">object({…})</code> | | <code>null</code> |
|
||||||
|
|
||||||
## Outputs
|
## Outputs
|
||||||
|
|||||||
@@ -529,8 +529,8 @@ locals {
|
|||||||
|
|
||||||
iap_member_list = toset(coalesce(var.iap_config.iam_additive, []))
|
iap_member_list = toset(coalesce(var.iap_config.iam_additive, []))
|
||||||
|
|
||||||
use_iap_iam_binding = var.iap_config != null && var.iap_config.iam != null
|
use_iap_iam_binding = var.iap_config != null && var.iap_config.iam != null
|
||||||
iap_binding_dict = local.use_iap_iam_binding ? { "iap" = var.iap_config.iam } : {}
|
iap_binding_dict = local.use_iap_iam_binding ? { "iap" = var.iap_config.iam } : {}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -137,7 +137,7 @@ variable "iap_config" {
|
|||||||
iam_additive = optional(list(string))
|
iam_additive = optional(list(string))
|
||||||
})
|
})
|
||||||
default = null
|
default = null
|
||||||
|
|
||||||
validation {
|
validation {
|
||||||
condition = var.iap_config == null || (
|
condition = var.iap_config == null || (
|
||||||
(var.iap_config.iam != null && var.iap_config.iam_additive == null) ||
|
(var.iap_config.iam != null && var.iap_config.iam_additive == null) ||
|
||||||
@@ -145,7 +145,7 @@ variable "iap_config" {
|
|||||||
)
|
)
|
||||||
error_message = "When iap_config is provided, exactly one of 'iam' or 'iam_additive' must be specified."
|
error_message = "When iap_config is provided, exactly one of 'iam' or 'iam_additive' must be specified."
|
||||||
}
|
}
|
||||||
|
|
||||||
validation {
|
validation {
|
||||||
condition = var.iap_config == null || (
|
condition = var.iap_config == null || (
|
||||||
(var.iap_config.iam != null ? length(var.iap_config.iam) > 0 : true) &&
|
(var.iap_config.iam != null ? length(var.iap_config.iam) > 0 : true) &&
|
||||||
@@ -153,12 +153,12 @@ variable "iap_config" {
|
|||||||
)
|
)
|
||||||
error_message = "When 'iam' or 'iam_additive' lists are provided in iap_config, they must not be empty."
|
error_message = "When 'iam' or 'iam_additive' lists are provided in iap_config, they must not be empty."
|
||||||
}
|
}
|
||||||
|
|
||||||
validation {
|
validation {
|
||||||
condition = var.iap_config == null || !var.create_job
|
condition = var.iap_config == null || !var.create_job
|
||||||
error_message = "IAP is only supported for Cloud Run services, not Cloud Run jobs. Set create_job to false when using iap_config."
|
error_message = "IAP is only supported for Cloud Run services, not Cloud Run jobs. Set create_job to false when using iap_config."
|
||||||
}
|
}
|
||||||
|
|
||||||
validation {
|
validation {
|
||||||
condition = var.iap_config == null || var.launch_stage != "GA"
|
condition = var.iap_config == null || var.launch_stage != "GA"
|
||||||
error_message = "iap is currently not supported in GA. Set launch_stage to 'BETA' or lower."
|
error_message = "iap is currently not supported in GA. Set launch_stage to 'BETA' or lower."
|
||||||
|
|||||||
Reference in New Issue
Block a user