From ae7eee03b22d3196e03efe39963aad5aed729c4a Mon Sep 17 00:00:00 2001 From: Michele Zanotti Date: Mon, 5 Aug 2024 11:22:45 +0200 Subject: [PATCH] update doc --- Makefile | 2 +- README.md | 43 +++++++++++++++++++++++++++++++------------ 2 files changed, 32 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index 59d4ff5..84593d9 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,7 @@ help: ## Display this help. ##@ Dev .PHONY: doc doc: ## Generate the doc - docker run --rm --volume "$$(pwd):/terraform-docs" -u $$(id -u) quay.io/terraform-docs/terraform-docs:0.16.0 markdown /terraform-docs > README.md + docker run --rm --volume "$$(pwd):/terraform-docs" -u $$(id -u) quay.io/terraform-docs/terraform-docs:latest markdown /terraform-docs > README.md .PHONY: lint diff --git a/README.md b/README.md index 0e7bb76..e5b50aa 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Available on [Terraform Registry](https://registry.terraform.io/modules/nebuly-a |------|---------| | [azurerm](#provider\_azurerm) | 3.114.0 | | [random](#provider\_random) | 3.6.2 | +| [tls](#provider\_tls) | 4.0.5 | ## Outputs @@ -32,6 +33,17 @@ No outputs. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| +| [aks\_api\_server\_allowed\_ip\_addresses](#input\_aks\_api\_server\_allowed\_ip\_addresses) | Map containing the IP addresses that are allwed to access the AKS API Server. The keys of the map are used only for documentation purpose. | `map(string)` | `{}` | no | +| [aks\_cluster\_admin\_object\_ids](#input\_aks\_cluster\_admin\_object\_ids) | Object IDs that will be granted the Cluster Admin role over the AKS cluster | `set(string)` | n/a | yes | +| [aks\_kubernetes\_version](#input\_aks\_kubernetes\_version) | The Kubernetes version to use. | `string` | `"1.29.5"` | no | +| [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. | 
object({
    id                  = string
    name                = string
    location            = optional(string)
    resource_group_name = optional(string)
  })
