Skip to content

Commit

Permalink
chore: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Telemaco019
Telemaco019 committed Aug 5, 2024
1 parent 57cd6ce commit e5ff272
Showing 1 changed file with 34 additions and 20 deletions.
54 changes: 34 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ Available on [Terraform Registry](https://registry.terraform.io/modules/nebuly-a
| <a name="input_aks_log_analytics_workspace"></a> [aks\_log\_analytics\_workspace](#input\_aks\_log\_analytics\_workspace) | Existing azurerm\_log\_analytics\_workspace to attach azurerm\_log\_analytics\_solution. Providing the config disables creation of azurerm\_log\_analytics\_workspace. | <pre>object({<br> id = string<br> name = string<br> location = optional(string)<br> resource_group_name = optional(string)<br> })</pre> | `null` | no |
| <a name="input_aks_net_profile_dns_service_ip"></a> [aks\_net\_profile\_dns\_service\_ip](#input\_aks\_net\_profile\_dns\_service\_ip) | IP address within the Kubernetes service address range that will be used by cluster service discovery (kube-dns). Must be inluced in net\_profile\_cidr. Example: 10.32.0.10 | `string` | n/a | yes |
| <a name="input_aks_net_profile_service_cidr"></a> [aks\_net\_profile\_service\_cidr](#input\_aks\_net\_profile\_service\_cidr) | The Network Range used by the Kubernetes service. Must not overlap with the AKS Nodes address space. Example: 10.32.0.0/24 | `string` | n/a | yes |
| <a name="input_aks_nodes_subnet_name"></a> [aks\_nodes\_subnet\_name](#input\_aks\_nodes\_subnet\_name) | Name of the subnet to be used for provisioning AKS nodes. | `string` | n/a | yes |
| <a name="input_aks_nodes_virtual_network_name"></a> [aks\_nodes\_virtual\_network\_name](#input\_aks\_nodes\_virtual\_network\_name) | Name of the virtual network to be used for provisioning AKS nodes. | `string` | n/a | yes |
| <a name="input_aks_sku_tier"></a> [aks\_sku\_tier](#input\_aks\_sku\_tier) | The AKS tier. Possible values are: Free, Standard, Premium. It is recommended to use Standard or Premium for production workloads. | `string` | `"Standard"` | no |
| <a name="input_aks_sys_pool"></a> [aks\_sys\_pool](#input\_aks\_sys\_pool) | The configuration of the AKS System Nodes Pool. | <pre>object({<br> vm_size : string<br> nodes_max_pods : number<br> name : string<br> availability_zones : list(string)<br> disk_size_gb : number<br> disk_type : string<br> nodes_labels : optional(map(string), {})<br> nodes_tags : optional(map(string), {})<br> only_critical_addons_enabled : optional(bool, false)<br> # Auto-scaling settings<br> nodes_count : optional(number, null)<br> enable_auto_scaling : optional(bool, false)<br> agents_min_count : optional(number, null)<br> agents_max_count : optional(number, null)<br> })</pre> | <pre>{<br> "agents_max_count": 3,<br> "agents_min_count": 1,<br> "availability_zones": [<br> "1",<br> "2",<br> "3"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "name": "system",<br> "nodes_max_pods": 60,<br> "only_critical_addons_enabled": false,<br> "vm_size": "Standard_E4ads_v5"<br>}</pre> | no |
| <a name="input_aks_worker_pools"></a> [aks\_worker\_pools](#input\_aks\_worker\_pools) | The worker pools of the AKS cluster, each with the respective configuration.<br> The default configuration uses a single worker node, with no HA. | <pre>map(object({<br> enabled : optional(bool, true)<br> vm_size : string<br> priority : optional(string, "Regular")<br> tags : map(string)<br> max_pods : number<br> disk_size_gb : optional(number, 128)<br> disk_type : string<br> availability_zones : list(string)<br> node_taints : optional(list(string), [])<br> node_labels : optional(map(string), {})<br> # Auto-scaling settings<br> nodes_count : optional(number, null)<br> enable_auto_scaling : optional(bool, false)<br> nodes_min_count : optional(number, null)<br> nodes_max_count : optional(number, null)<br> }))</pre> | <pre>{<br> "a100w01": {<br> "availability_zones": [<br> "1"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "max_pods": 30,<br> "node_labels": {<br> "nebuly.com/accelerator": "nvidia-ampere-a100"<br> },<br> "node_taints": [<br> "nvidia.com/gpu=:NoSchedule"<br> ],<br> "nodes_count": null,<br> "nodes_max_count": 1,<br> "nodes_min_count": 1,<br> "priority": "Regular",<br> "tags": {},<br> "vm_size": "Standard_NC24ads_A100_v4"<br> },<br> "a100w02": {<br> "availability_zones": [<br> "2"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "max_pods": 30,<br> "node_labels": {<br> "nebuly.com/accelerator": "nvidia-ampere-a100"<br> },<br> "node_taints": [<br> "nvidia.com/gpu=:NoSchedule"<br> ],<br> "nodes_count": null,<br> "nodes_max_count": 1,<br> "nodes_min_count": 0,<br> "priority": "Regular",<br> "tags": {},<br> "vm_size": "Standard_NC24ads_A100_v4"<br> },<br> "a100w03": {<br> "availability_zones": [<br> "3"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "max_pods": 30,<br> "node_labels": {<br> "nebuly.com/accelerator": "nvidia-ampere-a100"<br> },<br> "node_taints": [<br> "nvidia.com/gpu=:NoSchedule"<br> ],<br> "nodes_count": null,<br> "nodes_max_count": 1,<br> "nodes_min_count": 0,<br> "priority": "Regular",<br> "tags": {},<br> "vm_size": "Standard_NC24ads_A100_v4"<br> },<br> "t4workers": {<br> "availability_zones": [<br> "1",<br> "2",<br> "3"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "max_pods": 30,<br> "node_labels": {<br> "nebuly.com/accelerator": "nvidia-tesla-t4"<br> },<br> "node_taints": [<br> "nvidia.com/gpu=:NoSchedule"<br> ],<br> "nodes_count": null,<br> "nodes_max_count": 1,<br> "nodes_min_count": 0,<br> "priority": "Regular",<br> "tags": {},<br> "vm_size": "Standard_NC4as_T4_v3"<br> },<br> "workers01": {<br> "availability_zones": [<br> "1",<br> "2",<br> "3"<br> ],<br> "disk_size_gb": 128,<br> "disk_type": "Ephemeral",<br> "enable_auto_scaling": true,<br> "max_pods": 30,<br> "nodes_count": 1,<br> "nodes_max_count": 3,<br> "nodes_min_count": 1,<br> "priority": "Regular",<br> "tags": {},<br> "vm_size": "Standard_E4ads_v5"<br> }<br>}</pre> | no |
Expand All @@ -67,30 +65,46 @@ Available on [Terraform Registry](https://registry.terraform.io/modules/nebuly-a
| <a name="input_postgres_server_point_in_time_backup"></a> [postgres\_server\_point\_in\_time\_backup](#input\_postgres\_server\_point\_in\_time\_backup) | The backup settings of the PostgreSQL Server. | <pre>object({<br> geo_redundant : optional(bool, true)<br> retention_days : optional(number, 30)<br> })</pre> | <pre>{<br> "geo_redundant": true,<br> "retention_days": 30<br>}</pre> | no |
| <a name="input_postgres_server_sku"></a> [postgres\_server\_sku](#input\_postgres\_server\_sku) | The SKU of the PostgreSQL Server, including the Tier and the Name. Examples: B\_Standard\_B1ms, GP\_Standard\_D2s\_v3, MO\_Standard\_E4s\_v3 | <pre>object({<br> tier : string<br> name : string<br> })</pre> | <pre>{<br> "name": "Standard_D4ds_v5",<br> "tier": "GP"<br>}</pre> | no |
| <a name="input_postgres_version"></a> [postgres\_version](#input\_postgres\_version) | The PostgreSQL version to use. | `string` | `"16"` | no |
| <a name="input_private_dns_zones"></a> [private\_dns\_zones](#input\_private\_dns\_zones) | Private DNS zones to use for Private Endpoint connections. If not provided, a new DNS Zone <br> is created and linked to the respective subnet. | <pre>object({<br> file = optional(object({<br> name : string<br> id : string<br> }), null)<br> blob = optional(object({<br> name : string<br> id : string<br> }), null)<br> dfs = optional(object({<br> name : string<br> id : string<br> }), null)<br> })</pre> | `{}` | no |
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | The name of the resource group where to provision the resources. | `string` | n/a | yes |
| <a name="input_resource_prefix"></a> [resource\_prefix](#input\_resource\_prefix) | The prefix that will be used for generating resource names. | `string` | n/a | yes |
| <a name="input_subnet_name_aks_nodes"></a> [subnet\_name\_aks\_nodes](#input\_subnet\_name\_aks\_nodes) | Name of the subnet to be used for provisioning AKS nodes. | `string` | n/a | yes |
| <a name="input_subnet_name_private_endpoints"></a> [subnet\_name\_private\_endpoints](#input\_subnet\_name\_private\_endpoints) | Optional name of the subnet to which attach the Private Endpoints. <br> If not provided, the same network used for AKS nodes will be used. | `string` | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Common tags that will be applied to all resources. | `map(string)` | `{}` | no |
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | Name of the virtual network in which to create the resources. | `string` | n/a | yes |

## Resources


- resource.azurerm_key_vault.main (/terraform-docs/main.tf#63)
- resource.azurerm_key_vault_secret.openai_api_key (/terraform-docs/main.tf#127)
- resource.azurerm_key_vault_secret.postgres_passwords (/terraform-docs/main.tf#283)
- resource.azurerm_key_vault_secret.postgres_users (/terraform-docs/main.tf#272)
- resource.azurerm_kubernetes_cluster_node_pool.linux_pools (/terraform-docs/main.tf#372)
- resource.azurerm_management_lock.postgres_server (/terraform-docs/main.tf#215)
- resource.azurerm_monitor_metric_alert.postgres_server_alerts (/terraform-docs/main.tf#223)
- resource.azurerm_postgresql_flexible_server.main (/terraform-docs/main.tf#141)
- resource.azurerm_postgresql_flexible_server_configuration.mandatory_configurations (/terraform-docs/main.tf#192)
- resource.azurerm_postgresql_flexible_server_configuration.optional_configurations (/terraform-docs/main.tf#185)
- resource.azurerm_postgresql_flexible_server_database.main (/terraform-docs/main.tf#207)
- resource.azurerm_postgresql_flexible_server_firewall_rule.main (/terraform-docs/main.tf#199)
- resource.azurerm_private_endpoint.key_vault (/terraform-docs/main.tf#89)
- resource.azurerm_role_assignment.key_vault_secret_officer__current (/terraform-docs/main.tf#119)
- resource.azurerm_role_assignment.key_vault_secret_user__aks (/terraform-docs/main.tf#114)
- resource.random_password.postgres_server_admin_password (/terraform-docs/main.tf#136)
- resource.tls_private_key.aks (/terraform-docs/main.tf#299)
- resource.azurerm_key_vault.main (/terraform-docs/main.tf#131)
- resource.azurerm_key_vault_secret.openai_api_key (/terraform-docs/main.tf#196)
- resource.azurerm_key_vault_secret.postgres_passwords (/terraform-docs/main.tf#352)
- resource.azurerm_key_vault_secret.postgres_users (/terraform-docs/main.tf#341)
- resource.azurerm_kubernetes_cluster_node_pool.linux_pools (/terraform-docs/main.tf#518)
- resource.azurerm_management_lock.postgres_server (/terraform-docs/main.tf#284)
- resource.azurerm_monitor_metric_alert.postgres_server_alerts (/terraform-docs/main.tf#292)
- resource.azurerm_postgresql_flexible_server.main (/terraform-docs/main.tf#210)
- resource.azurerm_postgresql_flexible_server_configuration.mandatory_configurations (/terraform-docs/main.tf#261)
- resource.azurerm_postgresql_flexible_server_configuration.optional_configurations (/terraform-docs/main.tf#254)
- resource.azurerm_postgresql_flexible_server_database.main (/terraform-docs/main.tf#276)
- resource.azurerm_postgresql_flexible_server_firewall_rule.main (/terraform-docs/main.tf#268)
- resource.azurerm_private_dns_zone.blob (/terraform-docs/main.tf#92)
- resource.azurerm_private_dns_zone.dfs (/terraform-docs/main.tf#110)
- resource.azurerm_private_dns_zone.file (/terraform-docs/main.tf#74)
- resource.azurerm_private_dns_zone_virtual_network_link.blob (/terraform-docs/main.tf#98)
- resource.azurerm_private_dns_zone_virtual_network_link.dfs (/terraform-docs/main.tf#116)
- resource.azurerm_private_dns_zone_virtual_network_link.file (/terraform-docs/main.tf#80)
- resource.azurerm_private_endpoint.blob (/terraform-docs/main.tf#381)
- resource.azurerm_private_endpoint.dfs (/terraform-docs/main.tf#421)
- resource.azurerm_private_endpoint.file (/terraform-docs/main.tf#401)
- resource.azurerm_private_endpoint.key_vault (/terraform-docs/main.tf#157)
- resource.azurerm_role_assignment.key_vault_secret_officer__current (/terraform-docs/main.tf#187)
- resource.azurerm_role_assignment.key_vault_secret_user__aks (/terraform-docs/main.tf#182)
- resource.azurerm_storage_account.main (/terraform-docs/main.tf#367)
- resource.random_password.postgres_server_admin_password (/terraform-docs/main.tf#205)
- resource.tls_private_key.aks (/terraform-docs/main.tf#445)
- data source.azurerm_client_config.current (/terraform-docs/main.tf#51)
- data source.azurerm_resource_group.main (/terraform-docs/main.tf#48)
- data source.azurerm_subnet.aks_nodes (/terraform-docs/main.tf#53)
- data source.azurerm_subnet.aks_nodes (/terraform-docs/main.tf#57)
- data source.azurerm_subnet.private_endpoints (/terraform-docs/main.tf#62)
- data source.azurerm_virtual_network.main (/terraform-docs/main.tf#53)

0 comments on commit e5ff272

Please sign in to comment.