From 42289da2a04691fa3cf340541a6c717a120273e9 Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:07:13 +0000 Subject: [PATCH] docs: updates to inputs --- terraform/iaas-cluster-deployment-tf/README.md | 2 +- terraform/iaas-cluster-deployment-tf/inputs.tf | 3 ++- terraform/iaas-cluster-update-tf/README.md | 2 +- terraform/iaas-cluster-update-tf/inputs.tf | 3 ++- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/terraform/iaas-cluster-deployment-tf/README.md b/terraform/iaas-cluster-deployment-tf/README.md index 746706c..c5431b3 100644 --- a/terraform/iaas-cluster-deployment-tf/README.md +++ b/terraform/iaas-cluster-deployment-tf/README.md @@ -73,7 +73,7 @@ No modules. | [aws\_worker\_nodes](#input\_aws\_worker\_nodes) | AWS worker nodes configuration. |
object({
count = string
control_plane = bool
instance_type = string
disk_size_gb = string
availability_zones = list(string)
})
|
{
"availability_zones": [
"us-east-1a"
],
"control_plane": false,
"count": "1",
"disk_size_gb": "60",
"instance_type": "m4.2xlarge"
}
| no | | [azure-cloud-account-name](#input\_azure-cloud-account-name) | The name of your Azure account as assigned in Palette | `string` | `""` | no | | [azure-region](#input\_azure-region) | Azure region | `string` | `"eastus"` | no | -| [azure-use-azs](#input\_azure-use-azs) | A flag for deployment to Azure availability zones. Check if your Azure region provides them. | `bool` | `true` | no | +| [azure-use-azs](#input\_azure-use-azs) | A flag for configuring whether to use Azure Availability Zones. Check if your Azure region supports availability zones by reviewing the [Azure Regions and Availability Zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) resource. | `bool` | `true` | no | | [azure\_master\_nodes](#input\_azure\_master\_nodes) | Azure master nodes configuration. |
object({
count = string
control_plane = bool
instance_type = string
disk_size_gb = string
azs = list(string)
is_system_node_pool = bool
})
|
{
"azs": [
"1"
],
"control_plane": true,
"count": "1",
"disk_size_gb": "60",
"instance_type": "Standard_A8_v2",
"is_system_node_pool": false
}
| no | | [azure\_resource\_group](#input\_azure\_resource\_group) | Azure resource group | `string` | `""` | no | | [azure\_subscription\_id](#input\_azure\_subscription\_id) | Azure subscription ID | `string` | `""` | no | diff --git a/terraform/iaas-cluster-deployment-tf/inputs.tf b/terraform/iaas-cluster-deployment-tf/inputs.tf index 6b60c36..1312b1d 100644 --- a/terraform/iaas-cluster-deployment-tf/inputs.tf +++ b/terraform/iaas-cluster-deployment-tf/inputs.tf @@ -50,12 +50,13 @@ variable "azure_resource_group" { variable "azure-use-azs" { type = bool - description = "A flag for configuring whether to use Azure Availability Zones. Check if your Azure region provides supports availability zones by reviewing the [Azure Regions and Availability Zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) resource" + description = "A flag for configuring whether to use Azure Availability Zones. Check if your Azure region supports availability zones by reviewing the [Azure Regions and Availability Zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) resource" } variable "aws-region" { type = string description = "AWS region" + default = "us-east-1" } variable "gcp-region" { diff --git a/terraform/iaas-cluster-update-tf/README.md b/terraform/iaas-cluster-update-tf/README.md index cbd0ab0..7fa6240 100644 --- a/terraform/iaas-cluster-update-tf/README.md +++ b/terraform/iaas-cluster-update-tf/README.md @@ -91,7 +91,7 @@ No modules. | [azure-cloud-account-name](#input\_azure-cloud-account-name) | The name of your Azure account as assigned in Palette | `string` | `""` | no | | [azure-hello-universe-api-uri](#input\_azure-hello-universe-api-uri) | The URI of the `hello-universe-api service deployed to Azure. | `string` | `"http://REPLACE_ME:3000"` | no | | [azure-region](#input\_azure-region) | Azure region | `string` | `"eastus"` | no | -| [azure-use-azs](#input\_azure-use-azs) | A flag for deployment to Azure availability zones. Check if your Azure region provides them. | `bool` | `true` | no | +| [azure-use-azs](#input\_azure-use-azs) | A flag for configuring whether to use Azure Availability Zones. Check if your Azure region supports availability zones by reviewing the [Azure Regions and Availability Zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) resource. | `bool` | `true` | no | | [azure\_master\_nodes](#input\_azure\_master\_nodes) | Azure master nodes configuration. |
object({
count = string
control_plane = bool
instance_type = string
disk_size_gb = string
azs = list(string)
is_system_node_pool = bool
})
|
{
"azs": [
"1"
],
"control_plane": true,
"count": "1",
"disk_size_gb": "60",
"instance_type": "Standard_A8_v2",
"is_system_node_pool": false
}
| no | | [azure\_resource\_group](#input\_azure\_resource\_group) | Azure resource group | `string` | `""` | no | | [azure\_subscription\_id](#input\_azure\_subscription\_id) | Azure subscription ID | `string` | `""` | no | diff --git a/terraform/iaas-cluster-update-tf/inputs.tf b/terraform/iaas-cluster-update-tf/inputs.tf index b1e94ec..d56bb91 100644 --- a/terraform/iaas-cluster-update-tf/inputs.tf +++ b/terraform/iaas-cluster-update-tf/inputs.tf @@ -50,12 +50,13 @@ variable "azure_resource_group" { variable "azure-use-azs" { type = bool - description = "A flag for configuring whether to use Azure Availability Zones. Check if your Azure region provides them." + description = "A flag for configuring whether to use Azure Availability Zones. Check if your Azure region supports availability zones by reviewing the [Azure Regions and Availability Zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) resource" } variable "aws-region" { type = string description = "AWS region" + default = "us-east-1" } variable "gcp-region" {