Skip to content

Commit

Permalink
Update module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@angelbarrera92
angelbarrera92 committed Oct 29, 2020
1 parent 4052909 commit 133661f
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions modules/aks/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@

## 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 | <pre>list(object({<br> name = string<br> version = string # null to use cluster_version<br> min_size = number<br> max_size = number<br> instance_type = string<br> volume_size = number<br> labels = map(string)<br> taints = list(string)<br> tags = map(string)<br> }))<br></pre> | `[]` | 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 | <pre>list(object({<br> name = string<br> version = string # null to use cluster_version<br> min_size = number<br> max_size = number<br> instance_type = string<br> max_pods = number # null to use default upstream configuration<br> volume_size = number<br> labels = map(string)<br> taints = list(string)<br> tags = map(string)<br> }))<br></pre> | `[]` | no |
| tags | The tags to apply to all resources | `map` | `{}` | no |

## Outputs

| Name | Description |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 |
| operator_ssh_user | SSH user to access cluster nodes with ssh_public_key |

0 comments on commit 133661f

Please sign in to comment.