diff --git a/README.md b/README.md index 127760e..bea1114 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,57 @@ terraform apply Write Kubeconfig (caution, this will override you existing Kubeconfig): ``` terraform output -raw kubeconfig > ~/.kube/config -``` \ No newline at end of file +``` + +## Requirements + +| Name | Version | +|------|---------| +| [proxmox](#requirement\_proxmox) | 0.72.0 | +| [talos](#requirement\_talos) | 0.7.1 | + +## Providers + +| Name | Version | +|------|---------| +| [proxmox](#provider\_proxmox) | 0.72.0 | +| [talos](#provider\_talos) | 0.7.1 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [proxmox_virtual_environment_download_file.talos_nocloud_image](https://registry.terraform.io/providers/bpg/proxmox/0.72.0/docs/resources/virtual_environment_download_file) | resource | +| [proxmox_virtual_environment_vm.talos_cp](https://registry.terraform.io/providers/bpg/proxmox/0.72.0/docs/resources/virtual_environment_vm) | resource | +| [proxmox_virtual_environment_vm.talos_worker](https://registry.terraform.io/providers/bpg/proxmox/0.72.0/docs/resources/virtual_environment_vm) | resource | +| [talos_cluster_kubeconfig.kubeconfig](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/resources/cluster_kubeconfig) | resource | +| [talos_machine_bootstrap.bootstrap](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/resources/machine_bootstrap) | resource | +| [talos_machine_configuration_apply.cp_config_apply](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/resources/machine_configuration_apply) | resource | +| [talos_machine_configuration_apply.worker_config_apply](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/resources/machine_configuration_apply) | resource | +| [talos_machine_secrets.machine_secrets](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/resources/machine_secrets) | resource | +| [talos_client_configuration.talosconfig](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/data-sources/client_configuration) | data source | +| [talos_cluster_health.health](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/data-sources/cluster_health) | data source | +| [talos_machine_configuration.machineconfig_cp](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/data-sources/machine_configuration) | data source | +| [talos_machine_configuration.machineconfig_worker](https://registry.terraform.io/providers/siderolabs/talos/0.7.1/docs/data-sources/machine_configuration) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [cluster\_name](#input\_cluster\_name) | n/a | `string` | `"homelab"` | no | +| [default\_gateway](#input\_default\_gateway) | n/a | `string` | `"192.168.1.1"` | no | +| [proxmox\_nodes](#input\_proxmox\_nodes) | Names of the Proxmox nodes, used to download and reference node images | `list(string)` |
[
"ms-01"
]
| no | +| [talos\_controlplane\_config](#input\_talos\_controlplane\_config) | Machine configuration of control-plane nodes |
list(object({
id = number
ip = string
name = string
node = string
cpu_cores = number
memory = number
disk_size = number
}))
|
[
{
"cpu_cores": 2,
"disk_size": 20,
"id": 101,
"ip": "192.168.1.181",
"memory": 2048,
"name": "talos-cp-01",
"node": "ms-01"
},
{
"cpu_cores": 2,
"disk_size": 20,
"id": 102,
"ip": "192.168.1.182",
"memory": 2048,
"name": "talos-cp-02",
"node": "ms-01"
},
{
"cpu_cores": 2,
"disk_size": 20,
"id": 103,
"ip": "192.168.1.183",
"memory": 2048,
"name": "talos-cp-03",
"node": "ms-01"
}
]
| no | +| [talos\_version](#input\_talos\_version) | n/a | `string` | `"1.9.4"` | no | +| [talos\_worker\_config](#input\_talos\_worker\_config) | Machine configuration of worker nodes |
list(object({
id = number
ip = string
name = string
node = string
cpu_cores = number
memory = number
disk_size = number
}))
|
[
{
"cpu_cores": 4,
"disk_size": 100,
"id": 111,
"ip": "192.168.1.191",
"memory": 4096,
"name": "talos-worker-01",
"node": "ms-01"
},
{
"cpu_cores": 4,
"disk_size": 100,
"id": 112,
"ip": "192.168.1.192",
"memory": 4096,
"name": "talos-worker-02",
"node": "ms-01"
},
{
"cpu_cores": 4,
"disk_size": 100,
"id": 113,
"ip": "192.168.1.193",
"memory": 4096,
"name": "talos-worker-03",
"node": "ms-01"
},
{
"cpu_cores": 4,
"disk_size": 100,
"id": 114,
"ip": "192.168.1.194",
"memory": 4096,
"name": "talos-worker-04",
"node": "ms-01"
}
]
| no | + +## Outputs + +| Name | Description | +|------|-------------| +| [kubeconfig](#output\_kubeconfig) | n/a | +| [talosconfig](#output\_talosconfig) | n/a |