Configuring a Static EIP for a Pod

Scenario

In CCE Autopilot clusters, static public IP addresses (EIPs) can be assigned to StatefulSets or pods that are created directly.

Constraints

• The static EIP function must be enabled together with the function of automatically allocating an EIP for a pod. For details, see Configuring an EIP for a Pod.
• Only StatefulSet pods or pods that are created directly can have static EIPs.
• After a static EIP is allocated, the EIP attributes cannot be modified through the pod within the EIP lifecycle (before the EIP expires or it is still being used by the pod).
• Do not configure a static EIP for services that do not have specific requirements on pod EIPs. Otherwise, the pod rebuilding takes a longer time.

Configuring a Static EIP for a Pod

When creating a pod to be bound with a static IP address, configure the EIP annotation. Then, an EIP will be automatically allocated and bound to the pod.

The following uses a StatefulSet named nginx as an example. For details about annotations, see Table 1.

• For an automatically allocated EIP with a dedicated bandwidth when you create a StatefulSet, you do not need to specify the bandwidth ID. The following shows an example:

  apiVersion: apps/v1
  kind: StatefulSet
  metadata:
    name: nginx
  spec:
    serviceName: nginx
    replicas: 3
    selector:
      matchLabels:
        app: nginx
    template:
      metadata:
        labels:
          app: nginx
        annotations:
          yangtse.io/static-eip: 'true'   # Static EIP bound to the pod
          yangtse.io/static-eip-expire-no-cascading: 'false'   # Deleting the EIP with the associated workload
          yangtse.io/static-eip-expire-duration: 5m   # Interval for reclaiming expired EIPs
          yangtse.io/pod-with-eip: 'true'   # An EIP will be automatically allocated when the pod is created.
          yangtse.io/eip-bandwidth-size: '5'    # EIP bandwidth
          yangtse.io/eip-network-type: 5_bgp    # EIP type
          yangtse.io/eip-charge-mode: bandwidth    # EIP billing mode
      spec:
        containers:
          - name: container-0
            image: nginx:alpine
            resources:
              limits:
                cpu: 100m
                memory: 200Mi
              requests:
                cpu: 100m
                memory: 200Mi
        imagePullSecrets:
          - name: default-secret

• For an automatically allocated EIP with a shared bandwidth when you create a StatefulSet, you are required to specify the bandwidth ID. The following shows an example:

  apiVersion: apps/v1
  kind: StatefulSet
  metadata:
    name: nginx
  spec:
    serviceName: nginx
    replicas: 3
    selector:
      matchLabels:
        app: nginx
    template:
      metadata:
        labels:
          app: nginx
        annotations:
          yangtse.io/static-eip: 'true'   # Static EIP bound to the pod
          yangtse.io/pod-with-eip: 'true'   # An EIP will be automatically allocated when the pod is created.
          yangtse.io/eip-network-type: 5_bgp    # EIP type
          yangtse.io/eip-bandwidth-id: <eip_bandwidth_id>    # Shared bandwidth ID of the EIP
      spec:
        containers:
          - name: container-0
            image: nginx:alpine
            resources:
              limits:
                cpu: 100m
                memory: 200Mi
              requests:
                cpu: 100m
                memory: 200Mi
        imagePullSecrets:
          - name: default-secret

Deleting a Static EIP

After a pod is deleted, if another pod with the same name is created before the static EIP expires, the EIP can still be used. The static EIP is deleted only if there is no new pod with the name the same as that of the deleted pod before the EIP expires, or the function of deleting the EIP with the associated StatefulSet is enabled and the StatefulSet is deleted.