Chapter 12. Tutorial: Assign a consistent egress IP for external traffic
You can configure a set of predictable IP addresses for egress cluster traffic. Assigning a consistent IP address for outbound cluster traffic is useful when external resources, such as security groups, require an IP-based configuration to meet security standards.
By default, Red Hat OpenShift Service on AWS uses the OVN-Kubernetes container network interface (CNI) to assign random IP addresses from a pool. This can make configuring security lockdowns unpredictable or open.
12.1. Set environment variables Copy linkLink copied to clipboard!
Set environment variables to ensure consistency across the commands in this tutorial.
Prerequisites
- You have created a Red Hat OpenShift Service on AWS cluster deployed with OVN-Kubernetes.
-
You have access to the OpenShift CLI (
oc). -
You have access to the ROSA command-line interface (CLI) (
rosa). -
You have access to the
jqcommand-line JSON processor.
Procedure
Set your environment variables by running the following command:
NoteReplace the value of the
ROSA_MACHINE_POOL_NAMEvariable to target a different machine pool.$ export ROSA_CLUSTER_NAME=$(oc get infrastructure cluster -o=jsonpath="{.status.infrastructureName}" | sed 's/-[a-z0-9]\{5\}$//')$ export ROSA_MACHINE_POOL_NAME=worker
12.2. Ensure IP address capacity Copy linkLink copied to clipboard!
Confirm that your nodes have available IP address capacity. Each public cloud provider limits the number of IP addresses that you can assign to each node.
Procedure
Verify sufficient capacity by running the following command:
$ oc get node -o json | \ jq '.items[] | { "name": .metadata.name, "ips": (.status.addresses | map(select(.type == "InternalIP") | .address)), "capacity": (.metadata.annotations."cloud.network.openshift.io/egress-ipconfig" | fromjson[] | .capacity.ipv4) }'Example output
{ "name": "ip-10-10-145-88.ec2.internal", "ips": [ "10.10.145.88" ], "capacity": 14 } { "name": "ip-10-10-154-175.ec2.internal", "ips": [ "10.10.154.175" ], "capacity": 14 }
12.3. Create the egress IP rules Copy linkLink copied to clipboard!
Configure egress IP rules to provide reserved, consistent IP addresses for your outbound cluster traffic. Before creating the egress IP rules, identify which egress IPs to use.
The egress IPs that you select should exist as a part of the subnets in which the worker nodes are provisioned.
Procedure
Reserve the egress IPs that you requested to avoid conflicts with the AWS Virtual Private Cloud (VPC) Dynamic Host Configuration Protocol (DHCP) service.
Request explicit IP reservations on the AWS documentation for CIDR reservations page.
12.4. Assign an egress IP to a namespace Copy linkLink copied to clipboard!
Assign an egress IP to a namespace on your cluster to ensure that all pods inside it use a consistent, predictable address for external connections.
Procedure
Create a new project by running the following command:
$ oc new-project demo-egress-nsCreate the egress rule for all pods within the namespace by running the following command:
$ cat <<EOF | oc apply -f - apiVersion: k8s.ovn.org/v1 kind: EgressIP metadata: name: demo-egress-ns spec: # NOTE: these egress IPs are within the subnet range(s) in which my worker nodes # are deployed. egressIPs: - 10.10.100.253 - 10.10.150.253 - 10.10.200.253 namespaceSelector: matchLabels: kubernetes.io/metadata.name: demo-egress-ns EOF
12.5. Assign an egress IP to a pod Copy linkLink copied to clipboard!
Create an egress rule to assign a consistent egress IP to a specified pod so that its outbound traffic uses a predictable IP.
Procedure
Create a new project by running the following command:
$ oc new-project demo-egress-podCreate the egress rule for the pod by running the following command:
Notespec.namespaceSelectoris a mandatory field.$ cat <<EOF | oc apply -f - apiVersion: k8s.ovn.org/v1 kind: EgressIP metadata: name: demo-egress-pod spec: # NOTE: these egress IPs are within the subnet range(s) in which my worker nodes # are deployed. egressIPs: - 10.10.100.254 - 10.10.150.254 - 10.10.200.254 namespaceSelector: matchLabels: kubernetes.io/metadata.name: demo-egress-pod podSelector: matchLabels: run: demo-egress-pod EOF
12.5.1. Label the nodes Copy linkLink copied to clipboard!
Apply labels to worker nodes for egress IP assignments.
Procedure
Obtain your pending egress IP assignments by running the following command:
$ oc get egressipsExample output
NAME EGRESSIPS ASSIGNED NODE ASSIGNED EGRESSIPS demo-egress-ns 10.10.100.253 demo-egress-pod 10.10.100.254The egress IP rule that you created only applies to nodes with the
k8s.ovn.org/egress-assignablelabel. Make sure that the label is only on a specific machine pool.Assign the label to your machine pool using the following command:
WarningIf you rely on node labels for your machine pool, this command will replace those labels. Be sure to input your desired labels into the
--labelsfield to ensure your node labels remain.$ rosa update machinepool ${ROSA_MACHINE_POOL_NAME} \ --cluster="${ROSA_CLUSTER_NAME}" \ --labels "k8s.ovn.org/egress-assignable="
12.5.2. Review the egress IPs Copy linkLink copied to clipboard!
Review egress IP assignments to verify that each egress IP address is correctly assigned to a node.
Procedure
Review the egress IP assignments by running the following command:
$ oc get egressipsExample output
NAME EGRESSIPS ASSIGNED NODE ASSIGNED EGRESSIPS demo-egress-ns 10.10.100.253 ip-10-10-156-122.ec2.internal 10.10.150.253 demo-egress-pod 10.10.100.254 ip-10-10-156-122.ec2.internal 10.10.150.254
12.5.3. Deploy a sample application Copy linkLink copied to clipboard!
To test the egress IP rule, create a service that is restricted to the egress IP addresses that you specified. The service simulates an external service that expects a small subset of IP addresses.
Procedure
Run the
echoservercommand to replicate a request:$ oc -n default run demo-service --image=gcr.io/google_containers/echoserver:1.4Expose the pod as a service and limit the ingress to the egress IP addresses you specified by running the following command:
$ cat <<EOF | oc apply -f - apiVersion: v1 kind: Service metadata: name: demo-service namespace: default annotations: service.beta.kubernetes.io/aws-load-balancer-scheme: "internal" service.beta.kubernetes.io/aws-load-balancer-internal: "true" spec: selector: run: demo-service ports: - port: 80 targetPort: 8080 type: LoadBalancer externalTrafficPolicy: Local # NOTE: this limits the source IPs that are allowed to connect to our service. It # is being used as part of this demo, restricting connectivity to our egress # IP addresses only. # NOTE: these egress IPs are within the subnet range(s) in which my worker nodes # are deployed. loadBalancerSourceRanges: - 10.10.100.254/32 - 10.10.150.254/32 - 10.10.200.254/32 - 10.10.100.253/32 - 10.10.150.253/32 - 10.10.200.253/32 EOFRetrieve the load balancer hostname and save it as an environment variable by running the following command:
$ export LOAD_BALANCER_HOSTNAME=$(oc get svc -n default demo-service -o json | jq -r '.status.loadBalancer.ingress[].hostname')
12.5.4. Test the namespace egress Copy linkLink copied to clipboard!
Verify that your namespace egress IP configuration works correctly.
Procedure
Start an interactive shell to test the namespace egress rule:
$ oc run \ demo-egress-ns \ -it \ --namespace=demo-egress-ns \ --env=LOAD_BALANCER_HOSTNAME=$LOAD_BALANCER_HOSTNAME \ --image=registry.access.redhat.com/ubi9/ubi -- \ bashSend a request to the load balancer and ensure that you can successfully connect:
$ curl -s http://$LOAD_BALANCER_HOSTNAMECheck the output for a successful connection:
NoteThe
client_addressis the internal IP address of the load balancer, not your egress IP. You can verify that you have configured the client address correctly by connecting with your service limited to.spec.loadBalancerSourceRanges.Example output
CLIENT VALUES: client_address=10.10.207.247 command=GET real path=/ query=nil request_version=1.1 request_uri=http://internal-a3e61de18bfca4a53a94a208752b7263-148284314.us-east-1.elb.amazonaws.com:8080/ SERVER VALUES: server_version=nginx: 1.10.0 - lua: 10001 HEADERS RECEIVED: accept=*/* host=internal-a3e61de18bfca4a53a94a208752b7263-148284314.us-east-1.elb.amazonaws.com user-agent=curl/7.76.1 BODY: -no body in request-Exit the pod by running the following command:
$ exit
12.5.5. Test the pod egress Copy linkLink copied to clipboard!
Verify that your egress IP configuration works correctly.
Procedure
Start an interactive shell to test the pod egress rule:
$ oc run \ demo-egress-pod \ -it \ --namespace=demo-egress-pod \ --env=LOAD_BALANCER_HOSTNAME=$LOAD_BALANCER_HOSTNAME \ --image=registry.access.redhat.com/ubi9/ubi -- \ bashSend a request to the load balancer by running the following command:
$ curl -s http://$LOAD_BALANCER_HOSTNAMECheck the output for a successful connection:
NoteThe
client_addressis the internal IP address of the load balancer, not your egress IP. You can verify that you have configured the client address correctly by connecting with your service limited to.spec.loadBalancerSourceRanges.Example output
CLIENT VALUES: client_address=10.10.207.247 command=GET real path=/ query=nil request_version=1.1 request_uri=http://internal-a3e61de18bfca4a53a94a208752b7263-148284314.us-east-1.elb.amazonaws.com:8080/ SERVER VALUES: server_version=nginx: 1.10.0 - lua: 10001 HEADERS RECEIVED: accept=*/* host=internal-a3e61de18bfca4a53a94a208752b7263-148284314.us-east-1.elb.amazonaws.com user-agent=curl/7.76.1 BODY: -no body in request-Exit the pod by running the following command:
$ exit
12.5.6. Test blocked egress Copy linkLink copied to clipboard!
This procedure is optional. You can test if your egress IP configuration correctly blocks traffic.
Procedure
Test that the traffic is successfully blocked when the egress rules do not apply by running the following command:
$ oc run \ demo-egress-pod-fail \ -it \ --namespace=demo-egress-pod \ --env=LOAD_BALANCER_HOSTNAME=$LOAD_BALANCER_HOSTNAME \ --image=registry.access.redhat.com/ubi9/ubi -- \ bashSend a request to the load balancer by running the following command:
$ curl -s http://$LOAD_BALANCER_HOSTNAMEIf the command is unsuccessful, egress is successfully blocked.
Exit the pod by running the following command:
$ exit
12.6. Clean up your cluster Copy linkLink copied to clipboard!
Clean up your cluster environment after testing the egress IP configuration.
Procedure
Clean up your cluster by running the following commands:
$ oc delete svc demo-service -n default $ oc delete pod demo-service -n default $ oc delete project demo-egress-ns $ oc delete project demo-egress-pod $ oc delete egressip demo-egress-ns $ oc delete egressip demo-egress-podClean up the assigned node labels by running the following command:
WarningIf you rely on node labels for your machine pool, this command replaces those labels. Input your desired labels into the
--labelsfield to ensure your node labels remain.$ rosa update machinepool ${ROSA_MACHINE_POOL_NAME} \ --cluster="${ROSA_CLUSTER_NAME}" \ --labels ""