Skip to content

Ansible Role linuxfabrik.lfops.infomaniak_vm

This role creates and manages instances (virtual machines) on Infomaniak. It also allows creating other compontents for the instance, such as networks and firewall rules.

Mandatory Requirements

  • Install the openstack command line tool.
  • Import your public SSH-key into Infomaniak (here). Ideally, set the key name to your local username (replace . with ), then you can use the default value for infomaniak_vm__key_name.

Tags

infomaniak_vm

  • Creates and manages the instance.
  • Triggers: none.

infomaniak_vm:networks

  • Manage the networks of the host.
  • Triggers: none.

infomaniak_vm:firewalls

  • Manage the provider security groups (basically the firewall policies) of the host.
  • Triggers: none.

Mandatory Role Variables

infomaniak_vm__flavor

  • The flavor for the instance. This defines the amount of CPU cores, RAM and disk space. The possible options can be obtained using openstack flavor list.
  • Type: String.

infomaniak_vm__image

  • The image to use for this instance. The possible options can be obtained using openstack image list.
  • Type: String.

infomaniak_vm__api_password

  • The password for the OpenStack API. Normally this is the same as your admin user login.
  • Type: String.

infomaniak_vm__api_project_id

  • The project ID for the OpenStack API. Can be obtained by running openstack project list after downloading and sourcing the OpenStack RC file.
  • Type: String.

infomaniak_vm__api_username

  • The username for the OpenStack API. Normally this is the same as your admin user login.
  • Type: String.

Example:

# mandatory
infomaniak_vm__flavor: 'a1-ram2-disk50-perf1'
infomaniak_vm__image: 'Rocky 8 Generic Cloud'
infomaniak_vm__api_password: 'linuxfabrik'
infomaniak_vm__api_project_id: 'oitexaeTeivaoRo7einuighRiegh4iexah'
infomaniak_vm__api_username: 'PCU-123456'

Optional Role Variables

infomaniak_vm__key_name

  • The name of the deposited SSH-key. Defaults to using the local username of the Ansible control node, but replaces all . with , since periods are not allowed in the key name.
  • Type: String.
  • Default: '{{ lookup("env", "USER") | regex_replace(".", " ") }}'

infomaniak_vm__name

  • The name of the instance. By default, it uses the Ansible inventory name.
  • Type: String.
  • Default: '{{ inventory_hostname }}'

infomaniak_vm__networks

  • A list of dictionaries defining which networks should be attached to this instance. It also allows the creation of new internal networks, or setting a fixed IP for the instance.

  • Subkeys:

    • name:

      • Mandatory. The name of an existing network, or the network which should be created.
      • Type: String.

    • cidr:

      • Optional. If this is given, a new network with this cidr is created.
      • Type: String.

    • fixed_ip:

      • Optional. The fixed IP of this instance. This can be used for attach to an existing network, or when creating a new one.
      • Type: String.

  • Type: List of dictionaries.

  • Default: []

infomaniak_vm__region_name

  • The region/datacentre where the VM instance should be created.
  • Type: String.
  • Default: 'dc3-a'

infomaniak_vm__security_group_rules

  • A list of dictionaries containing rules for the security group (basically OpenStack firewall rules).

  • Subkeys:

    • direction:

      • Mandatory. For which direction the rule should apply. Possible options: ingress, egress.
      • Type: String.

    • ethertype:

      • Optional. Choose between IPv4 and IPv6.
      • Type: String.
      • Default: 'IPv4'

    • port_range_max:

      • Mandatory. The ending port.
      • Type: Number.

    • port_range_min:

      • Mandatory. The starting port.
      • Type: Number.

    • protocol:

      • Mandatory. To which IP protocol the rule is applied. Possible options: any, tcp, udp, icmp.
      • Type: String.

    • remote_ip_prefix:

      • Optional. Source IP address(es) in CIDR notation.
      • Type: String.

    • state:

      • Optional. State of the rule. Either absent or present.
      • Type: String.
      • Default: 'present'

  • Type: List of dictionaries.

  • Default: unset

infomaniak_vm__separate_boot_volume_size

  • The size of the bootable root-volume in GB. This should only be used if the infomaniak_vm__flavor does not include a disk. Resizing currently does not seem to work (should work according to the documentation). Resizing via the WebGUI works without reboot / downtime.
  • Type: Number.
  • Default: unset

infomaniak_vm__separate_boot_volume_type

  • The type of the bootable root-volume. This only has an effect if infomaniak_vm__separate_boot_volume_size is set. Possible options: 'perf1', 'perf2'.
  • Type: String.
  • Default: 'perf2'

infomaniak_vm__state

  • The state of the instance. Note that setting this to absent also removes all other created compontents, except the networks, which are never deleted since other VMs could still be using them. Possible options: present, absent.
  • Type: String.
  • Default: 'present'

Example:

# optional
infomaniak_vm__key_name: '{{ lookup("env", "USER") | regex_replace(".", " ") }}'
infomaniak_vm__name: '{{ inventory_hostname }}'
infomaniak_vm__networks:
  - name: 'ext-net1'
  - name: 'test-network'
    cidr: '10.1.3.0/24'
    fixed_ip: '10.1.3.1'
infomaniak_vm__security_group_rules:
  - direction: 'ingress'
    protocol: 'tcp'
    port_range_min: 22
    port_range_max: 22
infomaniak_vm__region_name: 'dc4-a'
infomaniak_vm__separate_boot_volume_size: 20
infomaniak_vm__separate_boot_volume_type: 'perf2'
infomaniak_vm__state: 'present'

Troubleshooting

BadRequestException: 400: Client Error for url: https://api....infomaniak.cloud/compute/v2.1/..., Invalid key_name provided.: Provide the correct "Key Pair Name" of your SSH Key. It should match your local Linux username.

License

The Unlicense

Author Information

Linuxfabrik GmbH, Zurich