Skip to main content

Aviatrix Edge Cluster - Specifications

Aviatrix Edge Cluster​

The Aviatrix Edge Cluster is delivered as a cluster deployment of the Aviatrix Cloud Connector using the Edge Gateway image family. The blueprint deploys two virtual machines in cluster mode and exposes the interfaces and service-specific inputs described below.

Flavors​

Choose a flavor for each virtual machine from the supported sizes below.

StandardDPDK
Small
2 vCPU
4 GB Mem
64 GB Disk
2 vCPU
4 GB Mem
64 GB Disk
Medium
4 vCPU
8 GB Mem
64 GB Disk
4 vCPU
8 GB Mem
64 GB Disk
Large
8 vCPU
16 GB Mem
64 GB Disk
8 vCPU
16 GB Mem
64 GB Disk

In the console you select a flavor per virtual device during provisioning.

Interfaces​

The diagram above shows both virtual machines and the three numbered interfaces used by the blueprint. Public IPv4 addresses shown for interfaces #1 - Internet Interface and #3 - Internet management interface are produced by the platform and displayed as provisioning outputs. The #2 - MPLS-VPN interface is configurable and accepts VPN entries and optional BGP settings.

#1 - Internet Interface​

This interface is marked informational in the blueprint. The platform allocates a public IPv4 address per VM and exposes it as a platform-generated output. There is no customer IP input required for this interface in the blueprint.

#2 - MPLS-VPN interface​

This interface is used to connect to one or more customer MPLS-VPN identifiers. It is configurable in the portal with the following customer-facing settings:

  • Activate interface — boolean toggle to enable or disable the interface in the provisioning template (default: active).
  • VPN list — an array of VPN entries you provide. Each entry contains:
    • VPN Name — alphanumeric identifier (pattern: letters, digits, dash or underscore).
    • VPN role — one of: any-to-any, client, server.

VPN list constraints: when present, the array requires at least 1 item and allows up to 99 items. Use the portal VPN editor to add and manage entries.

#3 - Internet management interface​

This interface is informational in the blueprint and the platform provides a public IPv4 address per VM as a provisioning output. There is no customer IP input required for this interface.

Routing and BGP parameters​

BGP is available as an optional configuration under the #2 - MPLS-VPN interface. When enabled, the blueprint accepts BGP parameters exposed in the console. The specification provides the following BGP-related input:

  • AS prepend — integer value between 1 and 6. The parameter indicates how many times to prepend the VM AS in applicable scenarios described by the blueprint. The specification does not define detailed route exchange behaviors; if BGP is not enabled, no BGP-specific configuration is applied through this setting.

Only the presence and allowed ranges of BGP fields are documented by the blueprint; do not assume route exchange behavior beyond what the console exposes.

Virtual device parameters​

Both virtual machines share the same provisioning model. Provide the following per-VM values during creation:

  • VM name — hostname for the VM (maximum 22 characters, allowed characters: letters, digits and dash).
  • Image — select one of the supported full image names shown in the Software section below.
  • Flavor — choose a flavor from the supported list.
  • Userdata (cloud-init) — base64-encoded userdata content to be consumed by the VM at provisioning time.

Optional VM-level values:

  • VM AS number — optional AS number (2- or 4-byte allowed). Accepted range: 1 to 4294967295.
  • VM placement — optional server group policy; allowed values include affinity, anti-affinity, soft-anti-affinity, soft-affinity.

Validate vm_name pattern and length, ensure image and flavor selections match the enumerated lists, and check that userdata is provided in base64 when required by the console.

Service specific parameters​

Service specific parameters are provisioning-level inputs required by this blueprint. They are not VM interface IPs nor platform outputs; they identify networks or ranges the service needs during provisioning.

  • Transit gateways networks

    • What this is: a list of IPv4 network ranges in CIDR notation that represent transit gateway networks relevant to the service.
    • Why the platform needs it: the blueprint requires these ranges as service inputs during provisioning; the specification does not describe how they are used at runtime.
    • Format and constraints: provide one or more IPv4 CIDR strings. Minimum items: 1, maximum items: 9.
    • Required: yes (mandatory for provisioning). Not updatable after provisioning according to the blueprint.

  • Controllers network

    • What this is: an IPv4 CIDR that identifies the controller network used by the service.
    • Why the platform needs it: required by the blueprint during provisioning; runtime usage is not detailed in the specification.
    • Format and constraints: a single IPv4 CIDR string. Required: yes. Not updatable after provisioning.

  • Copilots network

    • What this is: an IPv4 CIDR that identifies the Copilots network used by the service.
    • Why the platform needs it: required by the blueprint during provisioning; runtime usage is not detailed in the specification.
    • Format and constraints: a single IPv4 CIDR string. Required: yes. Not updatable after provisioning.

Example values appear in the deployment example but do not imply recommended values; provide ranges that match your network design.

Platform-generated outputs​

The platform exposes public IPv4 addresses as provisioning outputs for the informational interfaces listed below. These addresses are produced by the platform and shown in the provisioning results; they are not customer-provided inputs during initial provisioning.

  • Public IPv4 address for #1 - Internet Interface (one address per VM).
  • Public IPv4 address for #3 - Internet management interface (one address per VM).

Software device versions​

Below are the software images supported by this blueprint. Use the exact full image name when selecting the image in the console.

  • 7.0-2023-05-18
  • 7.1-2023-04-24
  • 8.0-2025-04-25
  • 8.1-2025-07-29

Supported image names (examples listed by the platform):

  • avx-edge-gateway-kvm-7.0-2023-05-18
  • avx-edge-kvm-7.1-2023-04-24
  • avx-gateway-avx-g3-202504251525
  • avx-gateway-g4-202507291722
Aviatrix Documentation
Aviatrix Legacy Documentation (v7.1)