Skip to content

Commit

Permalink
docs(modules/vmseries): Adjust description for image variables
Browse files Browse the repository at this point in the history
  • Loading branch information
michalbil committed Apr 15, 2024
1 parent 7a6761c commit 3f338a9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions modules/vmseries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ No modules.
|------|-------------|------|---------|:--------:|
| <a name="input_bootstrap_options"></a> [bootstrap\_options](#input\_bootstrap\_options) | VM-Series bootstrap options to pass using instance metadata.<br><br>Proper syntax is a map, where keys are the bootstrap parameters.<br>Example:<br> bootstrap\_options = {<br> type = dhcp-client<br> panorama-server = 1.2.3.4<br> }<br><br>A list of available parameters: type, ip-address, default-gateway, netmask, ipv6-address, ipv6-default-gateway, hostname, panorama-server, panorama-server-2, tplname, dgname, dns-primary, dns-secondary, vm-auth-key, op-command-modes, op-cmd-dpdk-pkt-io, plugin-op-commands, dhcp-send-hostname, dhcp-send-client-id, dhcp-accept-server-hostname, dhcp-accept-server-domain, vm-series-auto-registration-pin-id, vm-series-auto-registration-pin-value, auth-key, authcodes, vmseries-bootstrap-gce-storagebucket, mgmt-interface-swap.<br><br>For more details on the options please refer to [VM-Series documentation](https://docs.paloaltonetworks.com/vm-series/10-2/vm-series-deployment/bootstrap-the-vm-series-firewall/create-the-init-cfgtxt-file/init-cfgtxt-file-components). | `map(string)` | `{}` | no |
| <a name="input_create_instance_group"></a> [create\_instance\_group](#input\_create\_instance\_group) | Create an instance group, that can be used in a load balancer setup. | `bool` | `false` | no |
| <a name="input_custom_image"></a> [custom\_image](#input\_custom\_image) | The full URI to GCE image resource, the output of `gcloud compute images list --uri`. Overrides official image specified using `vmseries_image`. | `string` | `null` | no |
| <a name="input_custom_image"></a> [custom\_image](#input\_custom\_image) | The full URI of GCE image resource, as returned in the output of a following command:<br> `gcloud compute images list --filter="<filter>" --project <project> --no-standard-images --uri`<br> Overrides official image specified using `vmseries_image`." | `string` | `null` | no |
| <a name="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection) | Enable deletion protection on the instance. | `bool` | `false` | no |
| <a name="input_dependencies"></a> [dependencies](#input\_dependencies) | n/a | `list(string)` | `[]` | no |
| <a name="input_disk_type"></a> [disk\_type](#input\_disk\_type) | Boot disk type. See [provider documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_instance#type) for available values. | `string` | `"pd-standard"` | no |
Expand All @@ -63,7 +63,7 @@ No modules.
| <a name="input_service_account"></a> [service\_account](#input\_service\_account) | IAM Service Account for running firewall instance (just the email) | `string` | `null` | no |
| <a name="input_ssh_keys"></a> [ssh\_keys](#input\_ssh\_keys) | Public keys to allow SSH access for, separated by newlines. | `string` | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | GCP instance tags. | `list(string)` | `[]` | no |
| <a name="input_vmseries_image"></a> [vmseries\_image](#input\_vmseries\_image) | The image name from which to boot an instance, including the license type and the version.<br> To get a list of available official images, please run the following command:<br> `gcloud compute images list --filter="name ~ vmseries" --project paloaltonetworksgcp-public --no-standard-images` | `string` | `"vmseries-flex-bundle1-1008h8"` | no |
| <a name="input_vmseries_image"></a> [vmseries\_image](#input\_vmseries\_image) | The image name from which to boot an instance, including a license type (bindle/flex) and version.<br> To get a list of available official images, please run the following command:<br> `gcloud compute images list --filter="family ~ vmseries" --project paloaltonetworksgcp-public --no-standard-images` | `string` | `"vmseries-flex-byol-10112"` | no |
| <a name="input_zone"></a> [zone](#input\_zone) | Zone to deploy instance in. | `string` | n/a | yes |

### Outputs
Expand Down
12 changes: 8 additions & 4 deletions modules/vmseries/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,20 @@ variable "scopes" {

variable "vmseries_image" {
description = <<EOF
The image name from which to boot an instance, including the license type and the version.
The image name from which to boot an instance, including a license type (bindle/flex) and version.
To get a list of available official images, please run the following command:
`gcloud compute images list --filter="name ~ vmseries" --project paloaltonetworksgcp-public --no-standard-images`
`gcloud compute images list --filter="family ~ vmseries" --project paloaltonetworksgcp-public --no-standard-images`
EOF
default = "vmseries-flex-bundle1-1008h8"
default = "vmseries-flex-byol-10112"
type = string
}

variable "custom_image" {
description = "The full URI to GCE image resource, the output of `gcloud compute images list --uri`. Overrides official image specified using `vmseries_image`."
description = <<EOF
The full URI of GCE image resource, as returned in the output of a following command:
`gcloud compute images list --filter="<filter>" --project <project> --no-standard-images --uri`
Overrides official image specified using `vmseries_image`."
EOF
default = null
type = string
}
Expand Down

0 comments on commit 3f338a9

Please sign in to comment.