Add toggle to tfdoc to remove type hints (#3842)
* Add toggle to tfdoc to remove type hints * Update all readmes * Fix python formatting
This commit is contained in:
Julio Castillo
@@ -1191,27 +1191,27 @@ module "sole-tenancy" {
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [name](variables.tf#L353) | Instance name. | <code>string</code> | ✓ | |
|
||||
| [network_interfaces](variables.tf#L365) | Network interfaces configuration. Use self links for Shared VPC, set addresses to null if not needed. | <code title="list(object({ network = string subnetwork = string alias_ips = optional(map(string), {}) nat = optional(bool, false) network_tier = optional(string) nic_type = optional(string) stack_type = optional(string) queue_count = optional(number) # NEW internal_ipv6_prefix_length = optional(number) # NEW addresses = optional(object({ internal = optional(string) external = optional(string) }), null) }))">list(object({…}))</code> | ✓ | |
|
||||
| [network_interfaces](variables.tf#L365) | Network interfaces configuration. Use self links for Shared VPC, set addresses to null if not needed. | <code>list(object({…}))</code> | ✓ | |
|
||||
| [project_id](variables.tf#L405) | Project id. | <code>string</code> | ✓ | |
|
||||
| [zone](variables.tf#L562) | Compute zone. | <code>string</code> | ✓ | |
|
||||
| [attached_disks](variables.tf#L17) | Additional disks. Source type is one of 'image' (zonal disks in vms and template), 'snapshot' (vm), 'existing', and null. | <code title="map(object({ auto_delete = optional(bool, true) # applies only to vm templates device_name = optional(string) force_attach = optional(bool) mode = optional(string, "READ_WRITE") name = optional(string) initialize_params = optional(object({ replica_zone = optional(string) size = optional(number, 10) type = optional(string, "pd-balanced") hyperdisk = optional(object({ provisioned_iops = optional(number) provisioned_throughput = optional(number) # in MiB/s storage_pool = optional(string) }), {}) }), {}) snapshot_schedule = optional(list(string)) source = optional(object({ attach = optional(string) image = optional(string) # not supported yet for repd snapshot = optional(string) }), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [boot_disk](variables.tf#L56) | Boot disk properties. | <code title="object({ architecture = optional(string) auto_delete = optional(bool, true) force_attach = optional(bool) snapshot_schedule = optional(list(string)) initialize_params = optional(object({ size = optional(number, 10) type = optional(string, "pd-balanced") hyperdisk = optional(object({ provisioned_iops = optional(number) provisioned_throughput = optional(number) # in MiB/s storage_pool = optional(string) }), {}) }), {}) source = optional(object({ attach = optional(string) disk = optional(string) image = optional(string) snapshot = optional(string) }), { image = "debian-cloud/debian-13" }) use_independent_disk = optional(object({ name = optional(string) })) })">object({…})</code> | | <code>{}</code> |
|
||||
| [attached_disks](variables.tf#L17) | Additional disks. Source type is one of 'image' (zonal disks in vms and template), 'snapshot' (vm), 'existing', and null. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [boot_disk](variables.tf#L56) | Boot disk properties. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [can_ip_forward](variables.tf#L113) | Enable IP forwarding. | <code>bool</code> | | <code>false</code> |
|
||||
| [confidential_compute](variables.tf#L119) | Confidential Compute configuration. Set to 'SEV' or 'SEV_SNP' to enable. | <code>string</code> | | <code>null</code> |
|
||||
| [context](variables.tf#L129) | Context-specific interpolations. | <code title="object({ addresses = optional(map(string), {}) custom_roles = optional(map(string), {}) kms_keys = optional(map(string), {}) iam_principals = optional(map(string), {}) locations = optional(map(string), {}) networks = optional(map(string), {}) project_ids = optional(map(string), {}) subnets = optional(map(string), {}) tag_values = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [create_template](variables.tf#L146) | Create instance template instead of instances. Defaults to a global template. | <code title="object({ regional = optional(bool, false) })">object({…})</code> | | <code>null</code> |
|
||||
| [context](variables.tf#L129) | Context-specific interpolations. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [create_template](variables.tf#L146) | Create instance template instead of instances. Defaults to a global template. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [description](variables.tf#L155) | Description of a Compute Instance. | <code>string</code> | | <code>"Managed by the compute-vm Terraform module."</code> |
|
||||
| [enable_display](variables.tf#L161) | Enable virtual display on the instances. | <code>bool</code> | | <code>false</code> |
|
||||
| [encryption](variables.tf#L167) | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | <code title="object({ encrypt_boot = optional(bool, false) disk_encryption_key_raw = optional(string) kms_key_self_link = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [gpu](variables.tf#L178) | GPU information. Based on https://cloud.google.com/compute/docs/gpus. | <code title="object({ count = number type = string })">object({…})</code> | | <code>null</code> |
|
||||
| [group](variables.tf#L213) | Instance group configuration. Set 'named_ports' to create a new unmanaged instance group, or provide an existing group self_link/id in 'membership' to join one. | <code title="object({ membership = optional(string) # ID of an existing unmanaged group to join named_ports = optional(map(number), {}) })">object({…})</code> | | <code>null</code> |
|
||||
| [encryption](variables.tf#L167) | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [gpu](variables.tf#L178) | GPU information. Based on https://cloud.google.com/compute/docs/gpus. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [group](variables.tf#L213) | Instance group configuration. Set 'named_ports' to create a new unmanaged instance group, or provide an existing group self_link/id in 'membership' to join one. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [hostname](variables.tf#L222) | Instance FQDN name. | <code>string</code> | | <code>null</code> |
|
||||
| [iam](variables.tf#L228) | IAM bindings in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
||||
| [instance_schedule](variables.tf#L234) | Assign or create and assign an instance schedule policy. Set active to null to detach a policy from vm before destroying. | <code title="object({ active = optional(bool, true) description = optional(string) expiration_time = optional(string) start_time = optional(string) timezone = optional(string, "UTC") vm_start = optional(string) vm_stop = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [kms_autokeys](variables.tf#L258) | KMS Autokey key handles. If location is not specified it will be inferred from the zone. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | <code title="map(object({ location = optional(string) resource_type_selector = optional(string, "compute.googleapis.com/Disk") }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [instance_schedule](variables.tf#L234) | Assign or create and assign an instance schedule policy. Set active to null to detach a policy from vm before destroying. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [kms_autokeys](variables.tf#L258) | KMS Autokey key handles. If location is not specified it will be inferred from the zone. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [labels](variables.tf#L276) | Instance labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [lifecycle_config](variables.tf#L282) | Instance lifecycle and operational configurations. | <code title="object({ allow_stopping_for_update = optional(bool, true) deletion_protection = optional(bool, false) key_revocation_action_type = optional(string, "NONE") graceful_shutdown = optional(object({ enabled = optional(bool, false) max_duration_secs = optional(number) })) })">object({…})</code> | | <code>{}</code> |
|
||||
| [machine_features_config](variables.tf#L304) | Machine-level configuration. | <code title="object({ enable_nested_virtualization = optional(bool) enable_turbo_mode = optional(bool) enable_uefi_networking = optional(bool) performance_monitoring_unit = optional(string) threads_per_core = optional(number) visible_core_count = optional(number) })">object({…})</code> | | <code>{}</code> |
|
||||
| [lifecycle_config](variables.tf#L282) | Instance lifecycle and operational configurations. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [machine_features_config](variables.tf#L304) | Machine-level configuration. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [machine_type](variables.tf#L328) | Machine type. | <code>string</code> | | <code>"e2-micro"</code> |
|
||||
| [metadata](variables.tf#L334) | Instance metadata. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [metadata_startup_script](variables.tf#L340) | Instance startup script. Will trigger recreation on change, even after importing. | <code>string</code> | | <code>null</code> |
|
||||
@@ -1221,11 +1221,11 @@ module "sole-tenancy" {
|
||||
| [network_tag_bindings](variables.tf#L398) | Resource manager tag bindings in arbitrary key => tag key or value id format. Set on both the instance only for networking purposes, and modifiable without impacting the main resource lifecycle. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [project_number](variables.tf#L410) | Project number. Used in tag bindings to avoid a permadiff. | <code>string</code> | | <code>null</code> |
|
||||
| [resource_policies](variables.tf#L416) | Resource policies to attach to the instance or template. | <code>list(string)</code> | | <code>null</code> |
|
||||
| [scheduling_config](variables.tf#L423) | Scheduling configuration for the instance. | <code title="object({ automatic_restart = optional(bool) # Defaults to !spot maintenance_interval = optional(string) # NEW min_node_cpus = optional(number) # NEW on_host_maintenance = optional(string) # Defaults to MIGRATE or TERMINATE based on GPU/Spot provisioning_model = optional(string) # "SPOT" or "STANDARD" termination_action = optional(string) local_ssd_recovery_timeout = optional(object({ # NEW nanos = optional(number) seconds = number })) max_run_duration = optional(object({ nanos = optional(number) seconds = number })) node_affinities = optional(map(object({ values = list(string) in = optional(bool, true) })), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [scratch_disks](variables.tf#L458) | Scratch disks configuration. | <code title="object({ count = number interface = string })">object({…})</code> | | <code title="{ count = 0 interface = "NVME" }">{…}</code> |
|
||||
| [service_account](variables.tf#L471) | Service account email and scopes. If email is null, the default Compute service account will be used unless auto_create is true, in which case a service account will be created. Set the variable to null to avoid attaching a service account. | <code title="object({ auto_create = optional(bool, false) email = optional(string) scopes = optional(list(string)) })">object({…})</code> | | <code>{}</code> |
|
||||
| [shielded_config](variables.tf#L482) | Shielded VM configuration of the instances. | <code title="object({ enable_secure_boot = optional(bool, true) enable_vtpm = optional(bool, true) enable_integrity_monitoring = optional(bool, true) })">object({…})</code> | | <code>null</code> |
|
||||
| [snapshot_schedules](variables.tf#L492) | Snapshot schedule resource policies that can be attached to disks. | <code title="map(object({ schedule = object({ daily = optional(object({ days_in_cycle = number start_time = string })) hourly = optional(object({ hours_in_cycle = number start_time = string })) weekly = optional(list(object({ day = string start_time = string }))) }) description = optional(string) retention_policy = optional(object({ max_retention_days = number on_source_disk_delete_keep = optional(bool) })) snapshot_properties = optional(object({ chain_name = optional(string) guest_flush = optional(bool) labels = optional(map(string)) storage_locations = optional(list(string)) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [scheduling_config](variables.tf#L423) | Scheduling configuration for the instance. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [scratch_disks](variables.tf#L458) | Scratch disks configuration. | <code>object({…})</code> | | <code>{…}</code> |
|
||||
| [service_account](variables.tf#L471) | Service account email and scopes. If email is null, the default Compute service account will be used unless auto_create is true, in which case a service account will be created. Set the variable to null to avoid attaching a service account. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [shielded_config](variables.tf#L482) | Shielded VM configuration of the instances. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [snapshot_schedules](variables.tf#L492) | Snapshot schedule resource policies that can be attached to disks. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [tag_bindings](variables.tf#L535) | Resource manager tag bindings in arbitrary key => tag key or value id format. Set on both the instance and zonal disks, and modifiable without impacting the main resource lifecycle. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [tag_bindings_immutable](variables.tf#L542) | Immutable resource manager tag bindings, in tagKeys/id => tagValues/id format. These are set on the instance or instance template at creation time, and trigger recreation if changed. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [tags](variables.tf#L556) | Instance network tags for firewall rule targets. | <code>list(string)</code> | | <code>[]</code> |
|
||||
|
||||
Reference in New Issue
Block a user