provision_vm.yaml

---
version: '2.0'

provision_jupyterhub_vm:
  description: >
    Provisions a VM on the EOSC EU Node (PSNC) complete with a private network,
    subnet, router gateway to PSNC-EXT-PUB1-EDU, and an assigned floating IP.
    Assumes a keypair has already been imported into the project.

  input:
    - instance_name: "JupyterHub"
    - instance_description: "JupyterHub VM"
    - image_name: "ubuntu-24.04"
    - flavor_name: "C1-NVME-16vCPU-64R-100D"
    - network_name: "jupyterhub-net"
    - subnet_name: "jupyterhub-subnet"
    - subnet_cidr: "10.10.40.0/24"
    - router_name: "jupyterhub-router"
    - external_network_name: "PSNC-EXT-PUB1-EDU"
    - keypair_name: "my-keypair"
    - dns_nameservers:
        - "1.1.1.1"
        - "1.0.0.1"

  output:
    instance_id: <% $.instance_id %>
    private_ip: <% $.private_ip %>
    floating_ip: <% $.floating_ip %>

  tasks:

    # ------------------------------------------------------------------
    # 1. Resolve resource IDs from human-readable names
    # ------------------------------------------------------------------

    get_external_network:
      description: Look up the external network ID by name.
      action: neutron.list_networks
      input:
        name: <% $.external_network_name %>
      publish:
        external_network_id: <% task().result.networks[0].id %>
      on-success:
        - get_image

    get_image:
      description: Look up the image ID by name.
      action: glance.images_list
      input:
        filters:
          name: <% $.image_name %>
      publish:
        image_id: <% task().result[0].id %>
      on-success:
        - get_flavor

    get_flavor:
      description: Look up the flavour ID by name.
      action: nova.flavors_find
      input:
        name: <% $.flavor_name %>
      publish:
        flavor_id: <% task().result.id %>
      on-success:
        - create_network

    # ------------------------------------------------------------------
    # 2. Create private network and subnet
    # ------------------------------------------------------------------

    create_network:
      description: Create the private tenant network.
      action: neutron.create_network
      input:
        body:
          network:
            name: <% $.network_name %>
            admin_state_up: true
      publish:
        network_id: <% task().result.network.id %>
      on-success:
        - create_subnet

    create_subnet:
      description: Create a subnet on the private network with DHCP and DNS.
      action: neutron.create_subnet
      input:
        body:
          subnet:
            name: <% $.subnet_name %>
            network_id: <% $.network_id %>
            ip_version: 4
            cidr: <% $.subnet_cidr %>
            enable_dhcp: true
            dns_nameservers: <% $.dns_nameservers %>
      publish:
        subnet_id: <% task().result.subnet.id %>
      on-success:
        - create_router

    # ------------------------------------------------------------------
    # 3. Create router and attach subnet
    # ------------------------------------------------------------------

    create_router:
      description: Create a router with PSNC-EXT-PUB1-EDU as the external gateway.
      action: neutron.create_router
      input:
        body:
          router:
            name: <% $.router_name %>
            admin_state_up: true
            external_gateway_info:
              network_id: <% $.external_network_id %>
      publish:
        router_id: <% task().result.router.id %>
      on-success:
        - add_router_interface

    add_router_interface:
      description: Attach the private subnet to the router.
      action: neutron.add_interface_router
      input:
        router: <% $.router_id %>
        body:
          subnet_id: <% $.subnet_id %>
      on-success:
        - create_instance

    # ------------------------------------------------------------------
    # 4. Launch the instance
    # ------------------------------------------------------------------

    create_instance:
      description: Launch the VM on the private network.
      action: nova.servers_create
      input:
        name: <% $.instance_name %>
        description: <% $.instance_description %>
        image: <% $.image_id %>
        flavor: <% $.flavor_id %>
        key_name: <% $.keypair_name %>
        nics:
          - net-id: <% $.network_id %>
      publish:
        instance_id: <% task().result.id %>
      on-success:
        - wait_for_instance

    wait_for_instance:
      description: Poll until the instance reaches ACTIVE status.
      action: nova.servers_find
      input:
        id: <% $.instance_id %>
        status: ACTIVE
      retry:
        delay: 10
        count: 30
      publish:
        private_ip: <% task().result.addresses.values().first().first().addr %>
      on-success:
        - get_instance_port
      on-error:
        - fail_instance

    fail_instance:
      description: Fail the workflow explicitly if the instance never reaches ACTIVE.
      action: std.fail
      input:
        msg: "Instance <% $.instance_id %> did not reach ACTIVE within the polling window."

    # ------------------------------------------------------------------
    # 5. Allocate and associate a floating IP
    # ------------------------------------------------------------------

    get_instance_port:
      description: Find the neutron port associated with the instance on the private network.
      action: neutron.list_ports
      input:
        device_id: <% $.instance_id %>
        network_id: <% $.network_id %>
      publish:
        port_id: <% task().result.ports[0].id %>
      on-success:
        - allocate_floating_ip

    allocate_floating_ip:
      description: Allocate a floating IP from the external network pool.
      action: neutron.create_floatingip
      input:
        body:
          floatingip:
            floating_network_id: <% $.external_network_id %>
            port_id: <% $.port_id %>
      publish:
        floating_ip: <% task().result.floatingip.floating_ip_address %>
        floatingip_id: <% task().result.floatingip.id %>