diff --git a/modules/aks/README.md b/modules/aks/README.md index a51b9c5..5f38b6c 100644 --- a/modules/aks/README.md +++ b/modules/aks/README.md @@ -10,17 +10,17 @@ ## Inputs -| Name | Description | Type | Default | Required | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | :------: | -| cluster_name | Unique cluster name. Used in multiple resources to identify your cluster resources | `string` | n/a | yes | -| cluster_version | Kubernetes Cluster Version. Look at the cloud providers documentation to discover available versions. EKS example -> 1.16, GKE example -> 1.16.8-gke.9 | `string` | n/a | yes | -| dmz_cidr_range | Network CIDR range from where cluster control plane will be accessible | `string` | n/a | yes | -| network | Network where the Kubernetes cluster will be hosted | `string` | n/a | yes | -| resource_group_name | Resource group name where every resource will be placed. Required only in AKS installer (*) | `string` | n/a | yes | -| ssh_public_key | Cluster administrator public ssh key. Used to access cluster nodes with the operator_ssh_user | `string` | n/a | yes | -| subnetworks | List of subnets where the cluster will be hosted | `list` | n/a | yes | -| node_pools | An object list defining node pools configurations |
list(object({
name = string
version = string # null to use cluster_version
min_size = number
max_size = number
instance_type = string
volume_size = number
labels = map(string)
taints = list(string)
tags = map(string)
}))
| `[]` | no | -| tags | The tags to apply to all resources | `map` | `{}` | no | +| Name | Description | Type | Default | Required | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | :------: | +| cluster_name | Unique cluster name. Used in multiple resources to identify your cluster resources | `string` | n/a | yes | +| cluster_version | Kubernetes Cluster Version. Look at the cloud providers documentation to discover available versions. EKS example -> 1.16, GKE example -> 1.16.8-gke.9 | `string` | n/a | yes | +| dmz_cidr_range | Network CIDR range from where cluster control plane will be accessible | `string` | n/a | yes | +| network | Network where the Kubernetes cluster will be hosted | `string` | n/a | yes | +| resource_group_name | Resource group name where every resource will be placed. Required only in AKS installer (*) | `string` | n/a | yes | +| ssh_public_key | Cluster administrator public ssh key. Used to access cluster nodes with the operator_ssh_user | `string` | n/a | yes | +| subnetworks | List of subnets where the cluster will be hosted | `list` | n/a | yes | +| node_pools | An object list defining node pools configurations |
list(object({
name = string
version = string # null to use cluster_version
min_size = number
max_size = number
instance_type = string
max_pods = number # null to use default upstream configuration
volume_size = number
labels = map(string)
taints = list(string)
tags = map(string)
}))
| `[]` | no | +| tags | The tags to apply to all resources | `map` | `{}` | no | ## Outputs @@ -28,4 +28,4 @@ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cluster_certificate_authority | The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster | | cluster_endpoint | The endpoint for your Kubernetes API server | -| operator_ssh_user | SSH user to access cluster nodes with ssh_public_key | \ No newline at end of file +| operator_ssh_user | SSH user to access cluster nodes with ssh_public_key |