OpenMCF logoOpenMCF

Loading...

OpenStack Floating IP

Deploys an OpenStack Neutron floating IP, allocating an external (public) IP address from a provider network. The floating IP can optionally be associated with a port for immediate external connectivity, or allocated standalone for later association via the separate OpenStackFloatingIpAssociate component.

What Gets Created

When you deploy an OpenStackFloatingIp resource, OpenMCF provisions:

  • Neutron Floating IP — an openstack_networking_floatingip_v2 resource allocated from the specified external network, with optional built-in port association, specific address reservation, and tags

Prerequisites

  • OpenStack credentials configured via environment variables or OpenMCF provider config
  • An existing external (provider) network — provided as a literal UUID or via valueFrom reference to an OpenStackNetwork resource
  • An existing port if using built-in association via portId

Quick Start

Create a file floating-ip.yaml:

apiVersion: openstack.openmcf.org/v1
kind: OpenStackFloatingIp
metadata:
  name: my-fip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.OpenStackFloatingIp.my-fip
spec:
  floatingNetworkId:
    value: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

Deploy:

openmcf apply -f floating-ip.yaml

This allocates a floating IP from the specified external network. The IP is not associated with any port (allocation-only mode). Use the address output for DNS configuration, firewall rules, or later association.

Configuration Reference

Required Fields

FieldTypeDescriptionValidation
floatingNetworkIdStringValueOrRefID of the external (provider) network from which the floating IP is allocated. This is the pool of public IP addresses. Can reference an OpenStackNetwork resource via valueFrom.required

Optional Fields

FieldTypeDefaultDescription
portIdStringValueOrRef—ID of an existing port to associate with this floating IP. When set, the floating IP is immediately bound to the port, providing external connectivity to whatever is attached to that port. Omit for allocation-only mode. Can reference an OpenStackNetworkPort resource via valueFrom.
fixedIpstring—Fixed IP address on the port to associate the floating IP with. Only relevant when portId is set and the port has multiple IP addresses. If the port has a single IP, this can be omitted. Validation: can only be set when portId is configured.
subnetIdstring—UUID of a subnet within the external network from which to allocate the floating IP. References an admin-managed subnet on the provider network. If omitted, OpenStack allocates from any available subnet.
addressstring—Requests a specific floating IP address from the pool. If omitted, OpenStack allocates any available address. ForceNew: changing this value destroys and recreates the resource. Use for DNS pre-configuration, firewall whitelisting, or IP reservation.
descriptionstring—Human-readable description of the floating IP, visible in the OpenStack API and Horizon.
tagsstring[][]Tags for filtering and organization in the OpenStack API and Horizon dashboard. Must be unique.
regionstringprovider defaultOverrides the region from the provider config for this floating IP.

Examples

Allocation-Only Floating IP

A floating IP allocated from an external network with no port association. Suitable for reserving a public IP before the target port or instance exists:

apiVersion: openstack.openmcf.org/v1
kind: OpenStackFloatingIp
metadata:
  name: web-fip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.OpenStackFloatingIp.web-fip
spec:
  floatingNetworkId:
    value: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  description: Web server floating IP (allocation only)

Floating IP with Port Association

A floating IP allocated and immediately associated with a port, using valueFrom references to other OpenMCF resources for both the external network and the target port:

apiVersion: openstack.openmcf.org/v1
kind: OpenStackFloatingIp
metadata:
  name: app-fip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: staging.OpenStackFloatingIp.app-fip
spec:
  floatingNetworkId:
    valueFrom:
      kind: OpenStackNetwork
      name: external-net
      fieldPath: status.outputs.network_id
  portId:
    valueFrom:
      kind: OpenStackNetworkPort
      name: app-port
      fieldPath: status.outputs.port_id
  description: Application server floating IP
  tags:
    - staging
    - app-tier

Reserved IP Address

A floating IP with a specific address requested from the pool, useful for DNS pre-configuration or firewall whitelisting where the IP must be known before allocation:

apiVersion: openstack.openmcf.org/v1
kind: OpenStackFloatingIp
metadata:
  name: lb-fip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.OpenStackFloatingIp.lb-fip
spec:
  floatingNetworkId:
    valueFrom:
      kind: OpenStackNetwork
      name: external-net
      fieldPath: status.outputs.network_id
  address: "203.0.113.42"
  portId:
    valueFrom:
      kind: OpenStackNetworkPort
      name: lb-port
      fieldPath: status.outputs.port_id
  description: Load balancer floating IP with reserved address
  region: RegionOne
  tags:
    - production
    - load-balancer

Stack Outputs

After deployment, the following outputs are available in status.outputs:

OutputTypeDescription
floating_ip_idstringUUID of the floating IP resource in OpenStack.
addressstringThe allocated floating IP address (e.g., 203.0.113.42). Primary output for DNS configuration, firewall rules, and FK target for OpenStackFloatingIpAssociate.
floating_network_idstringUUID of the external network the floating IP was allocated from.
port_idstringUUID of the port this floating IP is associated with. Empty if allocation-only mode.
fixed_ipstringFixed IP address on the port that the floating IP is mapped to. Empty if no port association exists.
regionstringOpenStack region where the floating IP was allocated.

Related Components

  • OpenStackNetwork — the external (provider) network from which floating IPs are allocated
  • OpenStackNetworkPort — the port that a floating IP can be associated with for external connectivity
  • OpenStackFloatingIpAssociate — associates an existing floating IP with a port as a separate DAG node in InfraCharts
  • OpenStackRouter — provides routing between tenant and external networks
  • OpenStackInstance — compute instances that gain external connectivity through floating IPs

Next article

OpenStack Floating IP Associate

OpenStack Floating IP Associate Associates an existing OpenStack Neutron floating IP with a port, providing external connectivity to whatever is attached to the port (typically a compute instance). This is a join resource that connects two independently managed resources -- a floating IP allocated via OpenStackFloatingIp and a port created via OpenStackNetworkPort -- making the association relationship explicit as a visible DAG node in InfraCharts. What Gets Created When you deploy an...
Read next article
Presets
2 ready-to-deploy configurationsView presets →