Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
@dutsmiller
dutsmiller committed May 26, 2021
1 parent 596ac9f commit a07ccaf
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ This module will create a managed Kubernetes cluster using Azure Kubernetes Serv
| acr\_pull\_access | map of ACR ids to allow AcrPull | `map(string)` | `{}` | no |
| cluster\_name | Name of AKS cluster. | `string` | n/a | yes |
| configure\_network\_role | Add Network Contributor role for identity on input subnets. | `bool` | `true` | no |
| configure\_subnet\_nsg\_rules | Configure required AKS NSG rules on input subnets. | `bool` | `true` | no |
| custom\_route\_table\_ids | Custom route tables used by node pool subnets. | `map(string)` | `{}` | no |
| default\_node\_pool | Default node pool. Value refers to key within node\_pools variable. | `string` | `"default"` | no |
| dns\_prefix | DNS prefix specified when creating the managed cluster. | `string` | n/a | yes |
| enable\_kube\_dashboard | enable kubernetes dashboard | `bool` | `false` | no |
Expand All @@ -30,21 +28,20 @@ This module will create a managed Kubernetes cluster using Azure Kubernetes Serv
| log\_analytics\_workspace\_id | ID of the Azure Log Analytics Workspace | `string` | n/a | yes |
| names | Names to be applied to resources. | `map(string)` | n/a | yes |
| network\_plugin | network plugin to use for networking (azure or kubenet) | `string` | `"kubenet"` | no |
| network\_profile\_options | docker\_bridge\_cidr, dns\_service\_ip and service\_cidr should all be empty or all should be set | <pre>object({<br> docker_bridge_cidr = string<br> dns_service_ip = string<br> service_cidr = string<br> })</pre> | n/a | yes |
| node\_pool\_defaults | node pool defaults | <pre>object({<br> vm_size = string<br> availability_zones = list(number)<br> node_count = number<br> enable_auto_scaling = bool<br> min_count = number<br> max_count = number<br> enable_host_encryption = bool<br> enable_node_public_ip = bool<br> max_pods = number<br> node_labels = map(string)<br> only_critical_addons_enabled = bool<br> orchestrator_version = string<br> os_disk_size_gb = number<br> os_disk_type = string<br> type = string<br> tags = map(string)<br> subnet = string # must be key from node_pool_subnets variable<br><br> # settings below not available in default node pools<br> mode = string<br> node_taints = list(string)<br> max_surge = string<br> eviction_policy = string<br> os_type = string<br> priority = string<br> proximity_placement_group_id = string<br> spot_max_price = number<br> })</pre> | <pre>{<br> "availability_zones": [<br> 1,<br> 2,<br> 3<br> ],<br> "enable_auto_scaling": false,<br> "enable_host_encryption": false,<br> "enable_node_public_ip": false,<br> "eviction_policy": null,<br> "max_count": null,<br> "max_pods": null,<br> "max_surge": "1",<br> "min_count": null,<br> "mode": "User",<br> "name": null,<br> "node_count": 1,<br> "node_labels": null,<br> "node_taints": null,<br> "only_critical_addons_enabled": false,<br> "orchestrator_version": null,<br> "os_disk_size_gb": null,<br> "os_disk_type": "Managed",<br> "os_type": "Linux",<br> "priority": "Regular",<br> "proximity_placement_group_id": null,<br> "spot_max_price": null,<br> "subnet": null,<br> "tags": null,<br> "type": "VirtualMachineScaleSets",<br> "vm_size": "Standard_B2s"<br>}</pre> | no |
| node\_pool\_subnets | Subnet info used with node\_pools variable. | <pre>map(object({<br> id = string # subnet_id<br> resource_group_name = string # resource group containing virtual_network/subnets<br> network_security_group_name = string # network_security_group name associated with subnet<br> }))</pre> | `{}` | no |
| network\_profile\_options | docker\_bridge\_cidr, dns\_service\_ip and service\_cidr should all be empty or all should be set | <pre>object({<br> docker_bridge_cidr = string<br> dns_service_ip = string<br> service_cidr = string<br> })</pre> | n/a | yes |
| node\_pool\_defaults | node pool defaults | <pre>object({<br> vm_size = string<br> availability_zones = list(number)<br> node_count = number<br> enable_auto_scaling = bool<br> min_count = number<br> max_count = number<br> enable_host_encryption = bool<br> enable_node_public_ip = bool<br> max_pods = number<br> node_labels = map(string)<br> only_critical_addons_enabled = bool<br> orchestrator_version = string<br> os_disk_size_gb = number<br> os_disk_type = string<br> type = string<br> tags = map(string)<br> subnet = string # must be key from node_pool_subnets variable<br><br> # settings below not available in default node pools<br> mode = string<br> node_taints = list(string)<br> max_surge = string<br> eviction_policy = string<br> os_type = string<br> priority = string<br> proximity_placement_group_id = string<br> spot_max_price = number<br> })</pre> | <pre>{<br> "availability_zones": [<br> 1,<br> 2,<br> 3<br> ],<br> "enable_auto_scaling": false,<br> "enable_host_encryption": false,<br> "enable_node_public_ip": false,<br> "eviction_policy": null,<br> "max_count": null,<br> "max_pods": null,<br> "max_surge": "1",<br> "min_count": null,<br> "mode": "User",<br> "name": null,<br> "node_count": 1,<br> "node_labels": null,<br> "node_taints": null,<br> "only_critical_addons_enabled": false,<br> "orchestrator_version": null,<br> "os_disk_size_gb": null,<br> "os_disk_type": "Managed",<br> "os_type": "Linux",<br> "priority": "Regular",<br> "proximity_placement_group_id": null,<br> "spot_max_price": null,<br> "subnet": null,<br> "tags": null,<br> "type": "VirtualMachineScaleSets",<br> "vm_size": "Standard_B2s"<br>}</pre> | no |
| node\_pools | node pools | `any` | <pre>{<br> "default": {}<br>}</pre> | no |
| node\_resource\_group | The name of the Resource Group where the Kubernetes Nodes should exist. | `string` | n/a | yes |
| outbound\_type | outbound (egress) routing method which should be used for this Kubernetes Cluster | `string` | `"loadBalancer"` | no |
| pod\_cidr | used for pod IP addresses | `string` | n/a | yes |
| rbac | role based access control settings | <pre>object({<br> enabled = bool<br> ad_integration = bool<br> })</pre> | <pre>{<br> "ad_integration": false,<br> "enabled": true<br>}</pre> | no |
| rbac | role based access control settings | <pre>object({<br> enabled = bool<br> ad_integration = bool<br> })</pre> | <pre>{<br> "ad_integration": false,<br> "enabled": true<br>}</pre> | no |
| rbac\_admin\_object\_ids | Admin group object ids for use with rbac active directory integration | `map(string)` | `{}` | no |
| resource\_group\_name | Resource group name. | `string` | n/a | yes |
| sku\_tier | Sets the cluster's SKU tier. The paid tier has a financially-backed uptime SLA. Read doc [here](https://docs.microsoft.com/en-us/azure/aks/uptime-sla). | `string` | `"Free"` | no |
| subnet\_nsg\_rule\_priority\_start | Starting point for NSG rulee priorities. | `number` | `1000` | no |
| tags | Tags to be applied to resources. | `map(string)` | n/a | yes |
| user\_assigned\_identity | User assigned identity for the manged cluster (leave and the module will create one). | <pre>object({<br> id = string<br> principal_id = string<br> client_id = string<br> })</pre> | n/a | yes |
| windows\_profile | windows profile admin user/pass | <pre>object({ <br> admin_username = string<br> admin_password = string<br> })</pre> | n/a | yes |
| user\_assigned\_identity | User assigned identity for the manged cluster (leave and the module will create one). | <pre>object({<br> id = string<br> principal_id = string<br> client_id = string<br> })</pre> | n/a | yes |
| virtual\_network | Virtual network info. | <pre>object({<br> subnets = map(object({<br> id = string<br> }))<br> route_table_id = string<br> })</pre> | n/a | yes |
| windows\_profile | windows profile admin user/pass | <pre>object({<br> admin_username = string<br> admin_password = string<br> })</pre> | n/a | yes |

## Outputs

Expand Down

0 comments on commit a07ccaf

Please sign in to comment.