OpenMCF logoOpenMCF

Loading...

AliCloud EIP Address

Deploys an Alibaba Cloud Elastic IP Address (EIP). The component provisions a standalone public IPv4 address that persists independently of any cloud resource, allowing it to be associated with and disassociated from NAT gateways, load balancers, VPN gateways, and ECS instances without changing the address.

What Gets Created

When you deploy an AliCloudEipAddress resource, OpenMCF provisions:

  • EIP -- an alicloud_eip_address resource in the specified region with configurable bandwidth, ISP, and metering settings

Prerequisites

  • Alibaba Cloud credentials configured via environment variables or OpenMCF provider config

Quick Start

Create a file eip.yaml:

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudEipAddress
metadata:
  name: my-eip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.AliCloudEipAddress.my-eip
spec:
  region: cn-hangzhou
  addressName: my-nat-eip
  description: EIP for NAT gateway outbound access
  bandwidth: 10

Deploy:

openmcf apply -f eip.yaml

This allocates a 10 Mbps EIP using BGP multi-line and PayByTraffic metering.

Configuration Reference

Required Fields

FieldTypeDescriptionValidation
regionstringAlibaba Cloud region for the EIP allocation (e.g., cn-hangzhou, us-west-1).Required; non-empty

Optional Fields

FieldTypeDefaultDescription
addressNamestring""EIP display name (1-128 chars).
descriptionstring""Human-readable description.
bandwidthint325Maximum outbound bandwidth in Mbps (1-1000).
internetChargeTypestring"PayByTraffic"Metering method. PayByTraffic bills per GB. PayByBandwidth bills for reserved bandwidth. Immutable after creation.
ispstring"BGP"ISP line type. BGP (default), BGP_PRO, ChinaTelecom, ChinaUnicom, ChinaMobile, and L2/FinanceCloud/International variants. Immutable after creation.
resourceGroupIdstring""Resource group ID for organizational grouping.
tagsmap<string, string>{}Tags applied to the EIP. Merged with standard OpenMCF tags.

Examples

Minimal EIP

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudEipAddress
metadata:
  name: my-eip
spec:
  region: cn-hangzhou

Named EIP for NAT Gateway

A named EIP intended for association with a NAT gateway. Uses default 5 Mbps bandwidth and PayByTraffic metering:

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudEipAddress
metadata:
  name: nat-eip
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.AliCloudEipAddress.nat-eip
spec:
  region: cn-shanghai
  addressName: prod-nat-eip
  description: EIP for production NAT gateway outbound access
  tags:
    purpose: nat
    team: platform

High-Bandwidth Production EIP

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudEipAddress
metadata:
  name: prod-lb-eip
  org: my-org
  env: production
spec:
  region: cn-hangzhou
  addressName: prod-alb-eip
  description: High-bandwidth EIP for production ALB
  bandwidth: 100
  internetChargeType: PayByBandwidth
  isp: BGP_PRO
  resourceGroupId: rg-prod-123
  tags:
    team: platform
    costCenter: engineering

Stack Outputs

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

OutputTypeDescription
eip_idstringThe EIP allocation ID assigned by Alibaba Cloud
ip_addressstringThe allocated public IPv4 address

Related Components

  • AliCloudNatGateway -- associate this EIP for SNAT outbound internet access
  • AliCloudApplicationLoadBalancer -- use this EIP for internet-facing ALB
  • AliCloudNetworkLoadBalancer -- use this EIP for internet-facing NLB
  • AliCloudVpnGateway -- use this EIP for VPN gateway public endpoint

Next article

AliCloud Function

AliCloud Function Deploys an Alibaba Cloud Function Compute v3 function. The component provisions a single alicloudfcv3function resource with configurable runtime, compute sizing, VPC networking, SLS logging, custom container/runtime settings, lifecycle hooks, NAS mounts, and GPU acceleration. FC v3 uses a service-less model where functions are top-level resources — VPC access, logging, IAM role, and all other configuration is set directly on the function. Triggers, aliases, versions, and...
Read next article
Presets
2 ready-to-deploy configurationsView presets →