Attach an independent EIP to a pod

Create and associate EIPs with annotations

Use pod manifest annotations to create an EIP and associate it with the pod. See FAQ for annotation details.

1. Create an application and use annotations to create and associate an EIP with a pod.

   Deployment

   This manifest creates a Deployment where ACK automatically assigns an EIP instance with a peak bandwidth of 5 Mbps to each pod.

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: example
     labels:
       app: example
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: example
     template:
       metadata:
         labels:
           app: example
         annotations:
           k8s.aliyun.com/pod-with-eip: "true"
           k8s.aliyun.com/eip-bandwidth: "5"
       spec:
         readinessGates:
         - conditionType: "k8s.aliyun.com/eip"
         containers:
         - name: example
           image: nginx

   After the pod is created, query the podeips.alibabacloud.com resource that has the same name as the pod to view details of the assigned EIP.

   kubectl get podeip -n <namespace> <podname>  -o yaml

   Expected output:

   apiVersion: alibabacloud.com/v1beta1
   kind: PodEIP
   metadata:
     creationTimestamp: "2023-12-15T04:25:37Z"
     finalizers:
     - podeip-controller.alibabacloud.com/finalizer
     generation: 1
     name: example-xxx
     namespace: default
     resourceVersion: "222800"
     uid: 43xxx-f1xx-4xxx-b3xx-969faxxx
   spec:
     allocationID: eip-2ze2qe8zsxxx
     allocationType:
       releaseStrategy: Follow
       type: Auto
   status:
     eipAddress: 39.102.XX.XX
     internetChargeType: PayByTraffic
     isp: BGP
     networkInterfaceID: eni-2zeagv8f3xxxx
     podLastSeen: "2023-12-15T05:18:47Z"
     privateIPAddress: 192.168.XX.XX
     resourceGroupID: rg-acfmwxxxxxsq
     status: InUse

   StatefulSet

   Use the following manifest to create a StatefulSet with two pods. An EIP is automatically assigned to each pod, and the release strategy is set to delete the PodEIP resource 10 minutes after the corresponding pod is deleted.

   apiVersion: apps/v1
   kind: StatefulSet
   metadata:
     name: example
     labels:
       app: example
   spec:
     serviceName: "example"
     replicas: 2
     selector:
       matchLabels:
         app: example
     template:
       metadata:
         labels:
           app: example
         annotations:
           k8s.aliyun.com/pod-with-eip: "true"
           k8s.aliyun.com/pod-eip-release-strategy: "10m"
       spec:
         containers:
         - name: example
           image: nginx

   After the pods are created, query the podeips.alibabacloud.com resources to track information about the assigned EIPs.

   kubectl get podeip -n <namespace> -o yaml

   Expected output:

   apiVersion: v1
   items:
   - apiVersion: alibabacloud.com/v1beta1
     kind: PodEIP
     metadata:
       creationTimestamp: "2023-12-15T03:28:01Z"
       finalizers:
       - podeip-controller.alibabacloud.com/finalizer
       generation: 1
       name: example-0
       namespace: default
       resourceVersion: "227221"
       uid: 79954xx-17xx-4dxx-b7xx-15b84xxx
     spec:
       allocationID: eip-2ze08metxxx
       allocationType:
         releaseAfter: 10m
         releaseStrategy: TTL
         type: Auto
     status:
       eipAddress: 39.105.XX.XX
       internetChargeType: PayByTraffic
       isp: BGP
       networkInterfaceID: eni-2ze4tkg4xxx
       podLastSeen: "2023-12-15T05:31:34Z"
       privateIPAddress: 192.168.XX.XX
       resourceGroupID: rg-acfmwxxx
       status: InUse
   - apiVersion: alibabacloud.com/v1beta1
     kind: PodEIP
     metadata:
       creationTimestamp: "2023-12-15T03:28:03Z"
       finalizers:
       - podeip-controller.alibabacloud.com/finalizer
       generation: 1
       name: example-1
       namespace: default
       resourceVersion: "227222"
       uid: 1339xxxe7-97xx-46xx-9bxx-537690xxx
     spec:
       allocationID: eip-2zetwhffqxxx
       allocationType:
         releaseAfter: 10m
         releaseStrategy: TTL
         type: Auto
     status:
       eipAddress: 39.105.XX.XX
       internetChargeType: PayByTraffic
       isp: BGP
       networkInterfaceID: eni-2zeagv8f3wxxx
       podLastSeen: "2023-12-15T05:31:34Z"
       privateIPAddress: 192.168.XX.XX
       resourceGroupID: rg-acfmwqnwxxx
       status: InUse
   - apiVersion: alibabacloud.com/v1beta1
     kind: PodEIP
     metadata:
       creationTimestamp: "2023-12-15T04:25:37Z"
       finalizers:
       - podeip-controller.alibabacloud.com/finalizer
       generation: 1
       name: example-5bxxx-9xx
       namespace: default
       resourceVersion: "227220"
       uid: 43cdfxxx-f1xx-42xx-b3xx-969fxxx
     spec:
       allocationID: eip-2ze2qe8zsmnxxx
       allocationType:
         releaseStrategy: Follow
         type: Auto
     status:
       eipAddress: 39.102.XX.XX
       internetChargeType: PayByTraffic
       isp: BGP
       networkInterfaceID: eni-2zeagv8f3wxxx
       podLastSeen: "2023-12-15T05:31:34Z"
       privateIPAddress: 192.168.XX.XX
       publicIpAddressPoolID: pippool-2ze498cxxx
       resourceGroupID: rg-acfmwqnxxx
       status: InUse
   kind: List
   metadata:
     resourceVersion: ""

   After a pod in this stateful application is deleted, its PodEIP custom resource (CR) is retained for 10 minutes before being deleted. If a pod with the same name is created during this period, it reuses the corresponding EIP.

