Sync Terraform module documentation

products/terraform/docs/swfw/azure/vmseries/modules/bootstrap.md

@@ -104,6 +104,7 @@ No modules.
 | <a name="input_location"></a> [location](#input\_location) | Region to deploy bootstrap resources. Ignored when `create_storage_account` is set to `false`. | `string` | `null` | no |
 | <a name="input_min_tls_version"></a> [min\_tls\_version](#input\_min\_tls\_version) | The minimum supported TLS version for the storage account. | `string` | `"TLS1_2"` | no |
 | <a name="input_files"></a> [files](#input\_files) | Map of all files to copy to bucket. The keys are local paths, the values are remote paths.<br />Always use slash `/` as directory separator (unix-like), not the backslash `\`.<br />Example:<pre>files = {<br />  "dir/my.txt" = "config/init-cfg.txt"<br />}</pre> | `map(string)` | `{}` | no |
+| <a name="input_bootstrap_files_dir"></a> [bootstrap\_files\_dir](#input\_bootstrap\_files\_dir) | Bootstrap file directory. If the variable has a value of `null` (default) - then it will not upload any other files other than the ones specified in the `files` variable. More information can be found at https://docs.paloaltonetworks.com/vm-series/9-1/vm-series-deployment/bootstrap-the-vm-series-firewall/bootstrap-package. | `string` | `null` | no |
 | <a name="input_files_md5"></a> [files\_md5](#input\_files\_md5) | Optional map of MD5 hashes of file contents.<br />Normally the map could be empty, because all the files that exist before the `terraform apply` will have their hashes auto-calculated.<br />This input is necessary only for the selected files which are created/modified within the same Terraform run as this module.<br />The keys of the map should be identical with selected keys of the `files` input, while the values should be MD5 hashes of the contents of that file.<br /><br />Example:<pre>files\_md5 = {<br />    "dir/my.txt" = "6f7ce3191b50a58cc13e751a8f7ae3fd"<br />}</pre> | `map(string)` | `{}` | no |
 | <a name="input_storage_share_name"></a> [storage\_share\_name](#input\_storage\_share\_name) | Name of a storage File Share to be created that will hold `files` used for bootstrapping.<br />For rules defining a valid name see [Microsoft documentation](https://docs.microsoft.com/en-us/rest/api/storageservices/Naming-and-Referencing-Shares--Directories--Files--and-Metadata#share-names). | `string` | `null` | no |
 | <a name="input_storage_share_quota"></a> [storage\_share\_quota](#input\_storage\_share\_quota) | Maximum size of a File Share. | `number` | `50` | no |

products/terraform/docs/swfw/azure/vmseries/reference-architectures/dedicated_vmseries_and_autoscale.md

@@ -211,7 +211,7 @@ terraform destroy
 | <a name="input_vmseries_sku"></a> [vmseries\_sku](#input\_vmseries\_sku) | VM-Series SKU - list available with `az vm image list -o table --all --publisher paloaltonetworks` | `string` | `"byol"` | no |
 | <a name="input_vmseries_username"></a> [vmseries\_username](#input\_vmseries\_username) | Initial administrative username to use for all systems. | `string` | `"panadmin"` | no |
 | <a name="input_vmseries_password"></a> [vmseries\_password](#input\_vmseries\_password) | Initial administrative password to use for all systems. Set to null for an auto-generated password. | `string` | `null` | no |
-| <a name="input_vmss"></a> [vmss](#input\_vmss) | A map defining all Virtual Machine Scale Sets.<br /><br />For detailed documentation on how to configure this resource, for available properties, especially for the defaults refer to [module documentation](../../modules/vmss)<br /><br />Following properties are available:<br />- `name` : (string\|required) name of the Virtual Machine Scale Set.<br />- `vm_size` : size of the VMSeries virtual machines created with this Scale Set, when specified overrides `var.vmseries_vm_size`.<br />- `version` : PanOS version, when specified overrides `var.vmseries_version`.<br />- `vnet_key` : (string\|required) a key of a VNET defined in the `var.vnets` map.<br />- `bootstrap_options` : (string\|`''`) bootstrap options passed to every VM instance upon creation.<br />- `zones` : (list(string)\|`[]`) a list of Availability Zones to use for Zone redundancy<br />- `encryption_at_host_enabled` : (bool\|`null` - Azure defaults) should all of the disks attached to this Virtual Machine be encrypted<br />- `overprovision` : (bool\|`null` - module defaults) when provisioning new VM, multiple will be provisioned but the 1st one to run will be kept<br />- `platform_fault_domain_count` : (number\|`null` - Azure defaults) number of fault domains to use<br />- `proximity_placement_group_id` : (string\|`null`) ID of a proximity placement group the VMSS should be placed in<br />- `scale_in_policy` : (string\|`null` - Azure defaults) policy of removing VMs when scaling in<br />- `scale_in_force_deletion` : (bool\|`null` - module default) forces (`true`) deletion of VMs during scale in<br />- `single_placement_group` : (bool\|`null` - Azure defaults) limit the Scale Set to one Placement Group<br />- `storage_account_type` : (string\|`null` - module defaults) type of managed disk that will be used on all VMs<br />- `disk_encryption_set_id` : (string\|`null`) the ID of the Disk Encryption Set which should be used to encrypt this Data Disk<br />- `accelerated_networking` : (bool\|`null`- module defaults) enable Azure accelerated networking for all dataplane network interfaces<br />- `use_custom_image` : (bool\|`false`) <br />- `custom_image_id` : (string\|reqquired when `use_custom_image` is `true`) absolute ID of your own Custom Image to be used for creating new VM-Series<br />- `application_insights_id` : (string\|`null`) ID of Application Insights instance that should be used to provide metrics for autoscaling<br />- `interfaces` : (list(string)\|`[]`) configuration of all NICs assigned to a VM. A list of maps, each map is a NIC definition. Notice that the order DOES matter. NICs are attached to VMs in Azure in the order they are defined in this list, therefore the management interface has to be defined first. Following properties are available:<br />  - `name` : (string\|required) string that will form the NIC name<br />  - `subnet_key` : (string\|required) a key of a subnet as defined in `var.vnets`<br />  - `create_pip` : (bool\|`false`) flag to create Public IP for an interface, defaults to `false`<br />  - `load_balancer_key` : (string\|`null`) key of a Load Balancer defined in the `var.loadbalancers` variable<br />  - `application_gateway_key` : (string\|`null`) key of an Application Gateway defined in the `var.appgws`<br />  - `pip_domain_name_label` : (string\|`null`) prefix which should be used for the Domain Name Label for each VM instance<br />- `autoscale_config` : (map\|`{}`) map containing basic autoscale configuration<br />  - `count_default` : (number\|`null` - module defaults) default number or instances when autoscalling is not available<br />  - `count_minimum` : (number\|`null` - module defaults) minimum number of instances to reach when scaling in<br />  - `count_maximum` : (number\|`null` - module defaults) maximum number of instances when scaling out<br />  - `notification_emails` : (list(string)\|`null` - module defaults) a list of e-mail addresses to notify about scaling events<br />- `autoscale_metrics` : (map\|`{}`) metrics and thresholds used to trigger scaling events, see module documentation for details<br />- `scaleout_config` : (map\|`{}`) scale out configuration, for details see module documentation<br />  - `statistic` : (string\|`null` - module defaults) aggregation method for statistics coming from different VMs<br />  - `time_aggregation` : (string\|`null` - module defaults) aggregation method applied to statistics in time window<br />  - `window_minutes` : (string\|`null` - module defaults) time windows used to analyze statistics<br />  - `cooldown_minutes` : (string\|`null` - module defaults) time to wait after a scaling event before analyzing the statistics again<br />- `scalein_config` : (map\|`{}`) scale in configuration, same properties supported as for `scaleout_config`<br /><br />Example, no auto scaling:<pre>{<br />"vmss" = {<br />  name              = "ngfw-vmss"<br />  vnet\_key          = "transit"<br />  bootstrap\_options = "type=dhcp"<br /><br />  interfaces = [<br />    {<br />      name       = "management"<br />      subnet\_key = "management"<br />    },<br />    {<br />      name       = "private"<br />      subnet\_key = "private"<br />    },<br />    {<br />      name                    = "public"<br />      subnet\_key              = "public"<br />      load\_balancer\_key       = "public"<br />      application\_gateway\_key = "public"<br />    }<br />  ]<br />}</pre> | `any` | `{}` | no |
+| <a name="input_vmss"></a> [vmss](#input\_vmss) | A map defining all Virtual Machine Scale Sets.<br /><br />For detailed documentation on how to configure this resource, for available properties, especially for the defaults refer to [module documentation](../../modules/vmss)<br /><br />Following properties are available:<br />- `name` : (string\|required) name of the Virtual Machine Scale Set.<br />- `vm_size` : size of the VMSeries virtual machines created with this Scale Set, when specified overrides `var.vmseries_vm_size`.<br />- `version` : PanOS version, when specified overrides `var.vmseries_version`.<br />- `vnet_key` : (string\|required) a key of a VNET defined in the `var.vnets` map.<br />- `bootstrap_options` : (string\|`''`) bootstrap options passed to every VM instance upon creation.<br />- `zones` : (list(string)\|`[]`) a list of Availability Zones to use for Zone redundancy<br />- `encryption_at_host_enabled` : (bool\|`null` - Azure defaults) should all of the disks attached to this Virtual Machine be encrypted<br />- `overprovision` : (bool\|`null` - module defaults) when provisioning new VM, multiple will be provisioned but the 1st one to run will be kept<br />- `platform_fault_domain_count` : (number\|`null` - Azure defaults) number of fault domains to use<br />- `proximity_placement_group_id` : (string\|`null`) ID of a proximity placement group the VMSS should be placed in<br />- `scale_in_policy` : (string\|`null` - Azure defaults) policy of removing VMs when scaling in<br />- `scale_in_force_deletion` : (bool\|`null` - module default) forces (`true`) deletion of VMs during scale in<br />- `single_placement_group` : (bool\|`null` - Azure defaults) limit the Scale Set to one Placement Group<br />- `storage_account_type` : (string\|`null` - module defaults) type of managed disk that will be used on all VMs<br />- `disk_encryption_set_id` : (string\|`null`) the ID of the Disk Encryption Set which should be used to encrypt this Data Disk<br />- `accelerated_networking` : (bool\|`null`- module defaults) enable Azure accelerated networking for all dataplane network interfaces<br />- `use_custom_image` : (bool\|`false`) <br />- `custom_image_id` : (string\|reqquired when `use_custom_image` is `true`) absolute ID of your own Custom Image to be used for creating new VM-Series<br />- `application_insights_id` : (string\|`null`) ID of Application Insights instance that should be used to provide metrics for autoscaling<br />- `interfaces` : (list(string)\|`[]`) configuration of all NICs assigned to a VM. A list of maps, each map is a NIC definition. Notice that the order DOES matter. NICs are attached to VMs in Azure in the order they are defined in this list, therefore the management interface has to be defined first. Following properties are available:<br />  - `name` : (string\|required) string that will form the NIC name<br />  - `subnet_key` : (string\|required) a key of a subnet as defined in `var.vnets`<br />  - `create_pip` : (bool\|`false`) flag to create Public IP for an interface, defaults to `false`<br />  - `load_balancer_key` : (string\|`null`) key of a Load Balancer defined in the `var.loadbalancers` variable<br />  - `application_gateway_key` : (string\|`null`) key of an Application Gateway defined in the `var.appgws`<br />  - `pip_domain_name_label` : (string\|`null`) prefix which should be used for the Domain Name Label for each VM instance<br />- `autoscale_config` : (map\|`{}`) map containing basic autoscale configuration<br />  - `count_default` : (number\|`null` - module defaults) default number or instances when autoscalling is not available<br />  - `count_minimum` : (number\|`null` - module defaults) minimum number of instances to reach when scaling in<br />  - `count_maximum` : (number\|`null` - module defaults) maximum number of instances when scaling out<br />  - `notification_emails` : (list(string)\|`null` - module defaults) a list of e-mail addresses to notify about scaling events<br />- `autoscale_metrics` : (map\|`{}`) metrics and thresholds used to trigger scaling events, see module documentation for details<br />- `scaleout_config` : (map\|`{}`) scale out configuration, for details see module documentation<br />  - `statistic` : (string\|`null` - module defaults) aggregation method for statistics coming from different VMs<br />  - `time_aggregation` : (string\|`null` - module defaults) aggregation method applied to statistics in time window<br />  - `window_minutes` : (string\|`null` - module defaults) time windows used to analyze statistics<br />  - `cooldown_minutes` : (string\|`null` - module defaults) time to wait after a scaling event before analyzing the statistics again<br />- `scalein_config` : (map\|`{}`) scale in configuration, same properties supported as for `scaleout_config`<br /><br />Example, no auto scaling:<pre>{<br />"vmss" = {<br />  name              = "ngfw-vmss"<br />  vnet\_key          = "transit"<br />  bootstrap\_options = "type=dhcp-client"<br /><br />  interfaces = [<br />    {<br />      name       = "management"<br />      subnet\_key = "management"<br />    },<br />    {<br />      name       = "private"<br />      subnet\_key = "private"<br />    },<br />    {<br />      name                    = "public"<br />      subnet\_key              = "public"<br />      load\_balancer\_key       = "public"<br />      application\_gateway\_key = "public"<br />    }<br />  ]<br />}</pre> | `any` | `{}` | no |
 | <a name="input_appgws"></a> [appgws](#input\_appgws) | A map defining all Application Gateways in the current deployment.<br /><br />For detailed documentation on how to configure this resource, for available properties, especially for the defaults and the `rules` property refer to [module documentation](../../modules/appgw).<br /><br />Following properties are supported:<br />- `name` : name of the Application Gateway.<br />- `vnet_key` : a key of a VNET defined in the `var.vnets` map.<br />- `subnet_key` : a key of a subnet as defined in `var.vnets`. This has to be a subnet dedicated to Application Gateways v2.<br />- `vnet_key` : a key of a VNET defined in the `var.vnets` map.<br />- `subnet_key` : a key of a subnet as defined in `var.vnets`. This has to be a subnet dedicated to Application Gateways v2.<br />- `zones` : for zonal deployment this is a list of all zones in a region - this property is used by both: the Application Gateway and the Public IP created in front of the AppGW.<br />- `capacity` : (optional) number of Application Gateway instances, not used when autoscalling is enabled (see `capacity_min`)<br />- `capacity_min` : (optional) when set enables autoscaling and becomes the minimum capacity<br />- `capacity_max` : (optional) maximum capacity for autoscaling<br />- `enable_http2` : enable HTTP2 support on the Application Gateway<br />- `waf_enabled` : (optional) enables WAF Application Gateway, defining WAF rules is not supported, defaults to `false`<br />- `vmseries_public_nic_name` : name of the public VMSeries interface as defined in `interfaces` property.<br />- `managed_identities` : (optional) a list of existing User-Assigned Managed Identities, which Application Gateway uses to retrieve certificates from Key Vault<br />- `ssl_policy_type` : (optional) type of an SSL policy, defaults to `Predefined`<br />- `ssl_policy_name` : (optional) name of an SSL policy, for `ssl_policy_type` set to `Predefined`<br />- `ssl_policy_min_protocol_version` : (optional) minimum version of the TLS protocol for SSL Policy, for `ssl_policy_type` set to `Custom`<br />- `ssl_policy_cipher_suites` : (optional) a list of accepted cipher suites, for `ssl_policy_type` set to `Custom`<br />- `ssl_profiles` : (optional) a map of SSL profiles that can be later on referenced in HTTPS listeners by providing a name of the profile in the `ssl_profile_name` property | `map` | `{}` | no |
 
 ### Outputs