| `null` | no | +| [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 | +| [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 | +| [aks\_nodes\_subnet\_name](#input\_aks\_nodes\_subnet\_name) | Name of the subnet to be used for provisioning AKS nodes. | `string` | n/a | yes | +| [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 | +| [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 | +| [aks\_sys\_pool](#input\_aks\_sys\_pool) | The configuration of the AKS System Nodes Pool. | 
object({
    vm_size : string
    nodes_max_pods : number
    name : string
    availability_zones : list(string)
    disk_size_gb : number
    disk_type : string
    nodes_labels : optional(map(string), {})
    nodes_tags : optional(map(string), {})
    only_critical_addons_enabled : optional(bool, false)
    # Auto-scaling settings
    nodes_count : optional(number, null)
    enable_auto_scaling : optional(bool, false)
    agents_min_count : optional(number, null)
    agents_max_count : optional(number, null)
  })
| 
{
  "agents_max_count": 3,
  "agents_min_count": 1,
  "availability_zones": [
    "1",
    "2",
    "3"
  ],
  "disk_size_gb": 128,
  "disk_type": "Ephemeral",
  "enable_auto_scaling": true,
  "name": "system",
  "nodes_max_pods": 60,
  "only_critical_addons_enabled": false,
  "vm_size": "Standard_E4ads_v5"
}
| no | +| [aks\_worker\_pools](#input\_aks\_worker\_pools) | The worker pools of the AKS cluster, each with the respective configuration.
The default configuration uses a single worker node, with no HA. | 
map(object({
    enabled : optional(bool, true)
    vm_size : string
    priority : optional(string, "Regular")
    tags : map(string)
    max_pods : number
    disk_size_gb : optional(number, 128)
    disk_type : string
    availability_zones : list(string)
    node_taints : optional(list(string), [])
    node_labels : optional(map(string), {})
    # Auto-scaling settings
    nodes_count : optional(number, null)
    enable_auto_scaling : optional(bool, false)
    nodes_min_count : optional(number, null)
    nodes_max_count : optional(number, null)
  }))
| 
{
  "a100w01": {
    "availability_zones": [
      "1"
    ],
    "disk_size_gb": 128,
    "disk_type": "Ephemeral",
    "enable_auto_scaling": true,
    "max_pods": 30,
    "node_labels": {
      "nebuly.com/accelerator": "nvidia-ampere-a100"
    },
    "node_taints": [
      "nvidia.com/gpu=:NoSchedule"
    ],
    "nodes_count": null,
    "nodes_max_count": 1,
    "nodes_min_count": 1,
    "priority": "Regular",
    "tags": {},
    "vm_size": "Standard_NC24ads_A100_v4"
  },
  "a100w02": {
    "availability_zones": [
      "2"
    ],
    "disk_size_gb": 128,
    "disk_type": "Ephemeral",
    "enable_auto_scaling": true,
    "max_pods": 30,
    "node_labels": {
      "nebuly.com/accelerator": "nvidia-ampere-a100"
    },
    "node_taints": [
      "nvidia.com/gpu=:NoSchedule"
    ],
    "nodes_count": null,
    "nodes_max_count": 1,
    "nodes_min_count": 0,
    "priority": "Regular",
    "tags": {},
    "vm_size": "Standard_NC24ads_A100_v4"
  },
  "a100w03": {
    "availability_zones": [
      "3"
    ],
    "disk_size_gb": 128,
    "disk_type": "Ephemeral",
    "enable_auto_scaling": true,
    "max_pods": 30,
    "node_labels": {
      "nebuly.com/accelerator": "nvidia-ampere-a100"
    },
    "node_taints": [
      "nvidia.com/gpu=:NoSchedule"
    ],
    "nodes_count": null,
    "nodes_max_count": 1,
    "nodes_min_count": 0,
    "priority": "Regular",
    "tags": {},
    "vm_size": "Standard_NC24ads_A100_v4"
  },
  "t4workers": {
    "availability_zones": [
      "1",
      "2",
      "3"
    ],
    "disk_size_gb": 128,
    "disk_type": "Ephemeral",
    "enable_auto_scaling": true,
    "max_pods": 30,
    "node_labels": {
      "nebuly.com/accelerator": "nvidia-tesla-t4"
    },
    "node_taints": [
      "nvidia.com/gpu=:NoSchedule"
    ],
    "nodes_count": null,
    "nodes_max_count": 1,
    "nodes_min_count": 0,
    "priority": "Regular",
    "tags": {},
    "vm_size": "Standard_NC4as_T4_v3"
  },
  "workers01": {
    "availability_zones": [
      "1",
      "2",
      "3"
    ],
    "disk_size_gb": 128,
    "disk_type": "Ephemeral",
    "enable_auto_scaling": true,
    "max_pods": 30,
    "nodes_count": 1,
    "nodes_max_count": 3,
    "nodes_min_count": 1,
    "priority": "Regular",
    "tags": {},
    "vm_size": "Standard_E4ads_v5"
  }
}
| no | | [key\_vault\_network\_acls](#input\_key\_vault\_network\_acls) | Optional configuration of network ACLs. | 
object({
    bypass : string
    default_action : string
    ip_rules : list(string)
    virtual_network_subnet_ids : list(string)
  })
| `null` | no | | [key\_vault\_private\_dns\_zone](#input\_key\_vault\_private\_dns\_zone) | Optional Private DNS Zone to link with the Key Vault when private endpoint integration is enabled. | 
object({
    id : string
    name : string
  })
| `null` | no | | [key\_vault\_private\_endpoints](#input\_key\_vault\_private\_endpoints) | Optional Private Endpoints to link with the Key Vault. | 
map(object({
    subnet_id = string
    vnet_id   = string
  }))
| `{}` | no | @@ -59,15 +71,22 @@ No outputs. ## Resources -- resource.azurerm_key_vault.main (/terraform-docs/main.tf#187) -- resource.azurerm_management_lock.postgres_server (/terraform-docs/main.tf#126) -- resource.azurerm_monitor_metric_alert.postgres_server_alerts (/terraform-docs/main.tf#134) -- resource.azurerm_postgresql_flexible_server.main (/terraform-docs/main.tf#52) -- resource.azurerm_postgresql_flexible_server_configuration.mandatory_configurations (/terraform-docs/main.tf#103) -- resource.azurerm_postgresql_flexible_server_configuration.optional_configurations (/terraform-docs/main.tf#96) -- resource.azurerm_postgresql_flexible_server_database.main (/terraform-docs/main.tf#118) -- resource.azurerm_postgresql_flexible_server_firewall_rule.main (/terraform-docs/main.tf#110) -- resource.azurerm_private_endpoint.key_vault (/terraform-docs/main.tf#213) -- resource.random_password.postgres_server_admin_password (/terraform-docs/main.tf#47) -- data source.azurerm_client_config.current (/terraform-docs/main.tf#42) -- data source.azurerm_resource_group.main (/terraform-docs/main.tf#39) +- resource.azurerm_key_vault.main (/terraform-docs/main.tf#59) +- resource.azurerm_key_vault_secret.postgres_passwords (/terraform-docs/main.tf#272) +- resource.azurerm_key_vault_secret.postgres_users (/terraform-docs/main.tf#261) +- resource.azurerm_kubernetes_cluster_node_pool.linux_pools (/terraform-docs/main.tf#361) +- resource.azurerm_management_lock.postgres_server (/terraform-docs/main.tf#204) +- resource.azurerm_monitor_metric_alert.postgres_server_alerts (/terraform-docs/main.tf#212) +- resource.azurerm_postgresql_flexible_server.main (/terraform-docs/main.tf#130) +- resource.azurerm_postgresql_flexible_server_configuration.mandatory_configurations (/terraform-docs/main.tf#181) +- resource.azurerm_postgresql_flexible_server_configuration.optional_configurations (/terraform-docs/main.tf#174) +- resource.azurerm_postgresql_flexible_server_database.main (/terraform-docs/main.tf#196) +- resource.azurerm_postgresql_flexible_server_firewall_rule.main (/terraform-docs/main.tf#188) +- resource.azurerm_private_endpoint.key_vault (/terraform-docs/main.tf#85) +- resource.azurerm_role_assignment.key_vault_secret_officer__current (/terraform-docs/main.tf#115) +- resource.azurerm_role_assignment.key_vault_secret_user__aks (/terraform-docs/main.tf#110) +- resource.random_password.postgres_server_admin_password (/terraform-docs/main.tf#125) +- resource.tls_private_key.aks (/terraform-docs/main.tf#288) +- data source.azurerm_client_config.current (/terraform-docs/main.tf#47) +- data source.azurerm_resource_group.main (/terraform-docs/main.tf#44) +- data source.azurerm_subnet.aks_nodes (/terraform-docs/main.tf#49)