|
| 1 | +# AWS Quickstart Terraform configs |
| 2 | + |
| 3 | +The AWS Quickstart Terraform configs can be used to create the needed |
| 4 | +infrastructure for a Kubernetes HA cluster. Check out the |
| 5 | +[Creating Infrastructure guide][docs-infrastructure] to learn more about how to |
| 6 | +use the configs and how to provision a Kubernetes cluster using KubeOne. |
| 7 | + |
| 8 | +[docs-infrastructure]: https://docs.kubermatic.com/kubeone/main/guides/using-terraform-configs/ |
| 9 | + |
| 10 | +## Requirements |
| 11 | + |
| 12 | +| Name | Version | |
| 13 | +|------|---------| |
| 14 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 | |
| 15 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.1.0 | |
| 16 | + |
| 17 | +## Providers |
| 18 | + |
| 19 | +| Name | Version | |
| 20 | +|------|---------| |
| 21 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.1.0 | |
| 22 | +| <a name="provider_random"></a> [random](#provider\_random) | n/a | |
| 23 | + |
| 24 | +## Modules |
| 25 | + |
| 26 | +No modules. |
| 27 | + |
| 28 | +## Resources |
| 29 | + |
| 30 | +| Name | Type | |
| 31 | +|------|------| |
| 32 | +| [aws_default_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/default_vpc) | resource | |
| 33 | +| [aws_elb.control_plane](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elb) | resource | |
| 34 | +| [aws_iam_instance_profile.profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource | |
| 35 | +| [aws_iam_role.role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | |
| 36 | +| [aws_iam_role_policy.policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
| 37 | +| [aws_instance.bastion](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource | |
| 38 | +| [aws_instance.control_plane](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource | |
| 39 | +| [aws_instance.static_workers1](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource | |
| 40 | +| [aws_key_pair.deployer](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/key_pair) | resource | |
| 41 | +| [aws_security_group.common](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
| 42 | +| [aws_security_group.elb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
| 43 | +| [aws_security_group.ssh](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
| 44 | +| [aws_security_group_rule.egress_allow_all](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource | |
| 45 | +| [aws_security_group_rule.ingress_self_allow_all](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource | |
| 46 | +| [aws_security_group_rule.nodeports](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource | |
| 47 | +| [aws_subnet.public](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/subnet) | resource | |
| 48 | +| [random_integer.cidr_block](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer) | resource | |
| 49 | +| [aws_ami.ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source | |
| 50 | +| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source | |
| 51 | +| [aws_internet_gateway.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/internet_gateway) | data source | |
| 52 | +| [aws_vpc.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source | |
| 53 | + |
| 54 | +## Inputs |
| 55 | + |
| 56 | +| Name | Description | Type | Default | Required | |
| 57 | +|------|-------------|------|---------|:--------:| |
| 58 | +| <a name="input_ami"></a> [ami](#input\_ami) | AMI ID, use it to fixate control-plane AMI in order to avoid force-recreation it at later times | `string` | `""` | no | |
| 59 | +| <a name="input_ami_filters"></a> [ami\_filters](#input\_ami\_filters) | map with AMI filters | <pre>map(object({<br> owners = list(string)<br> image_name = list(string)<br> ssh_username = string<br> worker_os = string<br> }))</pre> | <pre>{<br> "centos": {<br> "image_name": [<br> "CentOS Linux 7 x86_64*"<br> ],<br> "owners": [<br> "125523088429"<br> ],<br> "ssh_username": "centos",<br> "worker_os": "centos"<br> },<br> "flatcar": {<br> "image_name": [<br> "Flatcar-stable-*-hvm"<br> ],<br> "owners": [<br> "075585003325"<br> ],<br> "ssh_username": "core",<br> "worker_os": "flatcar"<br> },<br> "rhel": {<br> "image_name": [<br> "RHEL-9*_HVM-*-x86_64-*"<br> ],<br> "owners": [<br> "309956199498"<br> ],<br> "ssh_username": "ec2-user",<br> "worker_os": "rhel"<br> },<br> "rockylinux": {<br> "image_name": [<br> "Rocky-9-EC2-*.x86_64"<br> ],<br> "owners": [<br> "792107900819"<br> ],<br> "ssh_username": "rocky",<br> "worker_os": "rockylinux"<br> },<br> "ubuntu": {<br> "image_name": [<br> "ubuntu/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-server-*"<br> ],<br> "owners": [<br> "099720109477"<br> ],<br> "ssh_username": "ubuntu",<br> "worker_os": "ubuntu"<br> }<br>}</pre> | no | |
| 60 | +| <a name="input_apiserver_alternative_names"></a> [apiserver\_alternative\_names](#input\_apiserver\_alternative\_names) | subject alternative names for the API Server signing cert. | `list(string)` | `[]` | no | |
| 61 | +| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS region to speak to | `string` | `"eu-west-3"` | no | |
| 62 | +| <a name="input_bastion_host_key"></a> [bastion\_host\_key](#input\_bastion\_host\_key) | Bastion SSH host public key | `string` | `null` | no | |
| 63 | +| <a name="input_bastion_port"></a> [bastion\_port](#input\_bastion\_port) | Bastion SSH port | `number` | `22` | no | |
| 64 | +| <a name="input_bastion_private_key_file"></a> [bastion\_private\_key\_file](#input\_bastion\_private\_key\_file) | SSH private key file used to access bastion | `string` | `""` | no | |
| 65 | +| <a name="input_bastion_type"></a> [bastion\_type](#input\_bastion\_type) | instance type for bastion | `string` | `"t3.nano"` | no | |
| 66 | +| <a name="input_bastion_user"></a> [bastion\_user](#input\_bastion\_user) | Bastion SSH username | `string` | `""` | no | |
| 67 | +| <a name="input_cluster_autoscaler_max_replicas"></a> [cluster\_autoscaler\_max\_replicas](#input\_cluster\_autoscaler\_max\_replicas) | maximum number of replicas per MachineDeployment (requires cluster-autoscaler) | `number` | `0` | no | |
| 68 | +| <a name="input_cluster_autoscaler_min_replicas"></a> [cluster\_autoscaler\_min\_replicas](#input\_cluster\_autoscaler\_min\_replicas) | minimum number of replicas per MachineDeployment (requires cluster-autoscaler) | `number` | `0` | no | |
| 69 | +| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the cluster | `string` | n/a | yes | |
| 70 | +| <a name="input_control_plane_http_put_max_hops"></a> [control\_plane\_http\_put\_max\_hops](#input\_control\_plane\_http\_put\_max\_hops) | HTTP PUT response hop limit for the instance metadata requests | `number` | `3` | no | |
| 71 | +| <a name="input_control_plane_labels"></a> [control\_plane\_labels](#input\_control\_plane\_labels) | custom labels to add (and remove) to control plane | `map(string)` | <pre>{<br> "custom-label-to-add": "custom-value",<br> "custom-label-to-remove-": ""<br>}</pre> | no | |
| 72 | +| <a name="input_control_plane_type"></a> [control\_plane\_type](#input\_control\_plane\_type) | AWS instance type | `string` | `"t3.medium"` | no | |
| 73 | +| <a name="input_control_plane_vm_count"></a> [control\_plane\_vm\_count](#input\_control\_plane\_vm\_count) | number of control plane instances | `number` | `3` | no | |
| 74 | +| <a name="input_control_plane_volume_size"></a> [control\_plane\_volume\_size](#input\_control\_plane\_volume\_size) | Size of the EBS volume, in Gb | `number` | `100` | no | |
| 75 | +| <a name="input_disable_auto_update"></a> [disable\_auto\_update](#input\_disable\_auto\_update) | Disable automatic flatcar updates (and reboot) | `bool` | `false` | no | |
| 76 | +| <a name="input_disable_kubeapi_loadbalancer"></a> [disable\_kubeapi\_loadbalancer](#input\_disable\_kubeapi\_loadbalancer) | E2E tests specific variable to disable usage of any loadbalancer in front of kubeapi-server | `bool` | `false` | no | |
| 77 | +| <a name="input_initial_machinedeployment_operating_system_profile"></a> [initial\_machinedeployment\_operating\_system\_profile](#input\_initial\_machinedeployment\_operating\_system\_profile) | Name of operating system profile for MachineDeployments, only applicable if operating-system-manager addon is enabled.<br>If not specified default is used based on the OS specified for workers. | `string` | `""` | no | |
| 78 | +| <a name="input_initial_machinedeployment_replicas"></a> [initial\_machinedeployment\_replicas](#input\_initial\_machinedeployment\_replicas) | number of replicas per MachineDeployment | `number` | `1` | no | |
| 79 | +| <a name="input_initial_machinedeployment_spotinstances_max_price"></a> [initial\_machinedeployment\_spotinstances\_max\_price](#input\_initial\_machinedeployment\_spotinstances\_max\_price) | used to specify max spot instance price for initial machine-deployment | `number` | `0` | no | |
| 80 | +| <a name="input_internal_api_lb"></a> [internal\_api\_lb](#input\_internal\_api\_lb) | make kubernetes API loadbalancer internal (reachible only from inside the VPC) | `bool` | `false` | no | |
| 81 | +| <a name="input_os"></a> [os](#input\_os) | Operating System to use in AMI filtering and MachineDeployment | `string` | `"ubuntu"` | no | |
| 82 | +| <a name="input_provisioning_utility"></a> [provisioning\_utility](#input\_provisioning\_utility) | provisioning utility to be used for Flatcar worker nodes | `string` | `""` | no | |
| 83 | +| <a name="input_ssh_agent_socket"></a> [ssh\_agent\_socket](#input\_ssh\_agent\_socket) | SSH Agent socket, default to grab from $SSH\_AUTH\_SOCK | `string` | `"env:SSH_AUTH_SOCK"` | no | |
| 84 | +| <a name="input_ssh_hosts_keys"></a> [ssh\_hosts\_keys](#input\_ssh\_hosts\_keys) | A list of SSH hosts public keys to verify | `list(string)` | `null` | no | |
| 85 | +| <a name="input_ssh_port"></a> [ssh\_port](#input\_ssh\_port) | SSH port to be used to provision instances | `number` | `22` | no | |
| 86 | +| <a name="input_ssh_private_key_file"></a> [ssh\_private\_key\_file](#input\_ssh\_private\_key\_file) | SSH private key file used to access instances | `string` | `""` | no | |
| 87 | +| <a name="input_ssh_public_key_file"></a> [ssh\_public\_key\_file](#input\_ssh\_public\_key\_file) | SSH public key file | `string` | `"~/.ssh/id_rsa.pub"` | no | |
| 88 | +| <a name="input_ssh_username"></a> [ssh\_username](#input\_ssh\_username) | SSH user, used only in output | `string` | `""` | no | |
| 89 | +| <a name="input_static_workers_count"></a> [static\_workers\_count](#input\_static\_workers\_count) | number of static workers | `number` | `0` | no | |
| 90 | +| <a name="input_static_workers_http_put_max_hops"></a> [static\_workers\_http\_put\_max\_hops](#input\_static\_workers\_http\_put\_max\_hops) | HTTP PUT response hop limit for the instance metadata requests | `number` | `3` | no | |
| 91 | +| <a name="input_subnets_cidr"></a> [subnets\_cidr](#input\_subnets\_cidr) | CIDR mask bits per subnet | `number` | `24` | no | |
| 92 | +| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | VPC to use ('default' for default VPC) | `string` | `"default"` | no | |
| 93 | +| <a name="input_worker_deploy_ssh_key"></a> [worker\_deploy\_ssh\_key](#input\_worker\_deploy\_ssh\_key) | add provided ssh public key to MachineDeployments | `bool` | `true` | no | |
| 94 | +| <a name="input_worker_os"></a> [worker\_os](#input\_worker\_os) | OS to run on worker machines, default to var.os | `string` | `""` | no | |
| 95 | +| <a name="input_worker_type"></a> [worker\_type](#input\_worker\_type) | instance type for workers | `string` | `"t3.medium"` | no | |
| 96 | +| <a name="input_worker_volume_size"></a> [worker\_volume\_size](#input\_worker\_volume\_size) | Size of the EBS volume, in Gb | `number` | `50` | no | |
| 97 | + |
| 98 | +## Outputs |
| 99 | + |
| 100 | +| Name | Description | |
| 101 | +|------|-------------| |
| 102 | +| <a name="output_kubeone_api"></a> [kubeone\_api](#output\_kubeone\_api) | kube-apiserver LB endpoint | |
| 103 | +| <a name="output_kubeone_hosts"></a> [kubeone\_hosts](#output\_kubeone\_hosts) | Control plane endpoints to SSH to | |
| 104 | +| <a name="output_kubeone_static_workers"></a> [kubeone\_static\_workers](#output\_kubeone\_static\_workers) | Static worker config | |
| 105 | +| <a name="output_kubeone_workers"></a> [kubeone\_workers](#output\_kubeone\_workers) | Workers definitions, that will be transformed into MachineDeployment object | |
| 106 | +| <a name="output_ssh_commands"></a> [ssh\_commands](#output\_ssh\_commands) | n/a | |
0 commit comments