OVF

Default builder type: OVF or OVA

Require Cloud Account: No

The OVF builder provides information for building OVF (Open Virtualization Format) compatible machine images. This builder type is the default name provided by UForge AppCenter.

Note

This builder type name can be changed by your UForge administrator. To get the available builder types, please refer to format

The OVF builder section has the following definition when using YAML:

---
builders:
- type: OVF or OVA
        # the rest of the definition goes here.

If you are using JSON:

{
  "builders": [
    {
      "type": "OVF or OVA",
      ...the rest of the definition goes here.
    }
  ]
}

The OVF builder has the following valid keys:

  • type (mandatory): a string providing the machine image type to build. Default builder type for OVF: OVF or OVA. To get the available builder type, please refer to format
  • hardwareSettings (mandatory): an object providing hardware settings to be used for the machine image. The following valid keys for hardware settings are:
    • memory (mandatory): an integer providing the amount of RAM to provide to an instance provisioned from the machine image (in MB).
    • hwType (optional): the VMware hardware type: 4 (ESXi>3.x), 7 (ESXi>4.x) or 9 (ESXi>5.x)
  • installation (optional): an object providing low-level installation or first boot options. These override any installation options in the Stack section. The following valid keys for installation are:
    • diskSize (mandatory): an integer providing the disk size of the machine image to create. Note, this overrides any disk size information in the stack. This cannot be used if an advanced partitioning table is defined in the stack.

Note

When building from a scan, your yaml or json file must contain an installation section in builders. This is mandatory when you create a new template, but might be missing when you build from a scan. Make sure it is present or your build will fail.

Example

The following example shows an OVF builder.

If you are using YAML:

---
builders:
- type: OVF or OVA
  hardwareSettings:
    memory: 1024
    hwType: "7 (ESXi>4.x)"

If you are using JSON:

{
  "builders": [
    {
      "type": "OVF or OVA",
      "hardwareSettings": {
        "memory": 1024,
        "hwType": "7 (ESXi>4.x)"
      }
    }
  ]
}