2. Verify the configuration.

   After the pod enters the Running state, check the k8s.aliyun.com/allocated-eipAddress annotation to view its assigned EIP address and access the pod.

1. Deploy the Terway configuration to support the EIP feature.

   1. Edit the Terway ConfigMap.

      kubectl edit cm eni-config -n kube-system

   2. In eni_conf, add the following line.

      "enable_eip_pool": "true"

      Note

      To forcibly disassociate an EIP from its current instance when you associate it with a new one, add the "allow_eip_rob": "true" parameter to eni_conf.

   3. After you finish editing, press the Esc key, enter :wq!, and press the Enter key to save your changes and exit edit mode.

   4. Recreate the Terway pods to apply the changes.

      kubectl delete pod -n kube-system -l app=terway-eniip # If you installed the terway-eni component, replace terway-eniip with terway-eni.

2. Create and associate an EIP with a pod by using annotations.

   Use pod manifest annotations to create an EIP and associate it with the pod. See EIP-related limits.

   Automatically assign an EIP

   Add these annotations to automatically assign an EIP and specify bandwidth:

   • k8s.aliyun.com/pod-with-eip: "true": Assign a dedicated public EIP to the pod.

   • k8s.aliyun.com/eip-bandwidth: "5": Specify EIP bandwidth. The default is 5 Mbps.

   Sample manifest:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: nginx-deployment-basic
     labels:
       app: nginx
   spec:
     replicas: 2
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         annotations:
           network.alibabacloud.com/pod-with-eip: "true" # Automatically assign a public EIP to the Nginx container.
           network.alibabacloud.com/eip-bandwidth: "5"   # Specify the bandwidth of the EIP. The default is 5 Mbps, which is consistent with the EIP default value.
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: nginx

   Specify an EIP

   Important

   • Because a single EIP cannot be associated with multiple pods, this method is not suitable for workloads such as Deployments and StatefulSets that have more than one replica.

   • By default, if the specified EIP is already associated with an instance, the association fails. To force the disassociation of the EIP from the previous instance and associate it with the new one, you must set "allow_eip_rob": "true" in the ConfigMap as described earlier.

   • You can specify an EIP instance ID only for single-replica workloads. For example, a Deployment cannot have more than one replica.

   Add the following annotation to specify an EIP instance ID for a pod:

   k8s.aliyun.com/pod-eip-instanceid: "<your-eip-instance-id>"

3. Verify the configuration.

   After the pod enters the Running state, check the network.alibabacloud.com/allocated-eipAddress annotation to view its assigned EIP address and access the pod.