Vm schema base
Title: VM/LXC Base Schema
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Not allowed |
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + target_pve |
No |
string |
No |
- |
Proxmox cluster name + . + pve cloud domain. This determines the cloud and the proxmox cluster the vms/lxc/k8s luster will be created in. |
| + stack_name |
No |
string |
No |
- |
Your stack name, needs to be unique within the cloud domain. |
| - static_includes |
No |
object |
No |
- |
This property contains specific hosts / stacks that need to be included for a schema extension. This way playbooks can statically
reference a host group and assume it to be a certain stack (e.g. postgres/haproxy/dhcp).
|
| - include_stacks |
No |
array of object |
No |
- |
Include other stacks into the ansible inventory, from any pve cloud you are connected to. From here you can freely extend and write your own playbooks. |
| + root_ssh_pub_key |
No |
string |
No |
- |
trusted root key for the cloud init image. |
| - pve_ha_group |
No |
string |
No |
- |
PVE HA group this vm should be assigned to (optional). |
| - target_pve_hosts |
No |
array of string |
No |
- |
Array of proxmox hosts in the target pve that are eligible for scheduling. If not specified all online hosts are considered. |
68. Property VM/LXC Base Schema > target_pve
Description: Proxmox cluster name + . + pve cloud domain. This determines the cloud and the proxmox cluster the vms/lxc/k8s luster will be created in.
Example:
"proxmox-cluster-a.your-cloud.domain"
69. Property VM/LXC Base Schema > stack_name
Description: Your stack name, needs to be unique within the cloud domain.
70. Property VM/LXC Base Schema > static_includes
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
Description: This property contains specific hosts / stacks that need to be included for a schema extension. This way playbooks can statically
reference a host group and assume it to be a certain stack (e.g. postgres/haproxy/dhcp).
71. Property VM/LXC Base Schema > include_stacks
|
|
| Type |
array of object |
| Required |
No |
Description: Include other stacks into the ansible inventory, from any pve cloud you are connected to. From here you can freely extend and write your own playbooks.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
71.1. VM/LXC Base Schema > include_stacks > include_stacks items
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Not allowed |
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + stack_fqdn |
No |
string |
No |
- |
Target stack fqdn to include (stack name + pve_cloud_domain). Will automatically include it from the right pve cluster. |
| + host_group |
No |
string |
No |
- |
This is the name of the hosts group of our ansible inventory the included vms/lxcs will be available under. |
| - qemu_ansible_user |
No |
string |
No |
- |
User ansible will use to connect, defaults to admin. If you dont want to use debian cinit images you might need to set something else than admin.
Ubuntu for example wont work if you set the cloud init user to admin.
|
71.1.1. Property VM/LXC Base Schema > include_stacks > include_stacks items > stack_fqdn
Description: Target stack fqdn to include (stack name + pve_cloud_domain). Will automatically include it from the right pve cluster.
Examples:
"bind.your-other-cloud.domain"
"other-k8s.your-other-cloud.domain"
71.1.2. Property VM/LXC Base Schema > include_stacks > include_stacks items > host_group
Description: This is the name of the hosts group of our ansible inventory the included vms/lxcs will be available under.
71.1.3. Property VM/LXC Base Schema > include_stacks > include_stacks items > qemu_ansible_user
Description: User ansible will use to connect, defaults to admin. If you dont want to use debian cinit images you might need to set something else than admin.
Ubuntu for example wont work if you set the cloud init user to admin.
72. Property VM/LXC Base Schema > root_ssh_pub_key
Description: trusted root key for the cloud init image.
73. Property VM/LXC Base Schema > pve_ha_group
Description: PVE HA group this vm should be assigned to (optional).
74. Property VM/LXC Base Schema > target_pve_hosts
|
|
| Type |
array of string |
| Required |
No |
Description: Array of proxmox hosts in the target pve that are eligible for scheduling. If not specified all online hosts are considered.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| target_pve_hosts items |
The hostname of the proxmox host. Just the hostname, no cluster name or cloud domain should be specified, as they are implicit. |
74.1. VM/LXC Base Schema > target_pve_hosts > target_pve_hosts items
Description: The hostname of the proxmox host. Just the hostname, no cluster name or cloud domain should be specified, as they are implicit.
Example:
"proxmox-host-a"