Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ilpozzd/terraform-talos-vsphere-vm

This module allows you to deploy a Talos OS-based vSphere virtual machine with a custom configuration.
https://github.com/ilpozzd/terraform-talos-vsphere-vm
iac kubernetes module talos terraform virtual-machine vmware vsphere
Last synced: 3 months ago
JSON representation
This module allows you to deploy a Talos OS-based vSphere virtual machine with a custom configuration.
Host: GitHub
URL: https://github.com/ilpozzd/terraform-talos-vsphere-vm
Owner: ilpozzd
License: apache-2.0
Created: 2022-05-19T11:36:07.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-06-08T22:36:18.000Z (over 2 years ago)
Last Synced: 2024-05-15T13:59:03.866Z (6 months ago)
Topics: iac, kubernetes, module, talos, terraform, virtual-machine, vmware, vsphere
Language: HCL
Homepage:
Size: 61.5 KB
Stars: 2
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Talos OS vSphere Virtual Machine Terraform Module

Page in [Terraform Registry](https://registry.terraform.io/modules/ilpozzd/vsphere-vm/talos/latest)

This module allows you to deploy a Talos OS-based vSphere virtual machine with a custom configuration.

The configuration of the virtual machine fully corresponds to the configuration of [Talos OS v1.0.x](https://www.talos.dev/v1.0/).

## Usage

It is strongly not recommended to use this module separately, since creating groups of virtual machines does not make a full cycle of Terraform automation (you cannot continue working with the created cluster using Terraform). To create a cluster, use [ilpozzd/vsphere-cluster/talos](https://registry.terraform.io/modules/ilpozzd/vsphere-cluster/talos/latest). This module is useful in some cases when using Terragrunt. See [examples](#examples).

## Examples

* [Terragrunt Example](https://github.com/ilpozzd/talos-vsphere-cluster-terragrunt-example)

## Requirements

| Name | Version |

|---|---|

| terraform | >= 1.1.9, < 2.0.0 |

| [hashicorp/vsphere](https://registry.terraform.io/providers/hashicorp/vspherehttps://registry.terraform.io/providers/hashicorp/vsphere/2.1.1) | 2.1.1 |

### vSphere Version >= `6.7u3`

### Required `Terraform Role` permissions to user in **vSphere**

Datastore:

* Allocate space

* Browse datastore

* Low level file operations

* Remove file

* Update virtual machine files

* Update virtual machine metadata

Folder:

* Create folder

* Delete folder

* Move folder

* Rename folder

Network:

* Assign network

Resource:

* Assign virtual machine to resource pool

* Migrate powered off virtual machine

* Migrate powered on virtual machine

Profile-driven storage:

* Profile-driven storage view

vApp:

* Import

* View OVF environment

* vApp application configuration

* vApp instance configuration

* vApp managedBy configuration

* vApp resource configuration

Virtual machine:

* Change Configuration

* Edit Inventory

* Guest Operations

* Interaction

* Provisioning

### Required objects to apply `roles`

| Object | Role | Defined in |

|---|---|---|

| vCenter | `Terraform Role` | This object |

| Datacenter | `Read-only Role` | This object |

| Datastore Cluster | `Terraform Role` | This object and it's children |

| Hosts Cluster | `Read-only Role` | This object |

| Hosts | `Terraform Role` | This object |

| DPG | `Terraform Role` | This object |

| Folder | `Terraform Role` | This object and it's children |

| Resource pool | `Terraform Role` | This object and it's children |

## Providers

| Name | Version |

|---|---|

| [hashicorp/vsphere](https://registry.terraform.io/providers/hashicorp/vsphere/2.1.1) | 2.1.1 |

## Modules

| Name | Version |

|---|---|

[ilpozzd/vm-userdata/talos](https://registry.terraform.io/modules/ilpozzd/vm-userdata/talos/1.0.0) | 1.0.0 |

## Resources

| Name | Type |

|---|---|

| [vsphere_virtual_machine.this](https://registry.terraform.io/providers/hashicorp/vsphere/2.1.1/docs/resources/virtual_machine) | resource |

## Inputs

| Name | Description | Type | Default | Required |

|---|---|---|---|---|

| datacenter | VMware datacenter name. | `string` | `-` | Yes |

| datastores | VMWare datastore(s) where all data for the virtual machine will be placed in. | `list(string)` | `-` | Yes |

| hosts | ESXi host(s) where the virtual machine will be created. | `list(string)` | `-` | Yes |

| resource_pool | VMWare resource pool where the virtual machine will be created. | `string` | `-` | Yes |

| folder | Folder to create the virtual machine in. | `string` | `-` | Yes |

| remote_ovf_url | URL to the remote [Talos OS 1.0.x](https://github.com/siderolabs/talos/releases) ovf/ova file. | `string` | `-` | Yes |

|  vm_count | Number of virtual machines. | `number` | `1` | No |

| num_cpus | The total number of virtual processor cores to assign to the virtual machine. | `number` | `2` | No |

| memory | The amount of RAM for the virtual machine, in Mb. | `number` | `2048` | No |

| disks |A specification list for a virtual disk devices on the virtual machine. Use only first disk to Talos installation in [machine_base_configuration](#machine-base-configuration-cell) block | [`list`](#disks-input) | `-` | Yes |

| network_interfaces | A specification list for a virtual NIC on the virtual machine. | [`list`](#network-interfaces-input) | `-` | Yes |

|  create_init_node | Whether to create an initialization node. If `true`, the `first` virtual machine will be the initialization node. | `bool` | `false` | Yes |

| talos_base_configuration | Talos OS top-level configuration. | [`object`](#talos-base-configuration-input) | [`object`](#talos-base-configuration-input) | No |

| machine_secrets | Secret data that is used to create trust relationships between virtual machines. | [`object`](#machine-secrets-input) | `-` | Yes |

| talos_admin_pki | Base64 encoded certificate (signed by [machine_secrets.ca.crt](#machine-secrets-input) and key (in ED25519) to provide access to virtual machine trought `talosctl`. | [`object`](#talos-admin-pki-input) | `{}` | [Yes](#talos-admin-pki-input) |

|  machine_base_configuration | Basic configuration of the virtual machine. | [`object`](#machine-base-configuration-input) | `-` | Yes |

| machine_extra_configuration | Extended configuration of the virtual machine. | [`object`](#machine-extra-configuration-input) | `{}` | No |

|  machine_type | The role of the virtual machine in the Kubernetes cluster (`controlplane` or `worker`). | `string` | `-` | Yes |

| machine_cert_sans | A list of alternative names of for [vm_count](#vm-count-cell) virtual machines. | `list(list(string))` | `[]` | No |

| machine_network | General network configuration of the virtual machine. | [`object`](#machine-network-input) | `{}` | No |

|  machine_network_hostnames | A list of hostnames for [vm_count](#vm-count-cell) virtual machines (if not set will be generated automaticly). | `list(string)` | `[]` | No |

|  machine_network_interfaces | A list of network interfaces for [vm_count](#vm-count-cell) virtual machines (if not set DHCP will be used). | [`list`](#machine-network-interfaces-input) | `[]` | [`Yes/No`](#machine-network-interfaces-input) |

| cluster_secrets | Secret data that is used to establish trust relationships between Kubernetes cluster nodes. | [`object`](#cluster-secrets-input) | `-` | Yes |

| control_plane_cluster_secrets | Secret data required to establish trust relationships between components used by Control Plane nodes in the Kubernetes cluster. Required if [machine_type](#machine-type-cell) = `controlplane`. | [`object`](#control-plane-cluster-secrets-input) | `{}` | [Yes](#control-plane-cluster-secrets-input) |

| cluster_name | The name of the cluster. | `string` | `-` | Yes |

| cluster_control_plane | Data to define the API endpoint address for joining a node to the Kubernetes cluster. | [`object`](#cluster-control-plane-input) | `-` | [Yes/No](#cluster-control-plane-input) |

| cluster_discovery | Data that sets up the discovery of nodes in the Kubernetes cluster. | [`object`](#cluster-discovery-input) | [`object`](#cluster-discovery-input) | No |

| control_plane_cluster_configuration | Data that configure the components of the Control Plane nodes in the Kubernetes cluster. | [`object`](#control-plane-cluster-configuration-input) | `{}` | No |

| cluster_inline_manifests | A list of Kuberenetes manifests whose content is represented as a string. These will get automatically deployed as part of the bootstrap. | [`list`](#cluster-inline-manifests-input) | `[]` | No |

| cluster_extra_manifests | A list of `URLs` that point to additional manifests. These will get automatically deployed as part of the bootstrap. | `list(string)` | `[]` | No |

| cluster_extra_manifest_headers | A map of key value pairs that will be added while fetching the `cluster_extra_manifests`. | `map(string)` | `{}` | No |

| vmtoolsd_extra_manifest | A link to talos-vmtoolsd Kubernetes manifest. | `string` | [`Link`](https://raw.githubusercontent.com/mologie/talos-vmtoolsd/release-0.3/deploy/0.3.yaml) | No |

### Disks Input

```hcl

list(object({

  label            = string

  size             = number

  eagerly_scrub    = optional(bool)

  thin_provisioned = optional(bool)

}))

```

* `label` - Any name for disk (label for Terraform)

* `size` - Capacity in **Gb**

* `eagerly_scrub` and `thin_provisioned` - See [vSphere Provider Documentation](https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs/resources/virtual_machine#disk-options)

### Network Interfaces Input

```hcl

list(object({

  name = string

}))

```

* `name` - Distributed Port Group (DPG) name

### Talos Base Configuration Input

```hcl

object({

  version = string

  persist = bool

})

```

Default:

```hcl

{

  version = "v1alpha1"

  persist = false

}

```

See [Config](https://www.talos.dev/v1.0/reference/configuration/#config) section in Talos Configuration Reference for detail description.

### Machine Secrets Input

```hcl

object({

  token = string

  ca = object({

    crt = string

    key = string

  })

})

```

See [MachineConfig](https://www.talos.dev/v1.0/reference/configuration/#machineconfig) section in Talos Configuration Reference for detail description.

### Talos Admin PKI Input

```hcl

object({

  crt = optional(string)

  key = optional(string)

})

```

* `crt` - Base64 encoded certificate in **PEM** format

* `key` - Base64 encoded key in **PEM** format

  

Required if [machine_type](#machine-type-cell) = `controlplane` and [create_init_node](#create-init-node-cell) = `true`

### Machine Base Configuration 

```hcl

object({

  install = object({

    disk            = string

    extraKernelArgs = optional(list(string))

    image           = string

    bootloader      = bool

    wipe            = bool

    diskSelector = optional(object({

      size    = string

      model   = string

      busPath = string

    }))

    extensions = optional(list(string))

  })

  kubelet = optional(object({

    image      = string

    extraArgs  = optional(map(string))

    clusterDNS = optional(list(string))

    extraMounts = optional(list(object({

      destination = string

      type        = string

      source      = string

      options     = list(string)

    })))

    extraConfig = optional(map(string))

    nodeIP = optional(object({

      validSubnets = list(string)

    }))

  }))

  time = optional(object({

    disabled    = optional(bool)

    servers     = optional(list(string))

    bootTimeout = optional(string)

  }))

  features = optional(object({

    rbac = optional(bool)

  }))

})

```

See [MachineConfig](https://www.talos.dev/v1.0/reference/configuration/#machineconfig) section in Talos Configuration Reference for detail description.

### Machine Extra Configuration Input

```hcl

object({

  controlPlane = optional(object({

    controllerManager = optional(object({

      disabled = bool

    }))

    scheduler = optional(object({

      disabled = bool

    }))

  }))

  pods = optional(list(map(any)))

  disks = optional(list(object({

    device = string

    partitions = list(object({

      mountpoint = string

      size       = string

    }))

  })))

  files = optional(list(object({

    content     = string

    permissions = string

    path        = string

    op          = string

  })))

  env = optional(object({

    GRPC_GO_LOG_VERBOSITY_LEVEL = optional(string)

    GRPC_GO_LOG_SEVERITY_LEVEL  = optional(string)

    http_proxy                  = optional(string)

    https_proxy                 = optional(string)

    no_proxy                    = optional(bool)

  }))

  sysctls = optional(map(string))

  sysfs   = optional(map(string))

  registries = optional(object({

    mirrors = optional(map(object({

      endpoints = list(string)

    })))

    config = optional(map(object({

      tls = object({

        insecureSkipVerify = bool

        clientIdentity = optional(object({

          crt = string

          key = string

        }))

        ca = optional(string)

      })

      auth = optional(object({

        username      = optional(string)

        password      = optional(string)

        auth          = optional(string)

        identityToken = optional(string)

      }))

    })))

  }))

  systemDiskEncryption = optional(map(object({

    provider = string

    keys = optional(list(object({

      static = optional(object({

        passphrase = string

      }))

      nodeID = optional(map(string))

      slot   = optional(number)

    })))

    cipher    = optional(string)

    keySize   = optional(number)

    blockSize = optional(number)

    options   = optional(list(string))

  })))

  udev = optional(object({

    rules = list(string)

  }))

  logging = optional(object({

    destinations = list(object({

      endpoint = string

      format   = string

    }))

  }))

  kernel = optional(object({

    modules = list(object({

      name = string

    }))

  }))

})

```

See [MachineConfig](https://www.talos.dev/v1.0/reference/configuration/#machineconfig) section in Talos Configuration Reference for detail description.

### Machine Network Input

```hcl

object({

  nameservers = optional(list(string))

  extraHostEntries = optional(list(object({

    ip      = string

    aliases = list(string)

  })))

  kubespan = optional(object({

    enabled = bool

  }))

})

```

See [NetworkConfig](https://www.talos.dev/v1.0/reference/configuration/#networkconfig) section in Talos Configuration Reference for detail description. 

[hostname](#machine-network-hostnames-cell) and [interfaces](#machine-network-interfaces-cell) parameters are described in separate inputs.

### Machine Network Interfaces Input

```hcl

list(list(object({

  interface = string

  addresses = optional(list(string))

  routes = optional(list(object({

    network = string

    gateway = optional(string)

    source  = optional(string)

    metric  = optional(number)

  })))

  vlans = optional(list(object({

    addresses = list(string)

    routes = optional(list(object({

      network = string

      gateway = optional(string)

      source  = optional(string)

      metric  = optional(number)

    })))

    dhcp   = optional(bool)

    vlanId = number

    mtu    = number

    vip = optional(object({

      ip = string

      equinixMetal = optional(object({

        apiToken = string

      }))

      hcloud = optional(object({

        apiToken = string

      }))

    }))

  })))

  mtu = optional(number)

  bond = optional(object({

    interfaces = list(string)

    mode       = string

    lacpRate   = string

  }))

  dhcp   = optional(bool)

  ignore = optional(bool)

  dummy  = optional(bool)

  dhcpOptions = optional(object({

    routeMetric = number

    ipv4        = optional(bool)

    ipv6        = optional(bool)

  }))

  wireguard = optional(object({

    privateKey   = string

    listenPort   = number

    firewallMark = number

    peers = list(object({

      publicKey                   = string

      endpoint                    = string

      persistentKeepaliveInterval = optional(string)

      allowedIPs                  = list(string)

    }))

  }))

  vip = optional(object({

    ip = string

    equinixMetal = optional(object({

      apiToken = string

    }))

    hcloud = optional(object({

      apiToken = string

    }))

  }))

})))

```

See [Device](https://www.talos.dev/v1.0/reference/configuration/#device) section in Talos Configuration Reference for detail description.

If [machine_type](#machine-type-cell) = `controlplane` and [create_init_node](#create-init-node-cell) = `true`, not less than one element with one static IP address required.

### Cluster Secrets Input

```hcl

object({

  id     = string

  secret = string

  token  = string

  ca = object({

    crt = string

    key = string

  })

})

```

See [ClusterConfig](https://www.talos.dev/v1.0/reference/configuration/#clusterconfig) section in Talos Configuration Reference for detail description. 

### Control Plane Cluster Secrets Input

```hcl

object({

  aescbcEncryptionSecret = optional(string)

  aggregatorCA = optional(object({

    crt = optional(string)

    key = optional(string)

  }))

  serviceAccount = optional(object({

    key = optional(string)

  }))

  etcd = optional(object({

    ca = object({

      crt = optional(string)

      key = optional(string)

    })

  }))

})

```

See [ClusterConfig](https://www.talos.dev/v1.0/reference/configuration/#clusterconfig) section in Talos Configuration Reference for detail description.

Required if [machine_type](#machine-type-cell) = `controlplane`.

### Cluster Control Plane Input

```hcl

object({

  endpoint           = optional(string)

  localAPIServerPort = optional(number)

})

```

See [ControlPlaneConfig](https://www.talos.dev/v1.0/reference/configuration/#controlplaneconfig) section in Talos Configuration Reference for detail description. 

Required if ([create_init_node](#create-init-node-cell) = `false` or ([create_init_node](#create-init-node-cell) = `true` and [vm_count](#vm-count-cell) > `1`)).

### Cluster Discovery Input

```hcl

object({

  enabled = bool

  registries = optional(object({

    kubernetes = optional(object({

      disabled = bool

    }))

    service = optional(object({

      disabled = bool

      endpoint = string

    }))

  }))

})

```

Default:

```hcl

{

  enabled = true

}

```

See [ClusterDiscoveryConfig](https://www.talos.dev/v1.0/reference/configuration/#clusterdiscoveryconfig) section in Talos Configuration Reference for detail description.

### Control Plane Cluster Configuration Input

```hcl

object({

  network = optional(object({

    cni = optional(object({

      name = string

      urls = optional(list(string))

    }))

    dnsDomain      = optional(string)

    podSubnets     = optional(list(string))

    serviceSubnets = optional(list(string))

  }))

  apiServer = optional(object({

    image     = string

    extraArgs = optional(map(string))

    extraVolumes = optional(list(object({

      hostPath  = string

      mountPath = string

      readonly  = bool

    })))

    env                      = optional(map(string))

    certSANs                 = optional(list(string))

    disablePodSecurityPolicy = optional(bool)

    admissionControl = optional(list(object({

      name          = string

      configuration = map(any)

    })))

  }))

  controllerManager = optional(object({

    image     = string

    extraArgs = optional(map(string))

    extraVolumes = optional(list(object({

      hostPath  = string

      mountPath = string

      readonly  = bool

    })))

    env = optional(map(string))

  }))

  proxy = optional(object({

    disabled  = bool

    image     = optional(string)

    mode      = optional(string)

    extraArgs = optional(map(string))

  }))

  scheduler = optional(object({

    image     = string

    extraArgs = optional(map(string))

    extraVolumes = optional(list(object({

      hostPath  = string

      mountPath = string

      readonly  = bool

    })))

    env = optional(map(string))

  }))

  etcd = optional(object({

    image     = optional(string)

    extraArgs = optional(map(string))

    subnet    = optional(string)

  }))

  coreDNS = optional(object({

    disabled = bool

    image    = optional(string)

  }))

  externalCloudProvider = optional(object({

    enabled   = bool

    manifests = list(string)

  }))

  adminKubeconfig = optional(object({

    certLifetime = string

  }))

  allowSchedulingOnMasters = optional(bool)

})

```

See [ClusterConfig](https://www.talos.dev/v1.0/reference/configuration/#clusterconfig) section in Talos Configuration Reference for detail description. 

### Cluster Inline Manifests Input

```hcl

list(object({

  name     = string

  contents = string

}))

```

See [ClusterConfig](https://www.talos.dev/v1.0/reference/configuration/#clusterconfig) section in Talos Configuration Reference for detail description.

## Outputs

| Name | Description | Type | Sensitive |

|---|---|---|---|

| default_ip_addresses | List of nodes IP addresses from VMTools by default. | `list(string)` | `false` |

## Authors

Module is maintained by [Ilya Pozdnov](https://github.com/ilpozzd).

## License

Apache 2 Licensed. See [LICENSE](LICENSE) for full details.